tSAPIDocReceiver Properties - 6.1

Talend Components Reference Guide

English (United States)
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

Component family




tSAPIDocReceiver connects to Talend SAP RFC Server, which acts as a bridge between a Job and a SAP server, and outputs IDoc documents.


tSAPIDocReceiver lets you extract data from SAP IDocs stored on an SAP server, and then process this data as part of a Job. It is often used in a Job with the tHMap component to perform complex mapping.

Basic settings


Talend SAP RFC Server host: Enter the IP address of Talend SAP RFC Server, or localhost if it is installed on your local machine.

Port: Enter the port used by Talend SAP RFC Server.

User: Enter a valid username used to connect to Talend SAP RFC Server.

Password: Enter the password that corresponds to the username provided in the previous field.

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.

Use SSL Transport: Select this check box to use the SSL transport mechanism. For more information about SSL transport, see SSL Transport Reference.



The component is linked to tHMap: Select this check box if the Job contains a tHMap component to be used by the tSAPIDocReceiver component to define its structure and then, in the Mapping list drop-down list, select the name of the component in question.

If the tSAPIDocReceiver component does not use a tHMap component to define its structure, specify the IDoc type in the IDoc type field between double quotes instead.

Mode: Select Keep running forever if you want the component to keep listening for new IDocs until you stop the execution of the Job.

Select Batch (consume all IDocs available and terminate) if you want the Job to stop automatically once all the IDocs available are consumed. If you select Batch mode, you can also specify the sleeping time, in seconds, which corresponds to the time the process will wait for the first message to be read.

Maximum duration (seconds): If you select this check box, you can specify the period of time (in seconds) for which the Job should continue to consume any IDocs sent by the RFC Server. Once this time limit is reached, the Job stops consuming and closes the connection to the RFC Server.

Maximum number of IDocs to consume: If you select this check box, you can specify the maximum number of IDocs to be consumed by the Job. Once this limit is reached, the Job stops consuming and closes the connection to the RFC Server.

Advanced settings

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):

Row: Main, Iterate.

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

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

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.


Once executed, this component keeps listening for new IDocs (at least until it reaches the maximum duration or maximum number of IDocs to consume) and sends them downstream to the next component, unless an exception occurs or you stop the execution.


To use this component, you must have already installed and configured Talend SAP RFC Server. For more information on how to do so, see Talend Installation Guide.

You must also add specific jar and dll files validated and provided by SAP to your Studio. The exact procedure varies depending on your platform. For further information about this procedure for adding the required files, see Talend Studio User Guide.