Skip to main content Skip to complementary content

tSAPTableInput Standard properties

These properties are used to configure tSAPTableInput running in the Standard Job framework.

The Standard tSAPTableInput component belongs to the Business family.

The component in this framework is available in all subscription-based Talend products.

Information noteNote: When prompted that this component requires sapjco.jar, download the module and refer to the instructions at SAP Java Connector.

Basic settings

Property Type

Either Built-In or Repository.

  • Built-In: No property data stored centrally.

  • Repository: Select the repository file where the properties are stored.
Use an existing connection

Select this check box and from the list displayed select the relevant connection component to reuse the connection details you have already defined.

When a Job contains a parent Job and a child Job, the list displayed presents only the connection components in the same Job level.
Server Type

Select the type of the SAP server to be connected, either Application Server or Message Server.
Client

The SAP system client ID.

UserId and Password

The user connection ID and password.

To enter the password, click the [...] button next to the password field, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings.
Language

The language of the SAP system.
Host name

The name or IP address of the host on which the SAP server is running.
System number

The SAP system number.

This property is available only when Application Server is selected from the Server Type drop-down list.
System ID

The SAP system ID.

This property is available only when Message Server is selected from the Server Type drop-down list.
Group Name

The SAP group name.

This property is available only when Message Server is selected from the Server Type drop-down list.
Schema and Edit Schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion.

    If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.
Table Type in the name of the table or the SAP CDS view to retrieve data from.

This option is not available when you select the Use existing dynamic schema option.
CDS view Select this option to retrieve data from an SAP CDS view.

You can set parameters for the SAP CDS view in the CDS View parameters table. To set a CDS view parameter, add a row in the table by clicking the plus button on the bottom of the table, type in the parameter name in the Parameter column of the newly added row, and type in the parameter value in the Value column of the newly added row.

This option is unavailable if Use existing dynamic schema in the Basic settings view or Use RFC server in the Advanced settings view is selected.

Information noteNote:
  • If you retrieve data from an SAP CDS view with Use FTP-Batch Options selected in the Basic settings view, note that the SAP API only provides security extraction and cannot specify the path for FTP. The parameters related to the FTP path will be hidden. Other parameters will be the same as those of table extraction.
  • Because the SAP API only supports retrieving data from one CDS view at a time, this feature does not support data extraction from multiple CDS views joined together.
  • This option is available only when you have installed the 8.0.1-R2023-06 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
RFC server url

Enter your RFC server details in the field provided.

Talend Studio uses the RFC server as the streaming proxy to support high volume of data extraction without the need to store information on a third-party transfer protocol such as FTP or SFTP.

This field becomes visible when you select Use the RFC server in the Advanced settings view.
Package size

Specify the number of records for each package. By default, the value displays 10000.

In case you have a value higher than 10000, for example, 12000, Talend Studio creates two packages: one contains 10000 records and the other contains 2000 records.

This field becomes visible when you select Use the RFC server in the Advanced settings view.
Connection id Enter the ID of the connection established by the Talend SAP RFC Server, that is, the name of the SAP connection configuration file (the extension not included).

An SAP RFC server can establish multiple SAP connections based on the SAP connection configuration files. By default, the SAP connection configuration files are stored in $TSAPS_HOME/conf/named-connectiond, where $TSAPS_HOME is the directory where the Talend SAP RFC Server has been installed. If you cannot find the desired SAP connection configuration file in the default directory, check the directory specified by the named.connections parameter in the tsap-rfc-server.properties file.

This field is available when Use the RFC server is checked in Advanced settings view.
Number of threads to extract the data from SAP Set the number of threads for data extraction. The default is 2.

This option is available when you select the Use the RFC server option in the Advanced settings view.
Kafka topic partition count Set the Kafka topic partition count. The default is 2.

This option is available when you select the Use the RFC server option in the Advanced settings view.
Max time to wait for more data Set the maximum time period (in seconds) for the client to wait for more data of a Kafka topic when an error occurs. If no data is received when the period expires, the stream will be canceled. The default is 60.

This option is available when you select the Use the RFC server option in the Advanced settings view.
From statement Enter a SQL statement for querying data, usually a SQL FROM clause or the name of a single table.
Information noteNote:
  • This option is available when you select the Use existing dynamic schema option.
  • This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Use existing dynamic schema Select this option to use the dynamic schema generated by a tSetDynamicSchema component. You can select the dynamic schema by selecting the tSetDynamicSchema component from the Dynamic schema drop-down list.
