Business Document Sender adapter
The adapter is used by Sterling B2B Integrator to send messages to AS4 Microservice over the message fabric.
Overview
| Characteristic | Definition |
|---|---|
| System Name | BDOSenderAdapterType |
| Graphical Process Modeler (GPM) category | All Services |
| Description | The adapter sends messages to AS4 Microservice over the message fabric. |
| Business usage | The adapter functions as bridge between AS4 Microservice and Sterling B2B Integrator. When implemented along with MEIG Messaging Config adapter, this adapter exchanges data, system state, system events with AS4 Microservice and effectively integrate customer’s existing assets in Sterling B2B Integrator with new functions provided in AS4 Microservice. |
| Usage example | Customers use AS4 Microservice for AS2 outbound but still needs some translation / mapping that is done in Sterling B2B Integrator. Sterling B2B Integrator creates the output data and sends the message along with a custom event to AS4 Microservice over the message fabric so AS4 Microservice consumes it and constructs the AS2 outbound request. |
| Preconfigured? | Yes. |
| Requires third-party files? | No. |
| Platform availability | All platforms that are supported by the application |
| Related services | The Business Document Sender adapter is used with the MEIG Messaging Config adapter to exchange messages with AS4 Microservice. The Business Document Sender adapter sends the messages over the connection that is established by the MEIG Messaging Config adapter. |
| Application requirements | This adapter can be deployed only in a Sterling B2B Integrator adapter container. You must set up at least one adapter container before you configure this adapter. This adapter can be part of a group. |
| Initiates business processes? | No. |
| Invocation | Yes. This adapter can be started anywhere inside a business process. |
| Business process context considerations | None |
| Returned status values | None |
| Restrictions | This adapter is only available in a Sterling B2B Integrator Adapter Container. |
| Persistence level | System default. |
Implementing the Business Document Sender adapter
To implement this adapter, create an instance in Sterling B2B Integrator and set the parameters. Have the business process call the adapter.
Configuring the Business Document Sender adapter
The following parameters apply to the Business Document Sender adapter:
| Parameter | Description |
|---|---|
| Name | The name of the adapter instance. Value is an alphanumeric string. Required. |
| Description | A description of the adapter instance. Value is an alphanumeric string. Required. |
| Environment | The adapter container in which the adapter configure is configured. Drop list of defined adapter containers. Required. |
| Select a Group | Whether to group a series of adapters together in a service group. Options are: None, Select a Group, Create New Group. Required. This adapter can be part of a group. |
| Configuration Adapter Instance | The MEIG Messaging Config adapter to use to connect to AS4 Microservice. Required. |
SAML tokens
You can pass SAML tokens from a business process that you edited with the Graphical Process Modeler to the AS4 Microservice through this adapter. You must specify the SAML token in xml format within single quotation marks for SendingPartnerSAML parameter.
Parameters passed from business process to service
This table lists and describes the parameters that are passed from the business process to the service:
| Parameter | Description |
|---|---|
| Endpoint Name | The name of the WebSphere® MQ queue that is listening for something to initiate a send. Value is an alphanumeric string. Required. |
| Number of Consumers | The number of consumers that are listening on the endpoint. Value is numeric. Required. |
| PartPropertiesPayloadPropertyName1 … <N> | Part properties for payload, property name. It is possible to define multiple if each is suffixed with unique sequence number. |
| PartPropertiesPayloadPropertyValue1 … <N> | Part properties for payload, property value. It is possible to define multiple if each is suffixed with unique sequence number. |
| PartPropertiesPayloadPropertyType1 … <N> | Part properties for payload, property type. It is possible to define multiple if each is suffixed with unique sequence number. |
| PartPropertiesAttachment1PropertyName1 … <N> … PartPropertiesAttachment<N>PropertyName1 … <N> | Part properties for attachment, property name, It is possible to define multiple as long as suffixed with unique sequence number. It is also possible to have multiple attachments if each is suffixed with unique sequence number. |
| PartPropertiesAttachment1PropertyValue1 … <N> … PartPropertiesAttachment<N>PropertyValue1 … <N> | Part properties for attachment, property value, It is possible to define multiple as long as suffixed with unique sequence number. It is also possible to have multiple attachments if each is suffixed with unique sequence number. |
| PartPropertiesAttachment1PropertyType1 … <N> … PartPropertiesAttachment<N>PropertyType1 … <N> | Part properties for attachment, property type, It is possible to define multiple if each is suffixed with unique sequence number. It is also possible to have multiple attachments if each is suffixed with unique sequence number. |
| TransportHeadersPropertyName1 … <N> | Properties for transport headers, property name. It is possible to define multiple if each is suffixed with a unique sequence number. |
| TransportHeadersPropertyValue1 … <N> | Properties for transport headers, property value. It is possible to define multiple if each is suffixed with a unique sequence number. |
| TransportHeadersPropertyType1 … <N> | Properties for transport headers, property type. It is possible to define multiple if each is suffixed with a unique sequence number. |
| ProtocolParametersPropertyName1 … <N> | Properties for protocol parameters, property name. It is possible to define multiple if each is suffixed with a unique sequence number. |
| ProtocolParametersPropertyValue1 … <N> | Properties for protocol parameters, property value. It is possible to define multiple if each is suffixed with a unique sequence number. |
| ProtocolParametersPropertyType1 … <N> | Properties for protocol parameters, property type. It is possible to define multiple if each is suffixed with a unique sequence number. |
| MessagePropertiesPropertyName1 … <N> | Properties for message properties, property name. It is possible to define multiple if each is suffixed with a unique sequence number. |
| MessagePropertiesPropertyValue1 … <N> | Properties for message properties, property value. It is possible to define multiple if each is suffixed with a unique sequence number. |
| MessagePropertiesPropertyType1 … <N> | Properties for message properties, property type. It is possible to define multiple if each is suffixed with a unique sequence number. |
Parameters passed from service to business process
None.
Example business process
The business process takes an input file as a primary document and sends it to the AS4 Microservice message fabric along with a series of message headers.