SAP Send IDOC activity
Use the SAP Send IDOC activity to send an IDOC to the specified SAP endpoint, during run time.
If you send your SAP data directly to the SAP system using an RFC port, you must use the SAP Send IDOC activity. If you send 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 Write Flat File activity to write the SAP data. For more information, see Generating a Flat File Schema from an IDOC.
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.
During run time, if the SAP Send IDOC activity processes two instances of an IDOC, where both instances have the same IDOC number, the SAP Send IDOC activity appends the data segment of the second instance to the first instance.
Adding a SAP Send IDOC activity to the orchestration
- Create or open an orchestration. A graphical representation of the orchestration is displayed.
- Select the Activities tab and expand the SAP folder.
- Drag the Send IDOC activity onto the orchestration.
- Select the activity. The Checklist is displayed.
Creating, selecting, or editing a SAP endpoint
- Click Pick Endpoint task from the Checklist and
select one of the following actions:
- Select an existing endpoint:
- Select Browse. The Project Explorer is displayed.
- Select an existing endpoint and click OK. Go to the Configuring the activity procedure.
- Select an existing endpoint and edit the endpoint:
- Select Browse. The Project Explorer is displayed.
- Select an existing endpoint and click OK.
- Click Edit. The Edit Endpoint panel is displayed.
- Create a new endpoint: Select New. The Create Endpoint panel is displayed.
- Select an existing endpoint:
- Create or Edit a SAP endpoint.
Configuring the activity
- Select the Configure task from the Checklist. The Configure panel is displayed.
- Click Browse....
- Select an IDOC row and click OK. The Message Type, IDOC Type, and IDOC Extended Type in the Configure task are populated.
- 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.
Specifying the retry options
- Select the Retry task from the Checklist. The Retry panel is displayed.
- Configure the retry options for connecting to an SAP System. The
following table describes the retry options for connecting to an SAP
System:
Retry options Description 1) Wait ___ seconds between each retry. Specifies the number of seconds that the Integration Appliance waits before trying to establish a connection to the SAP System. 2) Try to connect ___ times before failing. Specifies the maximum number of times the Integration Appliance attempts to establish a connection to the SAP System before issuing an error and stopping the processing of the current orchestration job. If you deploy an orchestration that contains an SAP Send IDOC activity and the Integration Appliance cannot connect to the specified SAP System, the Integration Appliance logs the connections errors as warnings in the system and orchestration logs until the retry count value is reached. When the retry count is reached, the Integration Appliance logs an error in the system and orchestration logs and the stops processing the current orchestration job. For example, you set the retry count to 3. The first, second, and third connection errors appear in the system log as warnings. The Integration Appliance logs the fourth connection error as an error and stops processing the current orchestration job.
Mapping the inputs of the activity
- Select the Map Inputs task in the Checklist. The input parameter of the activity are displayed in the To Activity panel. The XML Schema generated from selected IDOC Type and IDOC Extended Type becomes the input parameter of the activity.
- Right-click the To Activity section and
select Show Optional Parameters.
The SAP connector also supports dynamic endpoint connection to a different SAP system. During run time, add optional parameters in sapConnectionProperties of map inputs, if you want to dynamically connect to an SAP system other than the one configured in the endpoint panel, if you want to connect to the same SAP system with a different user name and password other than the fields used in the endpoint panel, or if you want a different SSO token other than the one added in the endpoint panel. The parameters of sapConnectionProperties are described in the following table:
Table 1. Connection properties Optional parameter Description sapConnectionProperties parameters hostName Specifies the IP Address or the machine name that contains the SAP system. systemNumber Specifies the number that identifies the specific instance of the SAP system that Studio should connect to. Your SAP administrator must supply this information. client Specifies a number that identifies Studio and the Integration Appliance as a client for the SAP system. Your SAP administrator must supply this information. language Specifies the message language option for SAP. For example, EN is the ISO code for English. basicAuthentication parameters username Specifies the user name to use when connecting to the SAP system. password Specifies the password to the user name when connecting to the SAP system. ssoAuthentication parameters ssotoken Specifies the single sign-on (SSO) token. sncAuthentication parameters sncmode Specifies if the Secure Network Connections (SNC) mode is enabled. sncname Specifies the distinguished name of the SNC connection. partner Specifies the distinguished name of the SNC partner. qop Specifies the level of security of SNC. X509 Certificate Specifies the X509 certificate to be used as the logon ticket. This field is optional only if Username/Password based authentication is used with SNC. connectionPool parameters maximumConnections Specifies the additional SAP connections, up to the specified amount, which the Integration Appliance opens based on the message load. maxIdleTime Specifies the number of minutes that a SAP connection can be open and idle before being closed by the Integration Appliance. - Create a map between orchestration variables and the IDOC input parameters and tables. 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.