Information noteNote:
  • This option is available when you select the Use FTP-Batch Options option in the Basic settings view or select Use the RFC server option in the Advanced settings view.
  • If the schema comes with the ExtendedConfiguration column, the values of this column need to be in the format of {"TableName":"{your_table_name}"}. See tSetDynamicSchema Standard properties for related information.
  • This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
  • This option is available to the Use the RFC server option in the Advanced settings view only when you have installed the 8.0.1-R2022-05 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Filter Enter the filter condition between double quotes. The component will read data based on this condition.

Note that the column value must be surrounded by single quotes and there must be a blank space before and after the equals sign (=) in the filter expression. For example, "MANDT = '800' AND WAERK = 'EUR' OR (FKART = 'F2' AND VBELN = '0090038989')".
Start row number Specify the sequence number of the row from which data retrieval starts. The sequence number of the row in an SAP table starts from 0.

The default value for this field is -1, which means to read all rows in the specified table.
Max row number Specify the maximum number of rows to retrieve data from.

The default value for this field is -1, which means to retrieve all rows that meet the filter condition.
Specify a shared destination

Select this check box and specify the shared destination in the Shared destination name field displayed. The shared destination allows the SAP components to use the shared destination on the Talend Runtime when they are executed as part of an ESB Route or ESB Data Service within the Talend Runtime container OSGi Environment.

Besides specifying the shared destination name in the component, you also need to setup the SAP DataSource for the Talend Runtime. What you need to do to define the SAP DataSource and how to configure it are described in the readme.txt provided in the Talend ESB package within the /add-ons/datasource/sap folder.

Note that if you use the component's own connection configuration, your SAP connection will be closed at the end of the component. To prevent this from happening, use a shared destination with its name specified.
Use FTP-Batch Options Select this check box when the size of data to be retrieved is larger than the size specified in the Fetch size field. With this check box selected, the SAP system will generate as many files as needed and write the retrieved data into these files, and this component will then read the files using an FTP connection to retrieve data and transfer the retrieved data to the output component.

The following properties need to be specified when this checkbox is selected:

  • File Protocol: Select FTP or the secure alternative SFTP.

  • Host: The IP address or host name of the FTP server.

  • Port: The listening port number of the FTP server.

  • User and Password: The user authentication data required to access the FTP server.

  • Use the SAP Application Server logical path: The logical path configured in the SAP Application Server which specifies in which directory the flat files must be created.

    This option is available only when you have installed the 8.0.1-R2023-02 Talend Studio Monthly update or a later one delivered by Talend.

  • Directory: The directory where the files generated by the SAP system will be saved.

    This option is not available if you select the Use the SAP Application Server logical path check box.

  • Data filename prefix: The prefix of the files generated by the SAP system.

This option is available only when the Use the RFC server option is not selected in the Advanced settings view.

Information noteNote: This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Advanced settings

Timeout for the generation of the start indicator file (ms) Specify the time, in milliseconds, to wait for the generation of the start file for SAP batch extraction. This generated file indicates that the data has been successfully extracted to the FTP directory. The default value is 8000 milliseconds.
Timeout for the data file polling (ms) Specify the time, in milliseconds, to wait for the polling of the data files from the FTP server.

If you leave this field empty, or set it to 0, there will be no timeout during file polling.
Abort background Job and remove generated files on error When you select this option, in case the component catches an exception, running background Jobs for the FTP batch extraction will be aborted and the useless files generated on the FTP side will be cleaned.
Use the RFC server (Technical Preview) Select this check box if you want to directly extract high volumes of data from an SAP application. When you select this option, the Connection configuration section displays the fields for the RFC server url and Package size. For more information, see the corresponding description of those fields in the Basic settings view.
Read NUMC data as String in the dynamic column

Select this option to treat data that is of NUMC type in the dynamic column as strings.

If this option is not checked, data that is of NUMC type in the dynamic column is treated as integers.
Read DATE data as String in the dynamic column Select this option to treat data that is of DATE type in the dynamic column as strings.

If this option is not checked, data that is of DATE type in the dynamic column is treated as dates.
Trim spaces Select this option to trim spaces in data retrieved from SAP servers. You can clear this option in cases where spaces in data are for specific purposes and need to be kept unchanged.

