Configuring an AS4 receiver

An AS4 receiver is a configurable endpoint for receiving data from a trading partner. The AS4 receiver is a bridge between the transport protocol (HTTP or HTTPS) and AS4 Microservice.

Before you begin

You also can import a receiver as a resource from another installation of AS4 Microservice. For more information, see Resource Commands.

You must configure an HTTP or HTTPS server and a thread pool before configuring an AS4 receiver.

About this task

You must create an AS4 receiver to receive messages from a trading partner. Depending on your requirements, you can create multiple AS4 receivers for a single trading partner or use a single AS4 receiver for multiple trading partners.

Restriction: If you receive the high watermark event, BCXCH111W, which indicates high grid memory, active AS4 receivers immediately cease to accept any incoming messages for processing. The associated HTTP server is quiesced so that messages that are already accepted can be processed. Only after the memory clears and falls below the low watermark, can the AS4 receiver accept new messages.

Procedure

To create an AS4 receiver, complete the following steps.

  1. Log in to AS4 Microservice. You must have Master Account Administrator permissions to create an AS4 receiver.
  2. Click Exchanges > Receivers.
  3. On the Receivers page, click New and select AS4.
  4. On the New Receiver page, specify values for the following fields:
    Field Description

    Name

    Type a unique name for the AS4 receiver.

    Description

    Optional: Type a description for the AS4 receiver.

    AS4 Service URI

    Type the AS4 service URI. An HTTP or HTTPS server identifies an AS4 receiver by the service URI of the receiver.

    The AS4 service URI must start with a forward slash, followed by the address or path. For example, /test-uri. The AS4 service URI is unique for each AS4 receiver. You must have unique URI for SSL and non-SSL connections.

    Enable delivery assurance via WS-Reliable Messaging

    Optional: Select the Enable delivery assurance via WS-Reliable Messaging check box to receive web services reliable messaging (WSRM) control messages.

    If the check box is not selected and if your trading partner sends WSRM control messages such as create, close and terminate sequences, the AS4 receiver rejects the messages.

    Host server

    Select a host server (HTTP or HTTPS server) on which you want the AS4 receiver to be available.

    When a host server receives a message, it checks the AS4 service URI and routes the message to the specified AS4 receiver.

    The unique resource locator (URL) format for the AS4 receiver must be in the following format: http://<hostname/IP of the server machine>:<http sever port created from UI>/<AS4 Receiver URI created from UI>

    For example, if the port number of the HTTP (or HTTPS) server that you have associated with the AS4 receiver is 63000, and the URI of the AS4 receiver is /test-uri, then the URL of the AS4 receiver must be http://hostname:63000/test-uri.

    Thread pool

    Select a thread pool.

    A thread pool is a collection of threads. A thread pool manages the threads in the pool to process the tasks. To handle large volumes of files or large files, you can create a thread pool with more number of threads and associate the thread pool to the AS4 receiver.

    Request Size Limit

    Optional: Specify a size limit for inbound messages. If the messages that are received exceed the specified limit, the AS4 receiver rejects the messages.

    The default is blank. The AS4 receiver does not reject any messages because of the message size if the size limit is not specified.

    Payload threshold size

    Optional: Specify data storage options for the payload.

    If the size of the payload exceeds the threshold size, the payload is stored in storage and a reference to the payload is provided in the message.

    If the size of the payload is equal to or less than the threshold size, the payload is transferred inline with the message.

    User exits

    Optional: User exits provide a call to an external program during the ebMS process flow of an AS4 receiver 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 Exits. 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 receiver process flow when the user exit is started.
    Pre-process
    With the Pre-process value selected, the user exit is started before the message enters the receiver process flow. User exits started in Pre-process 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-process
    With the Post-process value selected, the user exit is started after the message exits the receiver process flow. User exits started in Post-process 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-process or Post- process user exit from the drop-down.
  5. Click Save to save the AS4 receiver configuration. The AS4 receiver is automatically started when you save the configuration.