Messages

Messages are delivered to Connect via external queues or from Advantage internal events. Payload is in JSON format.

Connect comes pre-configured with many Message Names, which are used for importing a transaction. In general, any Transaction Type for which the Import Web Service operation is supported, a message name is also pre-configured to allow external clients to send a message via a queue, rather than invoking Rest API. For example, the “PRrequestRootEntity” Message Name is pre-configured for the import of a Payment Request Transaction ID.

The Messages (CMESGS) page allows administrators to create/view/edit existing Message Names. It also allows them to configure the Message Names by Source Application. It has two tabs: Message and Message by Source App. The following table provides detail on each field on these two tabs:

Field	Description
Message
Message Name	Indicates the Message Name.
Description	Description for the message name.
Source Application	It is mandatory and must be a valid Source Application for current tenant.
Status	If set to Active, any client can send this message unless it is overridden at the Source Application level. If set to Inactive, no client can send this message unless it is overridden at the Source Application level.
Format	Format is either JSON or XML. Note: All existing messages are supported in JSON format only. XML is being allowed for future scenario that requires XML formatted message.
Orch Service Name	Indicates the Orchestration Service Name that process the service requests for this message. It can be overridden at Source Application level.
Preserve Message Order?	A value of Yes indicates that the messages received for same key values are processed in the order they are received, one at a time. Order is preserved even if messages were received on different external listeners. A value of No indicates messages received for same key values may be processed in parallel. This may cause problems if sequential processing of messages with same key values is important because Connect is a multi-threaded application.
Key Tags	It is mandatory, if the Preserve Message Order flag is set to Yes. Provide comma separated field names. Note that field names are case-sensitive and do not use any spacing before or after comma.
Tran Type	Some message names are specific to an Advantage Transaction Type. For example, message name “CRrequestRootEntity” has a Tran Type of CR. Similarly, some messages are not specific to any Advantage Transaction Type. For example, message name “advEventJobCompleted” is not specific to any Transaction Type.
Message Name by Source App
Source Application	It is mandatory and must be a valid Source Application for current tenant. It cannot be updated.
Status	If set to Active, a client corresponding to the Source Application can send this message. If set to Inactive, a client corresponding to the Source Application cannot send this message.
Orch Service Name	Indicates the Orchestration Service Name that process the service requests for this message. When configuring message name by Source Application, set this field to the same value configured for the message in baseline. Note: A different Orchestration Service Name can be entered but that usually involves development effort to develop a new Orchestration Service.

Please refer to the CGI Advantage Connect - Configuration & Management Guide for more information on this page.