This option applies to data that is of STRING type or RAW type only. For data of other types, spaces are trimmed before type conversion.

Information noteNote: This option is available only when you have installed the 8.0.1-R2023-07 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Kafka Properties When you select the Use the RFC server option, the window displays the Kafka Properties table. Kafka, or Apache Kafka, is an open source distributed streaming platform. For more information about Kafka, refer to https://kafka.apache.org/.

Enter your Kafka information in the fields provided.
Set max length for variable length type when api.use_z_talend_read_table parameter is true When the length of any string and string type field is set to 0 in SAP data dictionary, you need to select this check box and in the Max length field displayed specify the maximum length of the data to be retrieved for the string and string type fields. Note that:

  • This check box works only when the value of the SAP connection property api.use_z_talend_read_table is set to true.

  • This maximum length will be applied to all fields of string and string type. To avoid loss of data, you need to be very careful when determining its value.
SAP Properties
If you need to use custom configuration for the SAP system being used, complete this table with the property or properties to be customized. For example,

  • to establish a Unicode connection between the SAP system and Talend Studio, you need to add the property jco.server.unicode and set its value to 1. Note that this property works if you are using SAP Java Connector 2.x and is unnecessary for SAP Java Connector 3.0 and higher versions.

  • to set up an SAP connection with Secure Network Communications (SNC), you need to add and set the following properties in this field.

    • jco.client.snc_mode
    • jco.client.snc_myname
    • jco.client.snc_lib=.../sapcrypto/sapcrypto.dll
    • jco.client.snc_partnername
    • jco.client.snc_qop
    Information noteNote: The values of the above properties vary with the system environment. Contact your SAP system administrator if you are not sure how to set the properties.

    For more information about setting the SNC parameters, see Configuring SNC: External Programs to AS ABAP Using RFC and Communication Paths that Support SNC.

This property is not visible when the Use an existing connection check box is selected.
Fetch size Enter the maximum size of the resultset (in number of rows) that can be returned from the SAP BW database in response to a BAPI call or a request.

A value of -1, the default, uses the default fetch size, which is determined by the Java code or the BAPI on SAP side.

It is recommended to set this field according to the memory space allocated to your Job and the number of fields requested. With a given memory space, the more fields requested, the smaller the fetch size.

Information noteNote: This field is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
SAP function extraction path Select this option to specify a directory for the SAP function to generate files that hold the data extracted. You can enter the path to the directory in the text field to the right.

If this option is not selected, the files will be generated in the directory specified in the FTP directory field in the Basic settings view.

This option is not available if you select the Use the SAP Application Server logical path check box from the Basic settings view.

Because Talend Studio does not synchronize the directories specified by SAP function extraction path and FTP directory fields, make sure these two fields point to the same resource.

Information noteNote: This option is available only if you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Use space to replace the control characters in data Select this option to replace special characters in data with spaces. Some characters in data (for example, \n) may affect data parsing because they are treated as control characters. This option prevents this by replacing the special characters with spaces.

This option is unavailable if Use existing dynamic schema in the Basic settings view or Use RFC server in the Advanced settings view is selected.

This option is available only when you have installed the 8.0.1-R2023-06 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Fetch all records at once Select this check box to fetch all the records at once based on the maximum row numbers you have set. If you clear this check box, the records are fetched based on the system-defined fetch size.

This option is available only with standard extraction when you select CDS View. This option is not available when you select Use FTP-Batch Options or Use the RFC server.

This option is available only when you have installed the 8.0.1-R2024-03 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

Global Variables

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.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl+Space to access the variable list and choose the variable to use from it.

For more information about variables, see Using contexts and variables.

Usage

Usage rule This component is usually used as a start component in a Job and it always needs an output link.
Support

tSAPTableInput should be used to interact with the ERP part of SAP, including S4/HANA.
Connections Outgoing links (from this component to another):

Row: Main, Iterate

Trigger: On Subjob Ok, On Subjob Error, Run if, On Component Ok, On Component Error

Incoming links (from one component to this one):

Trigger: On Subjob Ok, On Subjob Error, Run if, On Component Ok, On Component Error

For further information about connections, see Using connections in a Job.
Limitation/ Prerequisites
Specific JAR and DLL files provided by SAP must be added to Talend Studio and the workstation hosting Talend Studio. The exact procedure varies among platforms such as 32-bit or 64-bit Windows or Linux.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here