SAP Receive IDOC activity

Use the SAP Receive IDOC activity to act as a server and listenson the configured SAP endpoint, during run time. The activity receives an IDOC from the specified SAP endpoint and converts it to XML data. The SAP Receive IDOC activity is a starter activity.

If you receive your SAP data directly from the SAP system using an RFC port, you must use the SAP Receive IDOC activity. If you receive your SAP data as a file through a SAP File Port to the SAP system, you must use the Project > Import > SAP IDOC Schema toolbar menu option during design time to generate a Flat File Schema for your IDOC metadata and use the Read Flat File activity to read the SAP data. For more information, see Generating a Flat File Schema from an IDOC.

For the SAP Receive IDOC activity only, you must specify an inbound gateway connection parameters. For more information, see Creating or editing a SAP endpoint.

In order to connect to the SAP System from Studio, you must download and install the SAP Jar files and DLLs on your Window's development machine. For more information, see Downloading and installing the SAP Jar Files and DLLs.

Note: An orchestration that contains an SAP Receive IDOC activity must have persistence enabled. For more information, see Enabling persistence.

Adding a SAP Receive IDOC activity in the orchestration

  1. Create or open an orchestration. A graphical representation of the orchestration is displayed.
  2. Select the Activities tab and expand the SAP folder.
  3. Drag the Receive IDOC activity onto the orchestration.
  4. Select the activity. The Checklist is displayed.

Creating, selecting, or editing a SAP endpoint

  1. Click Pick Endpoint task from the Checklist and select one of the following actions:
    • Select an existing endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK. Go to the Configuring the activity procedure.
    • Select an existing endpoint and edit the endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK.
      3. Click Edit. The Edit Endpoint panel is displayed.
    • Create a new endpoint: Select New. The Create Endpoint panel is displayed.
  2. Create or Edit a SAP endpoint.

Configuring the activity

  1. Select the Configure task from the Checklist. The Configure panel is displayed.
  2. Click Browse....
  3. Select an IDOC row and click OK. The Message Type, IDOC Type, and IDOC Extended Type in the Configure task are populated.
  4. If the data coming from the SAP system has invalid XML characters and you want the data to be processed successfully, then select the check box Remove invalid XML characters coming from SAP in the Configure panel. This option will remove invalid XML characters and process the data.

Mapping the outputs of the activity

  1. Select the Map Outputs task in the Checklist.

    The output parameter of the activity is displayed in the From Activity panel. The XML Schema generated from the selected IDOC Type and IDOC Extended Type becomes the output parameter of the activity.

  2. Create a map between the IDOC XML Schema and orchestration variables. See Creating a map for general instructions on mapping.

Note about Deploying a SAP Orchestration

Before you can deploy an orchestration with SAP activities using the Web Management Console, the Integration Appliance must first be able to establish a connection to the SAP System. If the Integration Appliance is unable to establish the connection to the SAP System, the orchestration is not deployed.




Feedback | Notices


Timestamp icon Last updated: Thursday, 27 September 2018


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/SAP_Receive_IDOC_Activity.html