IDoc Reader

The IDoc Reader activity retrieves the XML message persisted on a messaging source, then converts the message into an IDoc and posts the IDoc to the SAP system.

Only IDocs of SAP port type 4x are supported using tRFC and qRFC protocols.

General

In the General tab, you can establish connections to the SAP system and the messaging source separately, and download the schema of the IDoc to be posted to the SAP system.

The following table lists the fields in the General tab:

Field	Module Property?	Description
Name	No	The name to be displayed as the label for the activity in the process.
SAP Connection	Yes	Click to select an SAP Connection shared resource. The SAP Connection shared resource establishes connections between the plug-in and the SAP system. If no matching SAP Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating and Configuring an SAP Connection.
IDoc Name	No	Click Fetch IDoc to download the schema of the IDoc to be posted. In the Search IDoc dialog, complete the following tasks: Specify the IDoc filter to filter out the required IDoc types with the IDoc type name. The IDoc filter supports wildcard search. Select an IDoc type. Basic Type: select Basic Type if you want to download the IDoc schema of the basic type. Only the basic IDoc types matching the IDoc filter can be filtered out. Extended Type: select Extended Type if you want to download the IDoc schema of the extended type. The extended IDoc type name includes the name of the basic IDoc type that it is extended from. Therefore, the extended IDoc types can be filtered out by using the corresponding basic IDoc type name. Click Fetch IDocs. Select the IDoc type that you want to download and click OK. Ensure that the selected IDoc type and the associated segments have been released in the SAP system. When the IDoc schema is downloaded, an XSD file is created. The XSD file cannot be visible in the project but it can be picked from the activity if required. Note: When an IDoc schema is downloaded to the plug-in, if new segment definitions are added to the IDoc schema because of the upgrade of the SAP system, you have to refresh the IDoc schema in the plug-in.
Messaging Source	No	The messaging source where the activity retrieves messages. Only the JMS type is supported.
JMS Connection	Yes	Click to select a JMS Connection shared resource. The JMS Connection shared resource establishes a connection between the plug-in and the EMS server where the activity persists the IDoc to be posted. If no matching JMS Connection shared resources are found, click Create Shared Resource to create one. For more details, see the TIBCO ActiveMatrix BusinessWorks documentation. Note: When the fault-tolerant operation is not configured on the EMS server and the server goes down, if the server is restarted, the IDoc Reader activity might retrieve a duplicate IDoc message.
Max Session	Yes	The number of IDoc messages to be processed concurrently. The default value is 1. If you set the value of this field to negative or zero, the value of 1 is used automatically at run time. See Job Tuning for details.

Description

In the Description tab, you can enter a short description for the IDoc Reader activity.

Advanced

In the Advanced tab, you can specify the destination used to retrieve IDocs to be posted, and the protocol used to post IDocs.

The following table lists the fields in the Advanced tab:

Field	Module Property?	Description
Sequence Key	No	This field contains an XPath expression that specifies the order in which the process runs. Process instances with sequencing keys that have the same value are executed sequentially in the order in which the process instances were created.
Custom Job Id	No	This field contains an XPath expression that specifies a custom job ID for the process instance. This ID is displayed in the TIBCO Administrator View Service dialog, and it is also available in the $_processContext process variable. The custom job ID for the process instance.
Post IDoc Destination	Yes	The destination used to retrieve the IDoc to be posted.
IDoc Error Destination	Yes	The destination used to forward the IDoc when an exception occurs in the SAP system.
IDoc Input Mode	Yes	The protocol used to post IDocs. The plug-in supports the following two protocols: tRFC: select tRFC if the message delivery in sequence is not required. qRFC: select qRFC if the message delivery in sequence is required. The default protocol is tRFC.
SAP Queue Name	Yes	The name of the queue to be used when posting IDocs by the qRFC protocol. Note: This field is displayed only when you select qRFC from the IDoc Input Mode list.

Output

In the Output tab, you can find the information of the posted IDoc.

The following table lists the output elements in the Output tab:

Output Element	Data Type	Description
MessageID	String	The message ID of the posted IDoc.
TID	String	The TID of the transaction that the SAP system uses to receive the posted IDoc.