Developing a user exit

To develop a user exit, follow these steps:

  1. Declare the user exit.

    Declare a user exit by using the bipInitializeUserExits function to specify the following properties:

    1. Name (used to register and control the active state of the exit)
    2. User context storage
    3. A function to be invoked (for one or more Event Types)
  2. Implement the user exit behavior.

    When the user exit is declared, a set of functions is registered, and these functions are invoked when specific events occur. The behavior of the user exit is provided by implementing these functions. The following table lists the events and their associated functions:

    Event Function
    Message dequeued from input source cciInputMessageCallback
    Message propagated to node for processing cciPropagatedMessageCallback
    Node completed processing cciNodeCompletionCallback
    Transaction ended cciTransactionEventCallback
  3. Your user exit code must implement the cleanup function.

    The user exit library must implement the bipTerminateUserExits function. This function is invoked as the ExecutionGroup's process is ending, and your user exit must clear up any resources allocated during the bipInitializeUserExits function.

  4. Start of changeCompile.

    Use your existing process for your environment to compile your user exit. The supported C compilers are shown in Optional software support. See Compiling a C user-defined extension for more details.

    End of change
Related concepts
User exits
Related tasks
Deploying a user exit
Exploiting user exits
Related reference
mqsicreatebroker command
mqsichangebroker command
mqsireportflowuserexits command
mqsichangeflowuserexits command