tSAPIDocInput - 6.1

Talend Components Reference Guide

Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
Talend Studio
Data Governance
Data Quality and Preparation
Design and Development

tSAPIDocInput Properties

Component family


Note that this component is deprecated.


tSAPIDocInput connects to an RFC destination in the SAP system through authentication of the SAP gateway server and outputs IDoc files (Intermediate Documents in XML or HTML format) to the user-defined location.


tSAPIDocInput allows you to extract IDoc data set that is used for asynchronous transactions between SAP systems or between a SAP system and another application.

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.


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,


tStatCatcher Statistics

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


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.

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.


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.


You must add specific jar and dll files validated and provided by SAP to your Studio and the workstation hosting your Studio. This procedure varies among platforms such as 32-bit or 64-bit Windows or Linux.

For further information about this procedure for adding the required files, see Talend Studio User Guide.


Scenario: Connecting to a given SAP R/3 system for listening the creation of IDoc files

In this scenario, an one-single-component Job uses the tSAPIDocInput component to keep listening to the creation of IDoc files in a given SAP R/3 system.

To replicate this scenario, you need to:

  1. Create an RFC Destination on the given SAP R/3 system.

  2. Configure tSAPIDocInput to listen to the invocation from this SAP R/3 system.

Creating an RFC Destination for the listener component tSAPIDocInput

Logon to a given SAP R/3 system and then proceed as follows to create the required RFC Destination:

  1. Execute the transaction SM59 to open the Display and maintain RFC destinations view.

  2. In this view, select the TCP/IP connections option and click Create.

    Then the RFC Destination view displays.

  3. In RFC destination field of this view, type in the name of this RFC Destination to be used. As this field is case-sensitive, it is recommended to use upper case characters. In this example, we name it as IDOC_TALEND.

  4. In the Connection type field, select the T type meaning to start an external program via TCP/IP.

  5. In the Description field, type in a short text to describe this RFC Destination being created. In this example, we enter simply TALEND IDOC LISTENER.

  6. In the Logon area, select the Current user check box and then click the Save button on the top toolbar.

    Then the RFC Destination IDOC_TALEND view is opened.

  7. In this view, click Registration to display the Program ID field and type in the program ID. This program ID must use the same name as this created RFC Destination, that is, IDOC_TALEND. Then again, click the save button on the top toolbar to validate this configuration.

  8. Still on the top toolbar, click the back button several times to go back to the SAP Easy Access view (SAP main screen) and execute the transaction SMGW to open the gateway monitor view.

  9. From the menu bar of the gateway monitor view, select Goto > Parameters > Display. Then an table like the following one displays, where you can find the gateway service of this given SAP R/3 system.

In this example, the gateway service to be used is sapgw00.

Now, the required RFC Destination has been created.

Configuring the listener component tSAPIDocInput

In the Integration perspective of your Studio, proceed as follows:.

  1. Drop the tSAPIDocInput component from the Palette onto the design workspace.

  2. Double-click this component to open its Component view.

  3. In the Client field, type in the client number of this given SAP R/3 system. In this scenario, it is 000..

  4. In the Userid and Password fields, type in the authentication information in the corresponding field.

  5. In the Language field, type in the language used by this given SAP R/3 system. In this example, it is EN.

  6. In the Host name field, type in the IP address of the hosting server of this given SAP R/3 system.

  7. In the System number field, type in the system number of this given SAP R/3 system.

  8. In the Gateway service field, type in the used gateway service name.

  9. In the Program ID field, type in the program ID you have defined when creating the required RFC Destination. In this example, it is IDOC_TALEND.

  10. In the XML-IDoc file output field, enter the path or browse to the location where you need to store the received SAP IDoc file.

Job execution

  1. Press CTRL+S to save your Job and press F6 to run it.

    From this console, you can read that the tSAPIDocInput component is listening to this given SAP R/3 system.

  2. Back to the created RFC Destination in this SAP R/3 system, click Test connection.

The test result indicates that the connection between this given SAP R/3 system and the listener component tSAPIDocInput component succeeds.

Now the tSAPIDocInput component is listening to your SAP R/3 system and wait for the invocation of the previously defined RFC Destination.