BDO element mapping to AS2 and AS4 elements
A business document object (BDO) XML contains metadata, in the form of elements, that exchange information between AS4 Microservice and the business application. You can use the mapping between the BDO, AS2 and AS4 message elements to assist in your application configuration and troubleshooting.
For AS2 and AS4 messages, the elements in a BDO are constructed into an ebMS message when AS4 Microservice processes an outbound message. Similarly, for an inbound message, the elements in the received message are used to construct a BDO to send to the business application.
The following table provides a mapping of BDO elements to AS2 and AS4 message elements. Additionally, it also provides information about corresponding configuration in AS4 Microservice wherever applicable.
| BDO element | Description | Corresponding to AS2 element | Corresponding to AS4 element | Corresponding configuration in AS4 Microservice |
|---|---|---|---|---|
| BusinessDocument | Contains the business metadata that is needed for the exchange of information between AS4 Microservice and the business application. |
NA |
NA |
NA |
| TransactionId | A unique identifier for the transaction. |
NA |
NA |
NA |
| MessageId | A unique identifier for the message that is exchanged. |
Message-Id |
eb:MessageInfo/eb:MessageId |
NA |
| RefToMessageId | A unique identifier for an earlier message that was exchanged. |
NA |
eb:MessageInfo/eb:RefToMessageId |
NA |
| ConversationId | A unique identifier that correlates a group of exchanges. |
NA |
eb:CollaborationInfo/eb:ConversationId |
NA |
| ExchangeId | A unique identifier for an exchange profile. |
NA |
NA |
The unique identifier (UUID) that represents the exchange profile |
| DestinationAddress | The HTTP or HTTPS destination or messaging destination name to which a message is delivered. |
NA |
NA |
The HTTP or HTTPS destination that is specified in the exchange profile. |
| SendingPartner | Contains elements that identify the partner that is sending the message or initiating the message exchange. |
NA |
eb:PartyInfo/eb:From |
NA |
| SendingPartner/BusinessId | Unique identifier for the sending partner |
AS2-From | eb:PartyInfo/eb:From/eb:PartyId | Sender ID. |
| SendingPartner/AuxiliaryBusinessId | Identifies that business ID to use in the message headers. |
AS2-From (overriden) | eb:PartyInfo/eb:From/eb:PartyId (overriden) | NA |
| SendingPartner/BusinessId/@type | The sender ID type indicates the area or domain to which the content of the sender ID of the trading partner organization belongs to. The value of sender ID type is generally
an URI. For example, |
NA |
eb:PartyInfo/eb:From/eb:PartyId/@type | Sender ID type |
| SendingPartner/Name | Name of the sending partner. |
NA |
NA |
The name of the sending organization. |
| SendingPartner/Role | Role of the sending partner. |
NA |
eb:PartyInfo/eb:From/eb:Role | Role of the sending partner. |
| SendingPartner/UserId | An identifier that represents a subject for authentication. |
NA |
NA |
NA |
| SendingPartner/SAML | If SAML token authentication is agreed between the partners, this element contains the SAML token. |
NA |
NA |
NA |
| SendingPartner/X509Certificate | Contains information about the sending partner's X509 certificate that is used to sign the message. |
NA |
NA |
The certificate that is used to sign the message. It is specified in the conformance policy (for AS4) or security policy (for AS2). |
| ReceivingPartner | Contains elements that identify the partner that is receiving the message or consuming the message. |
NA |
eb:PartyInfo/eb:To |
NA |
| ReceivingPartner/BusinessId | Unique identifier for the receiving partner |
AS2-To | eb:PartyInfo/eb:To/eb:PartyId | Receiver ID. |
| ReceivingPartner/AuxiliaryBusinessId | Identifies that business ID to use in the message headers. |
AS2-To (overriden) | eb:PartyInfo/eb:To/eb:PartyId (overriden) | NA |
| ReceivingPartner/BusinessId/@type | The receiver ID type indicates the area or domain to which the content of the receiver ID of the trading partner organization belongs to. The value of receiver ID type is generally
an URI. For example, |
NA |
eb:PartyInfo/eb:To/eb:PartyId/@type | Receiver ID type. |
| ReceivingPartner/Name | Name of the receiving partner. |
NA |
NA |
The name of the receiving organization. |
| ReceivingPartner/Role | Role of the receiving partner. |
NA |
eb:PartyInfo/eb:To/eb:Role | Role of the receiving organization. |
| ReceivingPartner/UserId | An identifier that represents a subject for authentication. |
NA |
NA |
NA |
| ReceivingPartner/SAML | If SAML token authentication is agreed between the partners, this element contains the SAML token. |
NA |
NA |
NA |
| ReceivingPartner/X509Certificate | Contains information about the receiving partner's X509 certificate. |
NA |
NA |
NA |
| DocumentType | In an AS2 exchange, this element corresponds to the document type. In an AS4 exchange, this element corresponds to the action specified in the exchange profile. |
NA |
eb:CollaborationInfo/eb:Action | NA |
| Operation | Identifies an operation to be performed for a service. |
NA |
NA |
NA |
| Service | Identifies the service that acts on the message. |
NA |
eb:CollaborationInfo/eb:Service | Service. Applicable only for AS4 exchanges. |
| Service/@type | The service type indicates how the participating organizations interpret the service. For example, the supplier
order processing service can have collect quotations, purchase order
request, purchase order conformation, and purchase order update as
the types. Example of a service type is, |
NA |
eb:CollaborationInfo/eb:Service/@type | Service type. Applicable only for AS4 exchanges. |
| DataDomain | Identifies the domain for storage blob
access.
Note: DataDomain is not sent in request.
However, a user must know the value to use from the business application.
|
NA |
NA |
NA |
| TargetServiceName | Identifies the OSGi service name to be invoked on receiving the message. In an inbound flow, the service is the messaging destination to which the unpacked message (payload and attachments) and the BDO XML are sent. In an outbound flow, the service can be store and forward service (SFS), if configured, or the target service. |
NA |
NA |
The messaging destination or messaging receiver that is specified in the exchange profile. |
| Payload | Identifies the payload in the message. |
MIME part with root Content-Id. |
eb:PayloadInfo | NA |
| Payload/ContentID | Unique identifier for the payload container |
Content-Id | eb:PayloadInfo/eb:PartInfo/@href | NA |
| Payload/PartProperties | Contains some properties that describe the payload. Depending on the protocol (AS2 or AS4), the part properties might be put in the message headers. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:PartProperties | NA |
| Payload/ContentType | Specifies the content type of the payload. For example, text/plain, and XML. |
Content-Type | eb:PayloadInfo/eb:PartProperties/@MimeType | NA |
| Payload/Description | Description about the payload |
NA |
eb:PayloadInfo/eb:PartProperties/@Description | NA |
| Payload/ContentLength | Length of the payload container in bytes. |
NA |
NA |
NA |
| Payload/OriginalFileName | The original file name of the payload is represented in the business application or in the message. The original file name of the business attachments and the payload is preserved in AS4 Microservice. |
Content-Disposition is the file name parameter. |
NA (for the current release) |
NA |
| Payload/DocumentData | Identifies inline base64 encoded data or a unique ID that is a reference to a storage blob. |
MIME part with Content-Id same
as the |
SOAP Body: Payload(s) | NA |
| Payload/@inline | Specifies whether the payload must be sent inline or not. |
NA |
NA |
Payload is sent inline if the payload size is less than or equal to the size specified in the AS4 or AS2 receiver configuration. |
| Payload/Schema | Schema for the payload. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:Schema/@location | NA |
| Payload/Schema/@namespace | Namespace for the payload. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:Schema/@namespace | NA |
| Attachments | Identifies the attachments in the message. |
MIME parts other than the root content
specified in the |
NA |
NA |
| Attachment | Identifies a specific attachment in the message. |
Individual MIME part other than the root
content specified in the |
NA |
NA |
| Attachment/ContentID | Unique identifier for the attachment container |
ContentID | eb:PayloadInfo/eb:PartInfo/@href | NA |
| Attachment/ContentType | Specifies the content type of the attachment. For example, text/plain, and XML. |
ContentType | NA |
NA |
| Attachment/ContentLength | Length of the attachment payload container in bytes. |
NA |
NA |
NA |
| Attachment/OriginalFileName |
The original file name of this attachment is represented in the business application or in the message. The original file name of the business attachments and the payload is preserved in AS4 Microservice. |
Content-Disposition file name parameter. |
NA (for the current release) |
|
| Attachment/Schema | Schema for the attachment. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:Schema/@location | NA |
| Attachment/Schema/@namespace | Namespace for the attachment. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:Schema/@namespace | NA |
| Attachment/DocumentData | Identifies inline base64 encoded data or a unique ID that is a reference to a storage blob. |
MIME Part(s): Payload(s) | MIME Part(s): Payload(s) | NA |
| Attachment/PartProperties | Contains some properties that describe the attachment. Depending on the protocol (AS2 or AS4), the part properties might be put in the message headers. |
NA |
eb:PayloadInfo/eb:PartInfo/eb:PartProperties | NA |
| TransportHeaders | Identifies the transport (HTTP or HTTPS) headers that are used in the exchange. |
Extra custom transport headers in the MIME packaged message. |
NA |
NA |
| ProtocolParameters | Identifies the set of internal properties that are used between components. |
NA |
NA |
Based on the protocol that is selected when the exchange profile is configured. |
| MessageProperties | Identifies the set of properties that are used in the message. |
NA |
eb:MessageProperties | NA |
| Notification | Identifies the notification message parameters that are used to notify the business application. |
NA |
NA |
Based on the conformance policy configuration. |
| isDuplicate | Specifies whether the message is duplicate. |
NA |
NA |
Based on the conformance policy configuration. |
| selectivelyPullFragments | Specifies whether the fragments must be selectively pulled. |
NA |
NA |
NA |
| Encoding | Identifies the encoding to be used when a message from the back-end is consumed, or when a message is posted to the backend. For Base-64 encoded payloads, use |
Content-Transfer-Encoding (NA for current release) | Content-Transfer-Encoding (NA for current release) | NA |