Bookshelf v7.5: Sending IDOCs to SAP

As explained in Customizing Integrations the IDOC adapter is responsible for converting an IDOC integration object into the raw data required by the tRFC BAPI adapter and invoking the tRFC BAPI Adapter to send the IDOC to SAP. The EAI SAP IDOC adapter service is the business service that represents the IDOC adapter. This topic provides additional information on the configuration and use of this service.

Table 34 and Table 35 summarize the user properties, method arguments, and component parameters that may be set to control the behavior of the EAI SAP IDOC adapter. The EAI SAP IDOC adapter is a cached business service. Variables that are defined to be user properties in the business service are generally used only once for initialization purposes at the time of the first call to the business service. Variables that are defined to be method arguments are used on each call and may vary from call to call. Those variables that may be set as component parameters must be set for the Business Integration Manager component.

Table 34 contains User Properties, Component Parameters and Input Method Arguments for the Send Method.

Table 34. IDOC Adapter Configuration Options
Name	User Prop	Comp Param	Method Arg	Valid Values	Usage
SAPRfcConnectString		X	X		SAP connection string - read Modifying Siebel Configuration Files for format. This string defines the destination (used in `saprfc.ini`), client and language for the SAP connection.
SAPRfcUserName		X	X		SAP user name
SAPRfcPassword		X	X		SAP password
SAPRfcTrace		X	X	true or false	SAP trace file usage on or off. Same as TRACE=0 or 1 in `saprfc.ini` file.
SiebelMessage			X		EAI Siebel Message containing IDOC integration object instance.
SAPReceiverPrtnrNum		X	X	Logical system name	Logical system for the SAP client you are sending the IDOC to.
SAPReceiverPrtnrType		X	X	Partner type	Defaults to LS if not set for logical system.
SAPSenderPrtnrNum		X	X	Logical system name	Logical system name for your external system. This name must be set up in SAP. Read Creating Logical Systems Within SAP.
SAPSenderPrtnrType		X	X	Partner type	Defaults to LS if not set for logical system.
DispatchFormat	X			"ALE"	Currently set to ALE for the IDOC adapter. This should not be changed.
DispatchService	X			Business service name	Currently set to the `EAI SAP BAPI adapter (tRFC)` service. This should not be changed.
DispatchMethod	X			Method name	Currently set to the Execute method of the `EAI SAP BAPI adapter (tRFC)` service. This should not be changed.
SAPWriteXML		X		"WriteOnly", "WriteNone", "WriteOnErr", "WriteBeforeErr"	If set, overrides the user property setting for this in the `EAI SAP BAPI adapter (tRFC)` service.
SAPXMLQueueCleanup		X		"true" or "false"	If set, overrides the user property setting for this in the `EAI SAP BAPI adapter (tRFC)` service.
SAPXMLQueueService		X		XML queuing service name	If set, overrides the user property setting for this in the `EAI SAP BAPI adapter (tRFC)` service.
SAPXMLQueueName		X		EAI Queue name	If set, overrides the user property setting for this in the `EAI SAP BAPI adapter (tRFC)` service.
SAPCodepage	X	X	X	Value from Transcode Encoding picklist	Siebel Codepage name for SAP codepage.
SAPIgnoreCharSetConvErrors	X	X	X	True or False	Default is False. If True, codepage conversion errors are handled by substitution of the question mark (?) character in place of an unrecognized character.

SAPRfcConnectString uses SAP's internal connect string format. This must include the following elements:

These elements must separated in the string by one or more spaces, for example, "DEST=DEV_Outbound CLIENT=555 LANG=E". Table 35 contains output method arguments for the Send Method.

Table 35. Send Method Arguments for Output
Name	Usage
DispatchErrorStatus	Contains the RFC exception string returned by SAP. If connection to SAP fails, this string begins with the text: "RFC Exception: __SIEBEL__SAP_CONNECT_FAILED__"

If the value of SAPWriteXML is set to anything other than "WriteNone", the EAI Queue is used. For more information on the EAI Queue, read EAI Queue. When sending IDOCs to SAP the queue is accessed by the EAI SAP BAPI adapter (tRFC) service.