IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > SAP Software > Reference > Business object information > Application-specific information
ALE business object application-specific information
ALE application-specific information (ASI) is metadata that specifies adapter-dependent information about how to process ALE business objects for the adapter for SAP Software.
The type of metadata that is generated depends on whether you are using the ALE interface or the ALE pass-through IDoc interface:
- ALE interface
The WebSphere Adapter for SAP Software uses application-specific information (ASI) to create queries for Create, Retrieve, Update, and Delete operations.
ASI for objects generated with the ALE interface is available at the following levels:
- The IDoc business-object level (for individual IDocs)
- The IDoc wrapper business-object level (for IDoc packets)
- The operation level for individual IDoc business objects
- The property level
For ALE inbound processing, the adapter for SAP Software uses ASI to determine which of the supported operations (Create, Retrieve, Update, or Delete) to run on the endpoint.
There is no metadata at the IDoc Data Record or IDoc Control Record child business object-level.
- ALE pass-through IDoc interface
ASI for objects generated with the ALE pass-through IDoc interface is available at the following levels:
- The IDoc business-object level
- The property level
The sections that follow describe the metadata elements for each level.
Business-object-level metadata for ALE
- ALE interface
Business object-level metadata for ALE interface business objects defines the top-level wrapper of an IDoc.
The following table describes the business-object metadata elements of an ALE business object.
Business object-level metadata elements: ALE business object Metadata element Description SplitIDocPacket For inbound operations, an indication of whether the IDoc packet needs to be split into individual IDocs. The possible values are true or false. If you select the corresponding property (check box) in the external service wizard, make sure you set this property to true. Type The business object type. Possible values are IDOC or UNPARSEDIDOC. Operation Each outbound operation contains the following parameters:
- Name
- Name of the operation: For outbound processing, it is always Execute.
Each inbound operation contains the following parameters:
- Name
- Name of the operation: Create, Update, or Delete.
- MsgType
- The message type configured for the IDoc.
- MsgCode
- The message code configured for the IDoc.
- MsgFunction
- The message function configured for the IDoc.
The following illustration is an example of ALE business object metadata for an outbound operation:
Figure 1. Business-object metadata for SapAlereq01
- ALE pass-through IDoc interface
Business object-level metadata for ALE pass-through IDoc interface business objects defines the top-level wrapper of an IDoc.
The following tables describe the business-object metadata elements of an ALE pass-through IDoc interface business object.
Business object-level metadata elements: Generic IDoc business object Metadata element Description SplitIDocPacket For inbound operations, an indication of whether the IDoc packet needs to be split into individual IDocs. The possible values are true or false. If you select the corresponding property (check box) in the external service wizard, make sure you set this property to true. Type The business object type. For a generic IDoc, this value is PASSTHROUGHIDOC. Delimiter Use a delimiter to split an IDoc's control record (fixed length) or IDoc segments (if less than specified length). The possible values are any strings without escape characters, \\n or \\r\\n. Input a delimiter in the wizard at the following location Selecting business objects and services for ALE pass-through IDoc outbound processing
Property-level metadata for ALE business objects
Property-level metadata either represents child objects or an array of child objects.
The following table describes the property-level metadata elements of an ALE business object or an ALE pass-through IDoc interface business object.
Property-level metadata elements: ALE business object Metadata element Description FieldName The actual IDoc field name in SAP. SegmentHierarchy The hierarchy of the segment in the IDoc. Offset The offset value of the current property in the IDoc. PrimaryKey An indication of whether this property is a primary key. ForeignBOKeyRef The xpath to the primary key on the control or data record business object property, which you set using the external service wizard. MaxLength The length of the field. The following illustration is an example of ALE property-level metadata for the qRFCQueueName property:
Figure 2. Property-level metadata for qRFCQueueName
Operation-level metadata for ALE business objects
Operation-level metadata for an ALE business object specifies the operation that posts the IDoc object to the SAP application.
The following table describes the operation-level metadata elements of an ALE business object.
Outbound objects use only the Name metadata element. The MsgType, MsgCode, and MsgFunction elements are used for inbound objects only.
Operation-level metadata elements: ALE business object Metadata element Description Name The name of the operation. MsgType The message type configured for the IDoc (for inbound objects only). MsgCode The message code configured for the IDoc (for inbound objects only). MsgFunction The message function configured for the IDoc (for inbound objects only).