Skip to end of metadata
Go to start of metadata


Introduction

An SAP IDoc (Intermediate Document) activity is configured to use a specific IDoc. It can be used by an operation to send inbound IDocs (inbound to SAP, outbound from Jitterbit) to an SAP system. You can configure as many SAP IDoc activities as you like for each SAP connection.

NOTE: Outbound IDocs (outbound from SAP, inbound to Jitterbit) are not supported with the Cloud Studio SAP Connector. Outbound IDoc activities require the Jitterbit SAP Event Listener, currently available only for Jitterbit Harmony Design Studio. See Design Studio SAP Connector, SAP Configuration for Communication with Jitterbit, and SAP Event Listener Configuration.

Creating an IDoc SAP Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the SAP connection block to display activities that are available to be used with an SAP connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After an SAP IDoc activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring an SAP IDoc Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring an SAP IDoc Activity

Follow these steps to configure an SAP IDoc activity:

  • Step 1 – Enter Basic Information and Select an IDoc Message Type
  • Step 2 – Select an IDoc Type
  • Step 3 – Review Data Schema

Step 1 – Enter Basic Information and Select an IDoc Message Type

Connectivity tab

  • Name: Enter a name to use to identify the SAP IDoc activity. The name must be unique for each IDoc activity and must not contain forward slashes (/) or colons (:).

  • Select an IDoc Message Type Name: This section displays the IDoc message types available in the SAP endpoint. When reopening an existing activity configuration, only the selected IDoc message type is displayed instead of reloading the entire message type list.

    • Selected IDoc Message Type: After a message type is selected, it will be listed here.
    • Search: Enter any part of the message type into the search box to filter the list of message types. The search is not case-sensitive. If message types are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload message types from the endpoint when searching, enter search criteria and then refresh.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload message types from the SAP endpoint. This may be useful if you have recently added message types to the SAP instance. This action refreshes all metadata used to build the table of message types displayed in the configuration.
    • Select an IDoc Message Type: Within the table, click anywhere on a row to select a message type. Only one message type can be selected. The information available for each message type is fetched from the SAP endpoint:
      • Name: The IDoc message type name in SAP.
      • Description: The IDoc message type description in SAP.

    TIP: If the table does not populate with available message types, the SAP connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2 – Select an IDoc Type

Connectivity tab

  • Select an IDoc Type: This section displays IDoc types available for the selected IDoc message type in the SAP endpoint. When reopening an existing activity configuration, only the selected IDoc type is displayed instead of reloading the entire type list.

    • Selected IDoc Message Type: The IDoc message type selected in the previous step will be listed first.
    • Selected IDoc Type: After an IDoc type is selected, it will be listed here.
    • Search: Enter any part of the type into the search box to filter the list of types. The search is not case-sensitive. If types are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload types from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload types from the SAP endpoint. This may be useful if you have recently added types to the SAP instance. This action refreshes all metadata used to build the table of types displayed in the configuration.
    • Select an IDoc Type: Within the table, click anywhere on a row to select a type. Only one type can be selected. The information available for each type is fetched from the SAP endpoint:
      • Name: The IDoc type name from SAP.
      • Description: The IDoc type description from SAP.

    TIP: If the table does not populate with available types, the SAP connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 3 – Review Data Schema

Connectivity tab

  • Data Schema: The request and response data schemas for SAP will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    Refer to the SAP Help Portal and engage with your SAP administrator or SAP consultant for information on BAPI, RFC, and IDoc schema fields.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring an SAP IDoc activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

SAP IDoc activities can be used as a target with these operation patterns:

Operations that contain an SAP activity can only have one SAP activity and cannot also contain any NetSuite, Salesforce, ServiceMax, or SOAP activities. Note that there is currently a known issue where operations that contain more than one of these types of activities appear to be valid and are able to be deployed without error. However, the operation will fail at runtime.

Other patterns are not valid using SAP IDoc activities. See the validation rules on the Operation Validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jun 25, 2019

  • No labels