Bookshelf v7.5: Receiving IDOCs with MQSeries

The EAI MQSeries AMI Transport Service is used for this type of communication with MQSeries. This service is called repeatedly from the SAP IDOC AMI Receiver for MQ Series (alias SAPIdocAMIMqRcvr) component. When an IDOC is placed in the MQSeries queue, the EAI MQSeries AMI Transport Service retrieves the IDOC from the queue and invokes the EAI SAP IDOC MQ AMI Workflow Processor. This service extracts the IDOC from an MQSeries buffer and creates an IDOC Integration Object. The IDOC Integration Object is passed to the EAI SAP IDOC Workflow Service which invokes the appropriate workflow.

Configuring the MQSeries Workflow Processor

Table 38 summarizes the User Properties and Component Parameters that may be set to control the behavior of the EAI SAP IDOC MQ AMI Workflow Processor service method ReceiveDispatch. Those variables that may be set as component parameters must be set for the SAPIdocAMIMqRcvr component.

Table 38. IDOC MQ AMI Workflow Processor Configuration Options
Name	User Prop	Comp Param	Method Arg	Valid Values	Usage
<Value>			X		Raw data buffer from MQSeries.
DispatchFormat	X			"MQ"	Currently set to "MQ". This should not be changed.
DispatchService	X				Business service to send IDOC integration object to workflow. This must be a service based on CSSWfEngine, and is currently set to `EAI SAP IDOC Workflow Service`.
DispatchMethod	X				Business service method to call in DispatchService.
SAPIdocAllowedObjectnn	X				Name of IDOC integration object that can be accepted by the workflow processor. Read the following note and caution.
SAPCodepage	X	X		Value from Transcode Encoding picklist	Siebel Codepage name for SAP codepage.
SAPIgnoreCharSetConvErrors	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.

NOTE: There may be up to 99 user properties defined with a name of the form, SAPIdocAllowedObjectnn, such as SAPIdocAllowedObject01, SAPIdocAllowedObject02, SAPIdocAllowedObject03, and so on. Each of these would contain the name of an IDOC Integration Object that can be accepted by the IDOC MQ AMI Workflow Processor.

CAUTION: When an IDOC is received from MQSeries, the External Name is extracted from information in the control record of the IDOC. This name is then compared with the External Names for each integration object listed in the user properties SAPIdocAllowedObjectnn. When a match on the External Name is found, the corresponding IDOC Integration Object is used. For this reason, each IDOC Integration Object defined by an SAPIdocAllowedObjectnn user property must have a distinct external name. For example, two IDOC Integration Objects that both have the external name of DEBMAS02 cannot be used at the same time.

Invoking Workflows

Once an IDOC is received and passed to the Workflow Processor, the Workflow Processor must pass this IDOC Integration Object on to a specific workflow. The workflow name to which this IDOC Integration Object will be passed must be defined. For information on how to define the workflow name, read Receiving IDOCs from SAP.

Starting the MQSeries Server for AMI

Starting the SAP IDOC AMI Receiver for MQ Series (alias SAPIdocAMIMqRcvr) component as a background process is very similar to starting the tRFC BAPI Receiver component. For more information, read Starting the tRFC BAPI Receiver. The following are required component parameters for starting this receiver:

Read Chapter 2, "EAI MQSeries Transport" in Transports and Interfaces: Siebel eBusiness Application Integration Volume III for more information on the EAI MQSeries AMI Transport service on which this component is based.