Configuring a messaging destination

In AS4 Microservice, a messaging destination is used to send unpacked messages or responses (received from a trading partner) to the business application over a message fabric queue. A message exchange is completed when the unpacked message or response is sent to the business application over a message fabric queue. Additionally, a messaging destination is used to send success and failure notifications (about a message exchange) to the business application.

Before you begin

You also can import a destination as a resource from another installation of AS4 Microservice. For more information, see ../reference/as4/meg_resource_commands.html.

About this task

A messaging destination must be associated with a message queue definition. Ensure that you have created the required message queue definition before creating a messaging destination.

Procedure

To create a messaging destination, complete the following steps.

  1. Log in to AS4 Microservice as the Master Account Administrator.
  2. Click Exchanges > Destination.
  3. On the Destinations page, click New and select Messaging.
  4. On the New Destination page, specify values for the following fields:
    Field Description
    Associated Organization Click Select and select the owner organization with which the messaging destination is associated.
    Name Specify a unique name for the messaging destination.
    Description Optional: Type a description for the messaging destination.
    Timeout Optional: Specify the number of seconds AS4 Microservice waits to send a message to the business application or receive a response from the business application before failing the transaction.

    The configuration of the Timeout field applies to both send timeout and receive timeout.

    Send timeout - AS4 Microservice waits for the time that is specified in the Timeout field to send the message to the messaging destination before timing out and failing the transaction. AS4 Microservice might fail to send a message to the messaging destination because the messaging queues (associated with the messaging destination) may be full.

    Receive timeout - In a two-way synchronous message exchange, the response from the business application is received on the same channel that is used to send the message. Therefore, the response from the business application is received on the messaging destination itself and not on the messaging receiver (like the other message exchange patterns). AS4 Microservice waits for the time that is specified in the Timeout field to receive a response from the business application before timing out and failing the transaction.

    When you are exchanging large documents, in which case the business application might take more time to process the message and send a response, specify a longer timeout value.

    Message Queue Select the message queue to associate with the messaging destination. AS4 Microservice sends the unpacked message to the business application through the message queue definition that is associated with the messaging destination.
    Queue overriding Optional: Select the Allow queue to be overriden check box to override the queue that is specified in the messaging destination. You might choose to override the queue to route the messages to another queue based on user exits.

    To override a queue, appropriate user exits must be configured. For more information about configuring user exits for overriding a queue, refer Configuring user exits to override a messaging queue.

    Usage From the list, select the option for which the queue is used:
    • Data (default) - The queue is used for transferring message data.
    • Notifications - The queue is used for sending notifications to the business application.
    User Exits Optional: User exits provide a call to an external program during the ebMS process flow of an AS4 destination message. You must develop user exits with the provided user exit Java APIs and deploy the OSGi bundles with the user exit commands.
    To add a user exit, click Add New User Exit. On the New User Exits page, specify values for the applicable fields as follows:
    Name
    Name of the user exit.
    Description
    Description of the user exit.
    Service ID
    Unique identifier that must start with a letter or an underscore and it cannot contain spaces or special characters.
    Exit point
    Point in the destination process flow when the user exit is started.
    Pre-delivery
    With the Pre-delivery value selected, the user exit is started before the message enters the destination process flow. User exits started in Pre-delivery can have a negative impact on performance and slow the progress of the messages through the system. You must include performance testing of your OSGi user exit bundles as part of your user exit development process.
    Post-delivery
    With the Post-delivery value selected, the user exit is started after the message exits the destination process flow. User exits started in Post-delivery can have a negative impact on performance and slow the progress of the exiting messages through the system. You must include performance testing of your OSGi user exit bundles as part of your user exit development process.
    Click Save. The new user exit is now listed on the User Exit Collection page.

    To select a user exit from the User Exit Collection page, click Select User Exits and select the appropriate Pre-delivery or Post- delivery user exit from the drop-down.

  5. Click Save to save the messaging destination configuration. The messaging destination is automatically deployed when you save the configuration.