Business Document Receiver adapter
The adapter is used by Sterling B2B Integrator to receive messages from AS4 Microservice over the message fabric. The adapter listens to queues and process messages that are sent to the queues. The adapter maps the messages from the queues and selects and bootstraps business processes on Sterling B2B Integrator. The adapter can also send a reply message from Sterling B2B Integrator back to the requester, if the requester asked for a reply.
Overview
| Characteristic | Definition |
|---|---|
| System Name | BDReceiverAdapter |
| Graphical Process Modeler (GPM) category | All Services |
| Description | The adapter receives messages from AS4 Microservice over the message fabric in asynchronous mode and sending a reply when a response is required. |
| Business usage | The adapter functions as bridge between AS4 Microservice and Sterling B2B Integrator. When implemented along with the MEIG Messaging Config adapter, this adapter exchanges data, system state, system events with AS4 Microservice and effectively integrates the customer’s existing assets in AS4 Microservice with new functions provided in AS4 Microservice. |
| Usage example | Customer uses AS4 Microservice for AS2 outbound but still needs some translation and mapping that is done in Sterling B2B Integrator. The Business Document Receiver Adapter receives messages from AS4 Microservice and extracts the payload as the primary document and calls a custom business process for more processing. A custom business process calls the Business Document Receiver Adapter to send a reply message back to AS4 Microservice for AS4 Microservice to consume the message and construct 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 Receiver 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 cannot be in a group. |
| Initiates business processes? | Yes. |
| Invocation | This adapter can be started in a business process only when the message sender requested a reply. |
| Business process context considerations | None |
| Returned status values | None |
| Restrictions | This adapter is only available in a Sterling B2B Integrator Adapter Container. This adapter cannot be in a group. |
| Persistence level | System default. |
| Testing considerations | Turn on system debug to show debug messages from the adapter in the system.log. |
Implementing the Business Document Receiver adapter
To implement this adapter, create an instance in Sterling B2B Integrator and set the parameters.
Configuring the Business Document Receiver adapter
The following parameters apply to the Business Document Object Receiver 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 cannot be in a group. Use the default group None. |
| Configuration Adapter Instance | The MEIG Messaging Config adapter to use to connect to AS4 Microservice. Required. |
| Endpoint | The name of the message fabric queue that the adapter listens on for messages. Value is an alphanumeric string. Required. |
| Number of Consumers | The number of listeners on the message queue. Value is numeric. Required. |
| Business Process | The name of the business process the adapter starts when a message is received on the endpoint queue. Value is alphanumeric and can be any valid business process in Sterling B2B Integrator. Required. |
| Run BP in Sync Mode | Whether the business process is run synchronously. Values are Yes or No. Required. |
| Produce Raw Business Document | Whether to produce raw business documents. Values are True or False. Default is False. Required. |
| Send Visibility Events | Whether to send visibility events. Values are True or False. Default is True. Required. |
| Generate Documents | Whether to generate document objects. Values are True or False. Default is True. Required. |
| Process Execution Mode | The execution mode for the business process. Values are Default and FIFO. Required. |
Parameters passed from business process to service
Parameters are only passed from the business process to the service when a reply is required for a received message. All business process parameters for the Business Document Object Sender adapter are accepted. 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 endpoint to which the adapter sends messages. Value is an alphanumeric string. Required. |
| Number of Consumers | The number of consumers that are listening on the endpoint. Value is numeric. Required. |
| Action Timeout | The timeout value when the adapter is sending a reply message. Value is numeric. Default is 5000 (in milliseconds) Optional. |
| messageID | The identifier header to set in the message. Value is alphanumeric. Optional. |
| correlationID | The correlation identifier header to set in the message. Value is alphanumeric. Optional. |
| groupID | The group identifier header to set in the message. Value is alphanumeric. Optional. |
| messageType | The message type header to set in the message. Any message type is valid. Optional. |
| messageVersion | The message version header to set in the message. Any version is valid. Optional. |
| redeliveryFlag | The redelivery flag header to set in the message. Valid values are true or false. Optional. |
| sentFrom | The sent from header to set in the message. Value is alphanumeric. Optional. |
| sentTimestamp | The sent time stamp header to set in the message. Value is alphanumeric. Optional. |
| replyTo | The reply to header to set in the message. Value is alphanumeric. Optional. |
| sequenceTotal | The sequence total header to set in the message. Value is numeric. Optional. |
| sequenceNumber | The sequence number header to set in the message. Value is numeric. Optional. |
| receivedTimestamp | The received time stamp header to set in the message. Value is numeric. Optional. |
| expirationTimestamp | The expiration time stamp header to set in the message. Value is numeric. Optional. |
| priority | The sequence total header to set in the message. Value is numeric. Optional. |
| errorDestination | The error destination header to set in the message. Value is alphanumeric. Optional. |
| failoverDestination | The failover destination header to set in the message. Value is alphanumeric. Optional. |
| SendingPartnerBusinessId | The sending partner business identifier. Required. |
| ReceivingPartnerBusinessId | The receiving partner business identifier. Required. |
| ReceivingPartnerName | The sequence total header to set in the message. Optional. |
| ReceivingPartnerUserId | The receiving partner user identifier. Optional. |
| DocumentType | The type of document sent. Optional. |
| messageId | The message identifier. Optional. |
| refToMessageId | The reference to message identifier. Optional. |
| conversationId | The conversation identifier. Optional. |
| TransactionId | The transaction identifier. Required. |
| DataDomain | The data domain. Optional. |
| ExchangeId | The exchange identifier. Optional. |
| Operation | The operation. Optional. |
| TargetServiceName | The target service name. Optional. |
| ServiceValue | The service value. Optional. |
| ServiceType | The service type. Optional. |
| PartPropertiesPayloadPropertyName1 … <N> | Part properties for payload, property name. It is possible to define multiple if each is suffixed with unique sequence number. Optional. |
| PartPropertiesPayloadPropertyValue1 … <N> | Part properties for payload, property value. It is possible to define multiple if each is suffixed with unique sequence number. Optional. |
| PartPropertiesPayloadPropertyType1 … <N> | Part properties for payload, property type. It is possible to define multiple if each is suffixed with unique sequence number. Optional. |
| PartPropertiesAttachment1PropertyName1 … <N> … PartPropertiesAttachment<N>PropertyName1 … <N> | Part properties for attachment, property name, 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. Optional. |
| PartPropertiesAttachment1PropertyValue1 … <N> … PartPropertiesAttachment<N>PropertyValue1 … <N> | Part properties for attachment, property value, 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. Optional. |
| 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. Optional. |
| TransportHeadersPropertyName1 … <N> | Properties for transport headers, property name. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| TransportHeadersPropertyValue1 … <N> | Properties for transport headers, property value. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| TransportHeadersPropertyType1 … <N> | Properties for transport headers, property type. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| ProtocolParametersPropertyName1 … <N> | Properties for protocol parameters, property name. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| ProtocolParametersPropertyValue1 … <N> | Properties for protocol parameters, property value. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| 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. Optional. |
| MessagePropertiesPropertyValue1 … <N> | Properties for message properties, property value. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
| MessagePropertiesPropertyType1 … <N> | Properties for message properties, property type. It is possible to define multiple if each is suffixed with a unique sequence number. Optional. |
Parameters passed from service to business process
All of the parameters that are passed from the business process
to the service are valid. In addition, the parameters are listed and
described in this table can also be passed from the service to the
business process:
| Parameter | Description |
|---|---|
| Payload | The payload document that is created by the adapter. Value is alphanumeric. Required when document creation is enabled. |
| Attachment1...AttachmentN | The attachment document that is created by the adapter when an attachment is present in the message. Value is alphanumeric. Optional. |
| Request Message ID | The session identifier for the reply message when a reply is required by the received message. Value is alphanumeric. Required for reply messages. |
Example business process
The business process is started by the Business Document Receiver adapter. The business process extracts the primary document that is created by the adapter to a file system with a File System adapter then sends the same primary document back to AS4 Microservice as a response message.