tSAPODataInput
tSAPODataInput Standard properties
These properties are used to configure tSAPODataInput running in the Standard Job framework.
The Standard tSAPODataInput component belongs to the Business family.
The component in this framework is available in all subscription-based Talend products.
This component is available only when you have installed the 8.0.1-R2025-06 Talend Studio monthly update or a later one delivered by Talend. For more information, check with your administrator.
Basic settings
| Properties | Description |
|---|---|
| Property type |
Either Built-in or
Repository
.
|
| OData version | Select the version of the OData protocol you want to use. |
| Root URL | Type in the URL address identifying the base URL of the SAP OData service you want to access, that is to say the host and port of the SAP server. |
| Username and Password | Enter the credentials used as basic authentication to access the server.
Information noteTip: To enter a password, a token, or a
client secret key, click the [...] button next to the
corresponding field to bring out the Enter a new
password dialog box, enter the password, the token, or the
secret key in the text field, and click OK. Note that
you can enter either a JSON string in the pure password mode
or a Java expression in the Java mode. You can toggle
between the two modes by clicking switch to Java mode or
switch to pure password mode on the top of the text
field.
|
| Path |
Enter the catalog service path. Example: Root URL = http://<server>:<port> and Path = /sap/opu/odata4/IWFND/config/default/iwfnd/CATALOGSERVICE |
| Guess catalog service path | Click this button to retrieve the default path of the SAP OData catalog service. For more information, see Catalog service. |
| OData V4 parameters (optional) | Specify the extra parameters needed to fine-tune your request to the service:
For more information, see The Groups and related API. |
| OData V2 parameters (optional) | Specify the extra parameters needed to fine-tune your request to the service:
|
| Service URL | Select a service URL from the list. Values are either based on the selected API group (for OData v4) or generated using the filter parameters (for OData v2). |
| Entity set | Enter or select the specific entity set you want to retrieve from the
service. For more information, see Addressing Entities. Information noteTip: To visualize all available entity sets, click the
[...] button next to the corresponding field to bring
out the Retrieve values dialog box, and click
Run in background. A new dialog box opens with all
the retrieved entity sets you can select. Note that you can also provide a
Custom value by selecting the Use custom
value check box.
This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Specify entity key | Select this check box to enter the key used to uniquely identify a specific
entity set. For more information, see Addressing Entities. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $filter | Select this check box to enter a query that will filter the collection of
resources that are addressed by the request URL. For more information, see System Query Option $filter. If both the Use $filter and Use $search options are applied to the same request, the results include only the entities that match both criteria. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $search | Select this check box to enter a query that will be applied to the request
URL and will return all matching entities in the collection. For more information,
see System Query Option $search. If both the Use $filter and Use $search options are applied to the same request, the results include only the entities that match both criteria. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $select | Select this check box to enter a query that will be applied to the request
URL and will return a specific set of properties for each entity or complex type.
For more information, see System Query Option $select. If both the Use $select and Use $expand options are applied to the same request, the results include only the entities that match the $select criteria, so in that case you should include the $expand criteria in the $select query in order to return all expected properties. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $expand | Select this check box to enter a query that will be applied to the request
URL and will return the related expanded resources to be included in line with
retrieved resources. For more information, see System Query Option $expand. If both the Use $select and Use $expand options are applied to the same request, the results include only the entities that match the $select criteria, so in that case you should include the $expand criteria in the $select query in order to return all expected properties. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Return type | Select one of the options depending on how you want to parse the data
returned by the server.
|
| Schema and Edit Schema | A schema is a row description, it defines the number of fields to be
processed and passed on to the next component. The schema is either
Built-in or stored remotely in the
Repository.
Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:
|
| Guess schema | Click this button to retrieve the schema according to your settings. This
button works when Status, headers and body is selected from
the Returned content drop-down list or Output
key/value pairs is selected and key/value pairs are set in the
table under the Output key/value pairs option. When retrieving data from OData, you can specify the format and content of the data retrieved using the schema, the Guess schema button, the Entity set option, the, Specify entity key option, the $filter/search/select/expand option, and the Return type option. |
Advanced settings
| Properties | Description |
|---|---|
| tStatCatcher Statistics | Select this check box to gather the Job processing metadata at a Job level and at each component level. |
| Connection timeout (ms) | Set the timeout period (in milliseconds) for the connector to establish a connection to the server. An error occurs if an attempt to establish a connection fails. |
| Receive timeout (ms) | Set the timeout period (in milliseconds) for receiving response data. An error occurs if no data is received when the read timeout period expires. |
| Use a proxy | Select this option to use an HTTP or a SOCKS proxy.
|
| Use $skip | Select this check box to specify the number of items in the queried
collection that are to be skipped and not included in the result. For more
information, see System Query Option $top and $skip. If both the Use $skip and Use $top options are applied to the same request, the results include only the entities that match both criteria. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $top | Select this check box to specify the number of first items in the queried
collection that are to be included in the result. For more information, see System Query Option $top and $skip. If both the Use $skip and Use $top options are applied to the same request, the results include only the entities that match both criteria. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
| Use $orderBy | Select this check box to enter a query that will be applied to the request
URL and will return the related resources in a particular order. For more
information, see System Query Option $orderby. This option impacts the schema of the output flow of this component. It is recommended to update the schema by clicking the Guess schema button after setting the key/value pairs in the table under this option. |
Global Variables
| Variables | Description |
|---|---|
| Global Variables |
ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box. NB_LINE: the number of rows read by an input component or transferred to an output component. This is an After variable and it returns an integer. |
Usage
| Usage guidance | Description |
|---|---|
| Usage rule |
This component is usually used as a start component of a Job or subJob and it always needs an output link. |
| Limitation |
For OData v4: the current implementation of this component requires the service to support the $count feature. For OData v2:
|