tSAPIDocReceiver
Extracts data from SAP IDocs stored on an SAP server.
tSAPIDocReceiver connects to Talend SAP RFC Server, which acts as a bridge between a Job and a
SAP server, and outputs IDoc documents.
tSAPIDocReceiver is often used in a Job with the tHMap component to perform complex mapping.
tSAPIDocReceiver Standard properties
These properties are used to configure tSAPIDocReceiver running in the Standard Job framework.
The Standard
tSAPIDocReceiver component belongs to the Business family.
This component is available in Talend Data Management Platform, Talend Big Data Platform, Talend Real Time Big Data Platform, Talend Data Services Platform, Talend MDM Platform and Talend Data Fabric.
Basic settings
Connection |
Talend SAP RFC Server host: Enter the
Port: Enter the port used by
User: Enter a valid username used to
Password: Enter the password that To enter the password, click the […] button next to the
Use SSL Transport: Select this check |
Mode |
The component is linked to tHMap: If the tSAPIDocReceiver component
Mode: Select Keep running forever if you want the component to keep Select Batch (consume all IDocs available and
Maximum duration (seconds): If you
Maximum number of IDocs to consume: |
Advanced settings
tStatCatcher Statistics |
Select this check box to gather the Job processing metadata at a Job |
Global Variables
Global Variables |
ERROR_MESSAGE: the error message generated by the A Flow variable functions during the execution of a component while an After variable To fill up a field or expression with a variable, press Ctrl + For further information about variables, see |
Usage
Usage rule |
Once executed, this component keeps listening for new IDocs (at least |
Connections |
Outgoing links (from this component to another): Row: Main, Iterate.
Trigger: On Subjob Ok, On Subjob For further information regarding connections, see |
Limitation |
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.
To use this component, you must have already installed and configured |
Consuming IDocs for processing by tHMap
This scenario applies only to subscription-based Talend products.
The following scenario creates a three-component Job that
connects to a Talend SAP RFC server, in order to consume IDocs for processing by tHMap.
Note that the tHMap component is only available in the Palette of
Talend Studio
if you have subscribed to one of the Talend Platform products.
Also note that the tSAPIDocReceiver
component can be linked directly to a tHMap
component via a Row > Main connection. However, this does not work when your Job is deployed on a Job
Server. In this case, you need to link the tSAPIDocReceiver component first to a tFlowToIterate component via a Row > Main connection, then the tFlowToIterate
component to a tFixedFlowInput component via a
Row > Iterate connection, finally the tFixedFlowInput component to the tHMap component via a Row > Main connection, and the Job will look like below.

-
The SAP server needs to be configured to operate
with Talend SAP RFC Server.You can find more information about how to configure SAP to
operate with the Talend SAP RFC Server in
Talend Help Center. -
Talend SAP RFC Server needs to be installed,
configured and running to receive IDocs from the SAP server. For more information,
see the section Installing and configuring
Talend SAP RFC Server in Talend Installation and
Upgrade Guide.
Creating an SAP connection and importing the IDoc structures
-
In the Integration perspective, in the Repository view, expand Metadata, right-click SAP
Connections and then, in the contextual menu, click Create SAP connection. The SAP
Connection wizard opens. -
Enter a name for your connection in the Name
field, for instance SAPServerConnection, and then
click Next. -
In the next screen of the wizard, enter the appropriate connection parameters to
connect to your SAP server, and then click Finish
to create the connection.If you do not have this information, contact the administrator of your SAP server
for help. -
In the Repository view, under Metadata, expand SAP
Connections, right-click the connection you just created and then, in
the contextual menu, select Import Data Mapper IDoc
Structures. -
In the Search SAP for IDoc types wizard that
opens, enter some search criteria to reduce the number of results returned or leave
all fields blank to return all available IDocs, and then click Search. - Select the structure or structures you want to import, and then click Next.
-
Enter IDocs in the Structure name field to import the structure into a folder called
IDocs, and then click Next and then Finish to complete
the import process.
Adding and linking the components
-
In the
Integration
perspective, create
a new Job and call it idoc_job. -
Click the point in the design workspace where you want to add the first component,
start typing tSAPIDocReceiver, and then click the
name of the component when it appears in the list proposed in order to select
it. -
Do the same to add a tHMap component and a
tLogRow component as well. -
Connect the tSAPIDocReceiver component to the
tHMap component using a Row > Main link, then connect the tHMap component to the tLogRow
component using a Row > Main link.
Defining the properties of tSAPIDocReceiver
-
Select the tSAPIDocReceiver component to define
its properties. -
If Talend SAP RFC Server is installed on your
local machine, leave all the default settings unchanged.Otherwise, enter the IP address of Talend SAP RFC
Server in the Talend RFC Server host
field and update the Port, User and Password fields if
necessary. Leave all the other settings unchanged.
Defining the properties of tHMap
-
Select the tHMap component to define its
properties. -
Click the Sync columns button to synchronise the
schema between the different components of your Job. - Click the […] button next to the Open Map Editor field to create a new map.
-
In the tHMap Structure Generate/Select dialog
box that opens, select Select an existing hierarchical mapper
structure for the input structure, and then click Next. - Select the IDoc structure that you imported earlier, and then click Next and then Finish.
-
Do the same for the output structure, again selecting the IDoc structure that you
imported earlier, and then click Next and then
Finish. -
In the Mapping perspective that opens, in the
Data Mapper view, expand Hierarchical Mapper, Maps,
Jobs and then idoc_job, and then right-click the tHMap_1 map and select Properties
in the contextual menu. -
Click the […] button next to the Output Representation field, select XML in the dialog box that opens, click OK, and then click OK again to
close the Properties dialog box. -
In the map, drag the root element from the Input
(Flat) side to its corresponding root element on the Output (XML) side to create a simple map in which the
input file will be transformed into an XML file on output. -
Press Ctrl+S to save your changes to the
map. -
Switch back to the
Integration
perspective to
complete the settings for the tHMap component in
your Job. -
Set Read Input As to Single
column. - Set Write Output As to String (single column).
Saving and executing the Job
- Press Ctrl+S to save your Job.
-
In the Run tab, click Run to execute the Job.
In the Console, the Job will display an XML version of your IDoc documents when it
runs successfully.