July 30, 2023

tSAPIDocInput (deprecated) – Docs for ESB 7.x

tSAPIDocInput (deprecated)

Extracts IDoc data set that is used for asynchronous transactions between SAP
systems or between a SAP system and another application.

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 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 subscription-based Talend products.

Basic settings

Property type

Either Built-in or


Built-in: No property data stored


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

tSAPIDocInput (deprecated)_1.png

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

Userid: Enter the user connection

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

System number: Enter the system

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:WINDOWSsystem32driversetc 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
    field displayed, specify the path to the XML

  • 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

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.

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 +
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.

  • You can find an example of how to install SAP Java connectors in
    Talend Help Center (https://help.talend.com) and the “Centralizing SAP
    metadata” section in Talend Studio User Guide.

Connecting to a given SAP R/3 system for listening the creation of
IDoc files (deprecated)

This scenario applies only to subscription-based Talend products.

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

    tSAPIDocInput (deprecated)_2.png

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

    tSAPIDocInput (deprecated)_3.png

    Then the RFC Destination view
    tSAPIDocInput (deprecated)_4.png

  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.

    tSAPIDocInput (deprecated)_5.png

    Then the RFC Destination IDOC_TALEND view is
    tSAPIDocInput (deprecated)_6.png

  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.

    tSAPIDocInput (deprecated)_7.png

  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.

    tSAPIDocInput (deprecated)_8.png

In this example, the gateway service to be used is

Now, the required RFC Destination has been created.

Configuring the listener component tSAPIDocInput

In the
perspective of your Studio, proceed as

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

    tSAPIDocInput (deprecated)_9.png

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

    tSAPIDocInput (deprecated)_10.png

  3. In the Client field, type in the client
    number of this given SAP R/3 system. In this scenario, it is
  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
  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.

    tSAPIDocInput (deprecated)_11.png

    From this console, you can read that the tSAPIDocInput component is listening to this given SAP R/3
  2. Back to the created RFC Destination in this SAP R/3 system, click
    Test connection.

    tSAPIDocInput (deprecated)_12.png

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

tSAPIDocInput (deprecated)_13.png

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

Document get from Talend https://help.talend.com
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x