Press CTRL+K to open search

Managing business processes

  • 7 minute(s) read
Prev Next

Overview

Business processes in the Custom Logging type of Business Activity Monitoring (BAM) are created and managed from the tree view or the Actions dropdown on the BAM homepage. This article covers all lifecycle operations: creating, editing, deleting, importing, exporting, cloning, enabling and disabling tracking and monitoring, configuring message archival, and interpreting the health indicator.

Business value

Managing business processes directly in Turbo360 keeps your tracking configuration aligned with your Azure integration workflows without requiring portal context-switching. Cloning lets you replicate proven configurations across projects; import and export let you migrate or back up process definitions; health indicators give you at-a-glance operational status from incident data.

Prerequisites

  • A BAM environment deployed with Custom Logging type
  • Contributor role or higher

Required permissions

Operation Permission required
View business processes View business process
Create, edit, or delete a business process Manage business process
Import a business process Manage business process
Clone a business process Manage business process
Export a business process View business process
Enable or disable tracking Manage transaction instance
Enable or disable monitoring Manage monitor settings
View saved queries View saved queries
Manage saved queries Manage saved queries
Reprocess transaction instances Reprocessing
Manage message payload Manage payload
Manage transaction instances Manage transaction instance
View global properties View global properties
Manage global properties Manage global properties

How it works

Each business process is identified by a tracking name (used for runtime data correlation) and a friendly name (displayed in the tree view). Processes are organized into business process groups in the tree view. Configuration options, including purge policy, message archival, and monitoring settings, are accessible from the Context menu ( ⋮ ) on each process.

Health status is derived from alert incidents over the past 24 hours and follows the priority order: Error < Warning < Healthy < Not Monitored.

Steps

Use the following steps to create, edit, delete, import, export, and clone business processes. Navigate to Business Activity Monitoring in the tree view to get started.

Create a business process

Creating a business process establishes the top-level tracking container for a Custom Logging workflow.

  1. Click the Actions dropdown on the homepage and select Create Business Process, or click the Context menu ( ⋮ ) next to any business process group in the tree view and select New Business Process.
  2. Enter a Tracking name: this name identifies the process when correlating runtime data and must be unique across the BAM module.
  3. Enter a Friendly name: this is the display name for the process within Turbo360 and must be unique within the business process group.
  4. Optionally, configure a purge policy to automatically purge archived messages and transaction instances older than a specified number of days.
Note:

The purge policy option is available only in the Custom Logging type of BAM.

  1. Configure any Optional settings as needed, then click Save.

Edit and delete a business process

Editing lets you update the name and description of a business process; deleting removes it permanently along with all tracked data.

  1. Click the Context menu ( ⋮ ) next to the business process in the tree view.
  2. Select Edit to update the tracking name, friendly name, or description, then save your changes.
  3. To delete, select Delete from the Context menu ( ⋮ ), then confirm.

All tracked transactions, dashboards, and configurations become inaccessible once a business process is deleted. This action is irreversible. Export the business process before deleting.

Import a business process to a business group

Importing lets you load a previously exported business process definition from a JSON file.

Note:

Importing a business process requires the Manage business process permission.

  1. Click the Context menu ( ⋮ ) next to the target business process group in the tree view, then select Import.
  2. In the file dialog, select the downloaded business process JSON file, then click Open.
  3. From the list, select the business processes you want to import.
  4. Enter a unique tracking name to avoid data conflicts.
  5. To auto-generate tracking names for all selected processes, enable Import all the Business Process tracking names dynamically.
  6. Click Import.

Export a business process

Exporting saves one or more business process definitions to a JSON file for backup or migration.

  1. Click the Context menu ( ⋮ ) next to the business process group in the tree view, then select Export.
  2. Select the business processes to export.
  3. Click Export.
  4. Enter a Name for the JSON file.
  5. Click Export to download.
Note:

If you don't enter a name, an auto-generated name based on the current date and time is assigned.

Clone a business process

Cloning creates a copy of a business process, including its transactions and stage configurations, as a starting point for a new process.

