Scenario: Configuring user exits in AS4 destinations

To configure AS4 HTTP or HTTPS destinations with user exits, you must deploy the user exit OSGi services that you developed with the provided user exit APIs.

Before you begin

Destination user exits are optional and provide a call to an external program during the ebMS process flow of a message. To develop the optional user exits, you must be an experienced programmer in Java™, Open Services Gateway Initiative (OSGi) services, and OSGi bundles. The public user exit Java APIs must be exported as an OSGi service in your OSGi bundle.
Restriction: You must deploy the user exit OSGi services that you developed on the same node as the destination you are configuring.

About this task

To create a new destination with the user exits you developed and deployed:

Procedure

  1. Log in to B2B Advanced Communications.
  2. Click Exchanges and select Destination.
  3. On the Destinations page, click New and select HTTP/S.
  4. On the New Destination page, specify values for the applicable fields as follows:
    Associated Organization
    Select the organization with which you want to associate the destination.
    Name
    Type a name for the destination.
    Description
    Type a description for the destination.
    Service URL
    Type a service URL. Service URL is the URL of the trading partner destination to where B2B Advanced Communications delivers the payload in an outbound transaction.
    URL overriding
    To override the HTTP or HTTPS destination that is specified the exchange profile, select the URL overriding check box and use the HTTP or HTTPS destination that is specified in the DestinationAddress element of the business document object (BDO), sent by the business application.

    When you select to override the URL, the HTTP or HTTPS destination URL that is specified in the exchange profile is replaced with the HTTP or HTTPS destination URL specified in the BDO in the AS4 message that is sent.

    Based on the agreement with your trading partner, you can choose to override a URL when you are sending a message to a gateway that in turn routes the message to the actual trading partner destination. With the URL overriding function, it is not required for you to configure multiple trading partner profiles in B2B Advanced Communications.

    Basic authentication
    To enable basic authentication at the HTTP or HTTPS transport level, select the Enable basic authentication check box.

    To add a credential for authentication, click Add credential.

    To select a credential, click the Credential drop-down list.

    The user name and password is owned by the trading partner organization and provided to the owner organization outside the scope of B2B Advanced Communications.

    SSL Certificate
    To add a trading partner certificate that can be used for HTTPS client authentication, click Add Trading Partner Public Certificate.
    SSL connection options
    To use a specified certificate in the global truststore to secure the connection with the destination, select Use the global trust store.

    To add a CA certificate to secure the connection with the destination, select Select the Root/Intermediate certificates or a self-signed certificate to use.

    Connection timeout
    To indicate the number of seconds that B2B Advanced Communications waits for a response from the HTTP or HTTPS destination before the connection times out, type the number of seconds.
    Thread pool
    To optimize the task execution when delivering to a destination, select the thread pool to be used by B2B Advanced Communications.
    Retry policy
    To specify the retry policy retransmission options for the destination, select the retry policy to be used by B2B Advanced Communications.
    Payload threshold size
    The payload threshold size setting in the HTTPS destination is applied for a response that is received from the trading partner.

    If the size of the response payload is more than the threshold size, the payload is stored in storage and a reference is provided in the response.

    If the size of the response payload is equal to or less than the threshold size, the payload is sent to the business application inline with the response.

    The payload threshold size settings are applicable for AS4 messages only.

    Restriction: You must develop and deploy your user exit OSGi bundles on the system before you add a user exit to a destination.
  5. To add a user exit, click Add New User Exit.
  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 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.
  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-delivery or Post-delivery user exit from the drop-down.
  9. Click Save to save the HTTP or HTTPS destination.

What to do next

Your new HTTP or HTTPS destination is now listed on the Destinations Collection page.
Tip: To change destination properties, click the server name on the Destinations page, and click Edit next to the property you want to change.