IDoc Listener
Use the IDoc Listener activity to receive IDocs published from the SAP system.
The IDocs are persisted to the TIBCO transport, for example, EMS, and confirmed in the SAP system. The IDoc Listener activity serializes the IDoc data to the transport by using the raw IDoc format.
IDocs of SAP port type 4x are only supported using the tRFC, qRFC, and bgRFC (Type T only) protocols.
- The IDoc Listener activity is configured to use either the TIBCO Enterprise Messaging Service or Apache Kafka. This activity can also be configured without using messaging service. For more information on using the IDoc Listener activity without messaging service, see IDoc Processing Without Messaging
- In a project, the IDoc Listener activities cannot use the same SAP connection or the SAP connections with the same combination of the gateway host, the gateway service, and the program ID.
- You need to delete the JMS Connection property from the process properties file if you are switching from JMS Message Resource to NoMessaging or Kafka.
If you want to control the number of messages being processed concurrently by the activity, choose one of the following configurations:
See Job Tuning for details.
General Tab
On the General tab, establish connections to the SAP system and the messaging source separately, and choose an SAP TIDManager shared resource to manage the check of the duplicate IDoc messages.
The following table lists the configurations on the General tab of the IDoc Listener activity:
Field | Module Property? | Description |
---|---|---|
Name | No | Specify 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 at run time.
Ensure that you have created an SAP Connection shared resource accordingly first. For more details, see Creating and Configuring an SAP Connection. Note:
|
SAP TID Manager | Yes | Click
to select an SAP TIDManager shared resource. The SAP TIDManager shared resource can manage the check of duplicate IDoc messages for the activity.
If no matching SAP TIDManager shared resources are found, click Create Shared Resource to create one. For more details, see Creating and Configuring an SAP TIDManager Shared Resource. |
Messaging Source | No |
Select the messaging source where the received IDocs are persisted from the list.
If the transport type is JMS, the control fields are passed as JMS properties. The property name consists of the SAPIDOC_ prefix and the IDoc control record field. For example, if the control field is DOCNUM, the corresponding JMS property is SAPIDOC_DOCNUM. If the transport type is Kafka, the control fields are passed as Kafka header parameters. For the IDoc Listener activity, except for the preceding JMS properties, you can also use the SAPJCO_ JMS properties to route IDoc messages to a specific receiver. If the messaging source is selected as NoMessaging then the IDoc received from the SAP system is outputted as a raw IDoc. If the raw IDoc needs to be converted into XML format then process the output from the IDoc Listener activity using the IDoc Converter activity. For more information, see IDoc Processing Without Messaging. |
JMS Connection | Yes | This field is available only when JMS is selected in the
Messaging Source field.
Click to select a JMS Connection shared resource. The JMS Connection shared resource establishes connections between the plug-in and the EMS server where the activity saves the IDocs received from the SAP system. 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. |
Producer Properties | Yes | You can provide the Kafka Producer properties for this field. This field is available only when Kafka is selected in the Messaging Source field. Multiple properties can be provided in key:value format and the properties can be separated using the comma separator (,) |
Description Tab
On the Description tab, you can enter a short description for the IDoc Listener activity.
Advanced Tab
On the Advanced tab, specify the destination used to persist the IDoc received from the SAP system.
The following table lists the configurations on the Advanced tab of the IDoc Listener activity:
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 $_processContext process variable. The custom job ID for the process instance. |
IDoc Destination | Yes | This field is available only when JMS is selected in the Messaging Source field on the General Tab. |
IDoc Expiration (ms) | Yes | This field is available only when JMS is selected in the Messaging Source field on the General Tab. |
Output Tab
On the Output tab, find the information of the received IDocs.
The following table lists the output elements on the Output tab of the IDoc Listener activity:
Output Item | Data Type | Description |
---|---|---|
IDocNumber | String | Displays the number of the received IDoc. |
TID | String | Displays the TID of the transaction used to publish the IDoc from the SAP system. |
MessageID | String | This output is available only when JMS is selected in the
Messaging Source field on the
General Tab.
Displays the message ID of the received IDoc. |
TopicName | String | This output is available only when Kafka is selected in the
Messaging Source field on the
General Tab.
Displays the topic name where the IDoc is published. |
PartitionID | Integer | This output is available only when Kafka is selected in the
Messaging Source field on the
General Tab.
The sequence ID of the partition to which a IDoc is sent within a topic. |
Offset | Integer | This output is available only when Kafka is selected in the
Messaging Source field on the
General Tab.
The sequence ID number assigned to each IDoc within a partition. |
SAPIDoc | Element | This output is only available when No Messaging is selected in the
Messaging Source field on the
General Tab.
Displays the IDoc Control record in XML format. |
IDoc | Element | This output is only available when No Messaging is selected in the
Messaging Source field on the
General Tab.
Displays the raw IDoc in text format where the IDoc Control record and all the IDoc Data records are displayed separately. |