Visibility Event Sender adapter
The adapter is used to send custom visibility events to AS4 Microservice. You must define the custom events that you want to send in the business process that calls this adapter. You only configure this adapter when you want to send custom visibility events.
Overview
| Characteristic | Definition |
|---|---|
| System Name | VisibilityEventSenderAdapter |
| Graphical Process Modeler (GPM) category | All Services |
| Description | The adapter is used to send custom visibility event messages to AS4 Microservice over the message fabric. |
| Business usage | The adapter sends visibility event messages to AS4 Microservice over the message fabric with the MEIG Messaging Config adapter. |
| Usage example | |
| Preconfigured? | Yes. |
| Requires third-party files? | No. |
| Platform availability | All platforms that are supported by the application |
| Related services | The Visibility Event Sender adapter is used with the MEIG Messaging Config adapter to send visibility event messages to the visibility receiver in AS4 Microservice. |
| 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 in a group. |
| Initiates business processes? | No. |
| Invocation | This adapter can be started in 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. |
| Testing considerations | Turn on system debug to show debug messages from the adapter in the system.log. |
Implementing the Visibility Event Sender adapter
To implement this adapter, create an instance in Sterling B2B Integrator and set the parameters.
Configuring the Visibility Event Sender adapter with the user interface
The following parameters apply to the Visibility Event 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. |
Configuring the Visibility Event Sender adapter with the Graphical Process Modeler
The following parameters apply to the Business Document Object Receiver adapter:
| Parameter | Description |
|---|---|
| EndPoint Name | The name of the endpoint this adapter uses to send messages. Value is alphanumeric. Required. |
| Channel Name | The name of the channel the adapter uses to send messages. Value is alphanumeric. Optional. |
| ActionTimeout | Timeout value when the adapter is sending a reply message. Value is numeric. Default is 5000 (in milliseconds). Optional. |
| messageID | The message identifier header to be set in the message. Value is alphanumeric. Optional. |
| correlationID | The correlation identifier header to be set in the message. Value is alphanumeric. Optional. |
| groupId | The group identifier header to be set in the message. Value is alphanumeric. Optional. |
| messageType | The message type header to be set in the message. Any message type is valid. Optional. |
| messageVersion | The message version header to be set in the message. Any message version is valid. Optional |
| redeliveryFlag | The redelivery flag header to be set in the message. Valid values are true and false. Optional. |
| sentFrom | The sent from header to be set in the message. Value is alphanumeric. Optional. |
| sentTimestamp | The sent time stamp header to be set in the message. Optional |
| replyTo | The reply to header to be set in the message. Value is alphanumeric. Optional. |
| sequenceTotal | The sequence total header to be set in the message. Value is numeric. Optional. |
| sequenceNumber | The sequence number header to be set in the message |
| receivedTimestamp | The received time stamp header to be set in the message. Value is numeric. Optional. |
| expirationTimestamp | The expiration time stamp header to be set in the message. Optional. |
| priority | The priority header to be set in the message. Value is numeric. Optional. |
| errorDestination | The error destination header to be set in the message. Value is alphanumeric. Optional. |
| failoverDestination | The failover destination header to be set in the message. Optional. |
| appContextMember | The application context member. Value is alphanumeric. Optional. |
| appContextComponent | The application context component. Value is alphanumeric. Optional. |
| appContextServiceInstanceName | The application context service instance name. Value is alphanumeric. Optional. |
| transactionID | The Transaction identifier. Value is alphanumeric. Optional. |
| processID | The process identifier. Value is alphanumeric. Optional. |
| referenceId | The reference identifier. Value is alphanumeric. Optional. |
| eventDateTime | The event date time. Value is a formatted string that is defined by the property “date.format.pattern” in msgfabric.properties.in. Optional. |
| eventAction | The event action. Value is from a predefined selection list. Required. |
| eventStatus | The event status. Value is from a predefined selection list. Required. |
| eventData | The event data. Value is alphanumeric. Optional. |
| customText | The custom text for the message. Value is alphanumeric. Optional. |
| isProcessing | Whether the adapter is processing. Values are true or false. Optional. |
| isFinal | Whether the event is the last in the transaction. Values are true or false. Optional. |
| exchangeProfileID | The exchange profile identifier in AS4 Microservice. Value is alphanumeric. Optional. |
| exchangeRefSenderAlias | The exchange reference sender alias. Value is alphanumeric. Optional. |
| exchangeRefReceiverAlias | The exchange reference receiver alias. Value is alphanumeric. Optional. |
| exchangeRefLookupAlias | The exchange reference lookup alias. Value is alphanumeric. Optional. |
| extRefKey1 … <N> | The extension reference key. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| extRefValue1 … <N> | The extension reference value. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| extRefAuditable1 … <N> | The extension reference auditable data. It is possible to define multiple if each is suffixed with unique sequence number. Value is from a predefined list. Optional. |
| storRefStorageID1 … <N> | The storage reference storage ID. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| storRefFileName1 … <N> | The storage reference file name. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| storRefEncoding1 … <N> | The storage reference encoding. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| storRefMimeType1 … <N> | Storage reference mime type. It is possible to define multiple if each is suffixed with unique sequence number |
| storRefIsPrimary1 … <N> | Whether the storage reference IsPrimary. It is possible to define multiple if each is suffixed with unique sequence number. Value is from a predefined list. Optional. |
| storRefIsInline1 … <N> | Whether the storage reference IsInline. It is possible to define multiple if each is suffixed with unique sequence number. Value is from a predefined list. Optional. |
| storRefContentID1 … <N> | The storage reference content identifier. It is possible to define multiple if each is suffixed with unique sequence number. Value is alphanumeric. Optional. |
| rawData | The raw data. Value is alphanumeric. Optional. |
| rawDataEncoding | The raw data encoding. Value is alphanumeric. Optional. |