tSAPIDocInput Properties - 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
Data Governance
Data Quality and Preparation
Design and Development
Talend Studio

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.