Cloning is available only in the Custom Logging type of BAM. The Manage business process permission is required.

  1. Click the Context menu ( ⋮ ) next to the business process in the tree view, then select Clone.
  2. Enter a Tracking name (unique at the BAM module level) and a Friendly name (unique within the target business process group).
  3. Select the business process group where the clone should be placed.
  4. Click Next to reach the optional Reprocess configuration step, where you can edit or remove reprocess configurations for transaction stages before cloning.
  5. Click Clone.
  • The tracking name must be unique at the BAM module level; the friendly name must be unique within the target business process group.
  • You can also clone a business process from the Actions dropdown on the homepage.

How it works

Enable and disable tracking and monitoring

By default, both monitoring and tracking are enabled for every business process.

  • To disable query and exception monitoring without disabling data tracking, click the Context menu ( ⋮ ) next to the business process and select Disable monitoring.
  • To stop tracking data for the business process entirely, select Disable tracking from the Context menu ( ⋮ ).
  • To re-enable either, select Enable tracking or Enable monitoring from the Context menu ( ⋮ ).
Note:

To disable tracking at the entire BAM module level, add the following app setting to the BAM Function app (e.g. bam-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-fnapp): DisableTracking -> true

The Disable tracking option is available only in the Custom Logging type. Monitoring status can be toggled in both Custom Logging and Data Queries types.

Archive messages

Message archival records the payload at each transaction stage. It is available only in the Custom Logging type of BAM.

Message archival can be controlled at two levels:

Runtime level: Pass the BAM-ArchiveMessage header as true in the Logic App custom connector action or .NET Library checkpoint call to enable archival for that stage.

Business process level: Use the Override runtime BAM configuration toggle in business process settings to override the runtime header.

Messages are archived when:

  • Override Runtime BAM Configuration and Archive messages are both enabled.
  • Override Runtime BAM Configuration is disabled and the BAM-ArchiveMessage header is passed as true at runtime.

Messages are not archived when:

  • Override Runtime BAM Configuration and Archive messages are both disabled.
  • Override Runtime BAM Configuration is disabled and the BAM-ArchiveMessage header is not passed or is false.

Purging policy

A purge policy automatically deletes archived messages and transaction instances older than a configured number of days. This configuration is available only in the Custom Logging type of BAM.

You can set a purge policy when creating a business process or modify it during an edit. Enabling Apply purge policy to all existing transaction(s) after save applies the configured purge duration to all transactions within the business process.

Health indicator

The health status shown next to a business process in the tree view reflects alert incidents from all monitor types over the past 24 hours. The status hierarchy is: Error < Warning < Healthy < Not Monitored.

Manually closing all active incidents within the 24-hour window updates the business process status to Healthy.

Limitations

  • Purge policy, message archival, cloning, and the Disable tracking option are available only in the Custom Logging type.
  • Deleting a business process is irreversible. All tracked transactions, dashboards, and configurations are permanently removed.
  • Tracking name must be unique at the BAM module level; changing it after data has been ingested may cause correlation gaps.

Troubleshooting

  1. Actions dropdown is not visible
    Cause: The user does not have the required Manage business process permission.
    Fix: Request a role assignment with Manage business process permission from your administrator.

  2. Import fails with a tracking name conflict
    Cause: The imported business process uses a tracking name already in use at the BAM module level.
    Fix: Provide a unique tracking name during the import dialog, or enable Import all the Business Process tracking names dynamically to auto-generate names.

  3. Health indicator shows Error but no active alerts are visible
    Cause: Alert incidents from the past 24 hours may still be open even if the underlying issue is resolved.
    Fix: Manually close all active incidents from the Alert history view to reset the health indicator to Healthy.

  4. Archived messages are not appearing after enabling archive
    Cause: The BAM-ArchiveMessage header may not be passed correctly at runtime, or Override Runtime BAM Configuration settings conflict with the runtime header.
    Fix: Confirm the header value is true in the Logic App action or .NET Library call, and verify the business process-level override settings are configured as intended.

  5. Disable tracking option is not visible
    Cause: The business process uses the Data Queries type; the Disable tracking option is available only in Custom Logging.
    Fix: Confirm the BAM deployment type. If you need to stop data ingestion in a Data Queries environment, consult your BAM administrator.

Related articles