Contact Us 1-800-596-4880
  1. Homepage
  2. Mule Runtime (4.1)
  3. Core Components

  4. Custom Business Event Component

Custom Business Event Component

Standard Support for Mule 4.1 ended on November 2, 2020, and this version of Mule reached its End of Life on November 2, 2022, when Extended Support ended.

Deployments of new applications to CloudHub that use this version of Mule are no longer allowed. Only in-place updates to applications are permitted.

MuleSoft recommends that you upgrade to the latest version of Mule 4 that is in Standard Support so that your applications run with the latest fixes and security enhancements.

Use the Custom Business Event component (tracking:custom-event element in the XML view) to add metadata and Key Performance Indicators (KPIs) to your flow. Configure the component as follows:

  1. Click the Mule Palette tab in Anypoint Studio.

  2. Drag Custom Business Event to any point of your flow.

  3. Open the component properties view and specify values for Display Name and Event Name:

    custom-business-event

You can also configure Key Performance Indicators (KPIs) to capture information from the message payload:

  • In the UI:

    1. Click the plus button (2%) inside Key Performance Indicators.

    2. Configure Name and Expression / Value:

      business-events-kpi

  • In the XML:

    1. Add a child tracking:meta-data element to the tracking:custom-event.

    2. Configure the key and value attributes inside tracking:meta-data:

      For example:

      <tracking:custom-event doc:name="Custom Business Event" event-name="New order">
			<tracking:meta-data key="order-id" value="#[payload.order.header.orderID]" />
</tracking:custom-event>

For you KPIs, use names that are easy to search for in the Anypoint Runtime Manager interface, and use a representative value, which can be any Mule expression:

Name Expression / Value

employee-id

#[payload['ID']]

employee-email

#[payload['Email']]

employee-git-id

#[payload['GITHUB_ID']]

price

700

price-after-discount

#[vars.price]

order-id

#[payload.order.header.orderID]

See Also

Business Events