Skip to main content Skip to complementary content

tSAPIDocInput Standard properties

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

The Standard tSAPIDocInput component belongs to the Business family.

The component in this framework is available in all Talend products.

Basic settings

Property type

Either Built-in or Repository:


Built-in: No property data stored centrally.


Repository: Select the Repository file where Properties are stored. The fields that come after are pre-filled in using the fetched data.

Click this icon to open a connection wizard and store the Excel file connection parameters you set in the component Basic settings view.

For more information about setting up and storing file connection parameters, see Talend Studio User Guide.

Connection configuration

Client: Enter your SAP usual connection code

Userid: Enter the user connection Id.

Password: Enter the password.

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

Language: Specify a language.

Host name: Enter the SAP system IP address.

System number: Enter the system number.

Program ID: Enter the program ID of the RFC destination you will connect to. This ID is what you have configured for the corresponding RFC in the SAP system.

Gateway service: Enter the name of your Gateway service. To get the service name, you can edit the service file in the path below on the system where your SAP system is installed.

C:\WINDOWS\system32\drivers\etc\ folder; or execute transaction SMGW to find it in the gateway monitor view.

Output format

Select one or both of the check boxes to decide the format of the documents to be outputted. The format may be XML or HTML.

  • XML: select this check box to output the extracted IDoc data to a local XML file. In the XML-IDoc file output field displayed, specify the path to the XML file.

  • HTML: select this check box to output the extracted IDoc data to a local HTML file. In the HTML-IDoc file output field displayed, specify the path to the HTML file.

Die on error

By default, this check box is cleared. Therefore the rows on error are skipped and the process is completed for the error free rows.

Advanced settings

Activate logs

Select this check box to enable the generation of log files and specify the directory to store these files.

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.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a 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 further information about variables, see Talend Studio User Guide.


Usage rule

Usually used independently or in a subJob. Once executed, it keeps listening to events from SAP and accordingly extracts the IDoc data unless an exception occurs or you stop the execution.


SAP S4/HANA provides limited support for IDoc.


Outgoing links (from this component to another):

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

Incoming links (from one component to this one):

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

For further information regarding connections, see Talend Studio Talend Studio .


Specific jar and dll files provided by SAP must be added to your Studio and the workstation hosting your Studio. The exact procedure varies among platforms such as 32-bit or 64-bit Windows or Linux.
  • For more information, see How to install the SAP Java Connector and the "Centralizing SAP metadata" section in Talend Studio User Guide.

  • You can find an example of how to install SAP Java connectors in Talend Help Center ( and the "Centralizing SAP metadata" section in Talend Studio User Guide.

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 – let us know how we can improve!