Scenario: Configuring user exits in AS4 receivers

To configure AS4 receivers with user exits, you must deploy the user exit OSGi services that you developed with the provided user exit APIs.

1. Log in to AS4 Microservice.
2. Click Exchanges and select Receivers.
3. On the Receivers page, click New and select AS4.
4. On the New Receiver page, specify values for the following fields:

   Name

   Type a unique name for the AS4 receiver.

   Description

   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 /test-uri. The AS4 service URI is unique for each AS4 receiver.

   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/server IP>:<http server port from UI>/<AS4 Receiver URI from UI>
   Port Number: 63000
   URI: /test-uri
   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

   Specify the 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. If the size limit is not specified, the AS4 receiver does not reject any messages because of the message size.

   Payload Threshold Size

   Specify the 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.

   Restriction: You must develop and deploy your user exit OSGi bundles on the system before you add a user exit to a receiver.
5. To add a user exit, click Add New User Exits.
6. 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.

7. Click Save. The new user exit is now listed on the User Exit Collection page.
   Remember: If the user exits you developed are already in the User Exit Collection page, you can select the appropriate user exit from the New Receiver page Select User Exits drop-down.
8. Optional: 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.
9. Click Save to save the AS4 receiver configuration.