Creating a business transaction definition

Create a business transaction definition in the App Connect Enterprise web user interface, by specifying message flows and defining business events in an associated business transaction policy.

Before you begin

About this task

The business transaction definition contains information about the flows that participate in the transaction and the events that are monitored during the transaction. This definition includes information such as which events mark the beginning and end of a transaction, which events indicate that the transaction is in progress, and which events correspond to a failure in the transaction.

Procedure

To create a business transaction definition, complete the following steps:

  1. Access the web user interface, as described in Accessing the web user interface.
  2. Click the Business transactions icon to display the Business Transactions view for the integration server or integration node.
    The Business transactions icon is located in the side navigation links in the web user interface.
    screen capture of the IBM App Connect web user interface showing Business transactions option selected
  3. In the Business Transactions view, click the Configure tab.
  4. In the Configure tab, click Create a transaction definition.
    The Create a business transaction definition panel is displayed.
  5. Enter a name for the business transaction in the Name field.
    The name of the business transaction must be unique for the integration server. The name can contain only letters, numbers, and underscore (_) characters.
  6. In the Policy project field, either select the policy project that will contain the business transaction policy for the new business transaction definition, or click Create new policy project and enter the name of a a new policy project.
  7. In the Policy field, select the name of the business transaction policy in which the business events will be defined, or click Create new policy and enter the name of a new policy.
  8. Click Create to create the new business transaction definition and, if applicable, a new business transaction policy.
    A new business transaction definition is created in the stopped state.
  9. Add a new business event to the business transaction policy, by clicking Create an event.
    The Create a business event panel is displayed.
  10. Enter the name of the business event in the Name field, and then select the event type that identifies the start, end, failure, or progress of the event, from the Type field:
    • A start business transaction event signifies that when a message is received on that node, the business transaction starts. You can choose any monitoring event to represent the start of a business transaction.
    • An end business transaction event signifies that when a message is received on that node, the business transaction is complete. You can choose any monitoring event to represent the end of a business transaction.
    • A failure business transaction event typically corresponds with a node that handles error processing. This event signifies that when a message reaches this node, the business transaction has failed.
    • A progress business transaction event can correspond with any type of node in a message flow. This event is used to monitor the progress of a transaction instance and signifies that a message has reached a particular node in the flow.

    Each business transaction definition requires a start event and an end event (in addition to any progress or failure events), and a warning message is displayed if they have not been defined. A warning message is also displayed if the flows have no monitoring events defined, or if no global transaction ID has been specified for the events.

  11. When you have specified the name and type of the business event, specify the monitoring event that will be used for the business event, by selecting an integration, library, message flow, and monitoring event source, in the Create a business event panel. Then click Create.

    The business event is defined in the business transaction policy, and is displayed in the event definitions table for the business transaction definition.

  12. Repeat steps 9, 10, and 11, until you have defined all the business events for your business transaction definition.

What to do next

Start the business transaction definition, as described in Starting and stopping a business transaction definition. You can then view the results of a business transaction on the Monitor tab, as described in Viewing the results of business transaction monitoring.