Updating a business transaction definition

Update a monitoring definition in the web user interface by adding or removing message flows on the canvas and then adding, removing, or modifying events.

Before you begin

  • Ensure that the message flows that are included in your business transaction are created and deployed.
  • Ensure that monitoring events are attached to the appropriate message flow nodes, and that the correlation information is set correctly. To be part of a business transaction, a flow must have an event for which a global transaction ID is defined. For more information, see Configuring monitoring event sources by using monitoring properties.

About this task

This topic shows the recommended method of updating business transaction definitions by using the web user interface; however, you can also edit them directly by using a text editor. If you create a business transaction definition that contains flows on one integration node but then move to a different integration node, you must edit the business transaction definition file directly to reflect this change. For more information about the format of business transaction definitions, see Example business transaction definition.

Procedure

To update a monitoring definition, complete the following steps:

  1. Access the web user interface, as described in Accessing the web user interface.
  2. In the Navigator view, for the relevant integration node, expand Business, then Business Transactions.
  3. Click the arrow next to Business Transactions, then click the name of the business transaction that you want to modify. The flows that are included in the business transaction are displayed in the Define tab.
    You can view the name and description of the business transaction by clicking the Business Transaction Details icon: Business transaction definition icon. The monitoring events that are relevant to your business transaction are shown in this information pane. You can also view this information by clicking Details.
  4. You can now update the business transaction definition by adding or removing the appropriate message flows to the business transaction. 
    Use one of the following methods to add message flows:
    • In the Business Transaction section, click Add flow, select a flow from the list of available flows, or select all flows in a selected application, then click Add.
    • In the web user interface Navigator, expand Servers, then drag message flows from an application or from the Resources folder of the relevant integration server onto the canvas.
    You cannot add two message flows with the same name from the same integration server. However, you can add two message flows with the same name from different integration servers. To distinguish between flows with the same name, hover the cursor over each flow to view the full path of that flow, including the integration server name.

    If you need to remove a message flow from your definition, select the flow, then click Remove flow.

  5. View the nodes and connections in a flow by selecting the flow in the Business Transaction section and expanding the Message Flow section. The Message Flow section shows symbols on the nodes that have monitoring events.
  6. Click a symbol in the Message Flow section to see a tooltip with a definition of the monitoring events for the node. Click the icon in the tooltip to navigate to the appropriate event definition in the table.

    When you select a flow in your business transaction, the Event Definitions table shows the monitoring events that are defined for that flow. If you click the white space around the flows in the Business Transaction section, the table shows all flows in the business transaction. Expand a flow to see the monitoring events that are defined for that flow.

  7. Flag the monitoring event definitions that represent the start, end, failure, and progress of your business transaction.
    1. In the Event Definitions table, expand the appropriate flow and identify an appropriate monitoring event.
    2. In the Flag As column for that monitoring event, select Start, End, Failure, or Progress.
      • A start business transaction event typically corresponds with an input node in a message flow. This event signifies that when a message is received on that input node, the business transaction starts.
      • An end business transaction event typically corresponds with an output node in a message flow. This event signifies that when a message reaches the end of that flow, the business transaction is complete.
      • 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.

      Relevant symbols are added to the flow in the Message Flow section. Monitoring events that are set to Do not flag are not stored in the business transaction definition.

    3. Click or hover over the symbols to see what business events are defined for each flow.
      The Business Transaction Definition icon also lists the business events for the business transaction.
  8. Save the updated business transaction definition by clicking Save.

Results

The updated business transaction definition is shown in the Navigator view, under Business > Business Transactions.

What to do next

View the results of a business transaction on the View tab (see Viewing the results of business transaction monitoring).