Assign Business Identifiers for Tracking Fields in Messages

This section describes how to manage business identifiers that enable you to track fields in messages during runtime.

Topics:

• Assign Business Identifiers

• Delete Business Identifiers

Assign Business Identifiers

Business identifiers enable you to track payload fields in messages during runtime. You can specify up to three business identifier fields for tracking during design time. One of these fields must be selected as the primary business identifier field. The primary business identifier enables you to track fields across integration flows during runtime, and is always available. At runtime, the status of business identifiers is visible on the Track Instances page and (if integration errors have occurred) the Errors page. If you created scheduled parameters, they are available for assignment as business identifiers.

If you have not yet configured at least one business identifier tracking field in your integration, an error icon is displayed in the design canvas. See Missing a Primary Business Identifier in an Integration.

To assign business identifiers:

1. In the left navigation pane, click Home > Integrations > Integrations.
2. Click the specific integration to which to add business identifiers. You can only add business identifiers to integrations that are not active. If an integration is active, you can only view its existing business identifiers.
3. From the menu, select Tracking.
   The Business Identifiers For Tracking dialog is displayed. The source payload for the selected integration is displayed on the left side. You can only assign business identifiers to fields of source payloads. You cannot assign business identifiers to fields of target payloads.
4. From the Source section, drag the payload field that you want to track to the Drag a trigger field here section. A green checkmark indicates that this is the primary business identifier. At least one identifier is required. If you only add one, it is automatically selected as the primary key. If you created scheduled parameters, they are available for assignment as a primary or secondary business identifier.
   
   
   Description of the illustration business_identifiers.png
   
   You can filter the display of source structures by clicking the Filter link. This enables you to filter on whether or not fields are used and on the type of field (required fields, custom fields, or all fields).
5. In the Tracking Name field, optionally enter a descriptive name to track during runtime (for example, OrgId). The name is displayed when this field is used to filter messages on the Track Instances page or (if there is an integration error) the Errors page during runtime.
6. In the Help Text field, optionally enter instructions to enable users to know what to enter in this field during runtime (for example, Enter a valid organization number). These instructions are displayed inside the empty field when it is used on the runtime Track Instances page to filter messages.
7. Click Done.

Delete Business Identifiers

You can delete business identifiers that track fields in messages during runtime.

To delete business identifiers:

1. In the left navigation pane, click Home > Integrations > Integrations.
2. Click the specific integration to which to add a business identifier. You can only add business identifiers to integrations that are not active. If an integration is active, you can view, but not edit, the contents of the Business Identifiers for Tracking dialog.
3. From the menu, select Tracking.
   The Business Identifiers For Tracking dialog is displayed.
4. At the far right, click the Delete icon for the business identifier to delete. If you delete the primary business identifier, select a new one. Without a primary identifier, you cannot track fields across integration flows during runtime on the Track Instances page.