Adding new user exits

You can add user exits so that you can manage calls to external programs during process flows for receivers and destinations.

Before you begin

You must develop, test, and deploy your user exit OSGi bundles on AS4 Microservice before the user exits can be added. After the user exits are added, they are available to start in either Pre-process, Post-process, Pre-delivery, or Post-delivery process flows.

About this task

To add new user exits:

Procedure

  1. Log in to AS4 Microservice.
  2. Click Exchanges and select User Exits.
  3. On the User Exits collection page, click New.
  4. On the New User Exit 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 or destination 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 impact the 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 impact the 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.
    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 impact the 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 impact the 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.
  5. Click Save. The new user exit is now listed on the User Exit Collection page.

What to do next

You can now configure and manage this user exit for AS4 receivers, messaging receivers, HTTP or HTTPS destinations, and messaging destinations.