ALE pass-through IDoc business object structure, WebSphere Adapter for SAP Software

During ALE processing, the adapter exchanges business objects with the SAP application. The business object represents an individual IDoc or an IDoc packet. For inbound operation using pass-through IDocs, you can choose to create a parsed Control Record (Inbound only) along with a HexBinary stream to hold both the Control Record and the Data Record. For the first case, the business object will contain a child Business Object representing the parsed Control Record, and a HexBinary field to hold both the Data Record and Control Record. The same business object format is used for inbound and outbound ALE pass-through IDoc processing. For outbound operations using pass-through IDocs, the business object contains an IDoc stream instead of a child business object.

The control record will be generated using field names, by default.

The following figure illustrates a business object that represents a specific IDoc (Alereq01):

Figure 1. Example of an ALE pass-through business object

Screen capture of SapAlereq01, showing that it contains a transaction ID, queue name, stream data, and IDoc type.

Parsed Control Record for Inbound

The business object contains a transaction ID, a queue name, stream data to hold the Data Record and Control Record, a child business object for the parsed Control Record and the IDoc type. The transaction ID (SAPTransactionID) is used to ensure once-only delivery of business objects, and the queue name (qRFCQueueName) specifies the name of the queue on the SAP server to which the IDocs should be delivered. If you are not using transaction IDs or queues, these properties are blank.

To parse the IDoc control record, select the checkbox in the configuration screen during the external service wizard run.

Figure 2. Configuration properties window This screen capture is described in the surrounding text

The following figure illustrates a business object for a generic IDoc when the Parse the IDoc Control Record is unchecked.

Figure 3. Example of an ALE pass-through generic IDoc business object

Screen capture of SapGenericIDocObject, showing that it contains a transaction ID, queue name, stream data, and IDoc type.

When the Parse the IDoc Control Record checkbox is selected, a child business object is generated to hold the parsed Control Record.

The following figure illustrates a business object that represents a Generic IDoc when the checkbox is selected:

Figure 4. Example of a generic IDoc business object This image is described in the surrounding text

Additional information about the business object can be found in the application-specific information of the business object. For example, the application-specific information for SapAleReq01 lists whether the IDoc packet is split and provides information about the type of object, which, for pass-through IDoc business objects is always PASSTHROUGHIDOC.

Figure 5. Application-specific information for an ALE pass-through IDoc business object

Screen capture of ALE business object metadata for pass-through IDoc.

The ASI for the delimiter and the IDoc version will also be added if the Flat File option is enabled.