Deploying user exits

To deploy your user exit OSGi bundle, you must use commands to load, configure, restart, and verify the deployment of the user exit.

Before you begin

You must develop, debug, assemble, deploy, and test your user exit Open Services Gateway Initiative (OSGi) bundles. Your OSGi bundle must include at least one of the available user exit Java™ APIs and export that user exit API as an OSGi service. The development and maintenance of user exits is your responsibility.
Restriction: You must have administrative user authorization to run the user exit commands.

About this task

To deploy user exit OSGi bundles:

Important: You must repeat this procedure for each node that requires this user exit.

Procedure

  1. Locate the bin directory.
  2. To load your user exit OSGi bundle into the data grid, type execute user_exit load <path to userexit_bundle.jar>
  3. To deploy your user exit OSGi bundle on your current node, type execute user_exit config <userexit_bundle-SymbolicName>|all
    Important: If you update an existing user exit on the system, you must restart the member.
  4. Optional: Restart the member:
    1. To stop the member, type execute member stop operational
    2. To start the member, type execute member start operational or execute member start_service operational
  5. Optional: To verify your user exit deployment, type execute user_exit list
  6. Optional: To indicate the specific implementation of your authentication user exits, update the service ID in the SystemConfigurationSYSLoader.properties file.
    1. Locate the Members\resources\config installation directory.
    2. Edit the SystemConfigurationSYSLoader.properties file with the unique service ID.
      USEREXIT_AUTHENTICATION_OUTBOUND_SERVICEID
      Outbound service ID for authentication. Unique identifier that must start with a letter or an underscore and it cannot contain spaces or special characters.
      USEREXIT_AUTHENTICATION_INBOUND_SERVICEID
      Inbound service ID for authentication. Unique identifier that must start with a letter or an underscore and cannot contain spaces or special characters.
    3. To load the updated properties file in the system, type execute config load all

What to do next

You can now manage and configure your user exits in the process flows for AS4 receivers, messaging receivers, HTTP or HTTPS destinations, and messaging destinations. Authentication user exits are configured in the process flows for conformance policy and exchange profiles.

Tip: To edit deployed user exit OSGi bundles, type execute user_exit export <userexit_bundle-SymbolicName> <directory location for exported files>. You can then edit the OSGi bundle locally and modify, debug, and test before you deploy the modified OSGi bundle again.