- Introduction
- Getting started
- Building with Maestro BPMN
- Understanding Maestro BPMN modeling
- Opening the modeling canvas
- Modeling your process
- Aligning and connecting BPMN elements
- Autopilot for Maestro (Preview)
- Process Repository
- Implementing a simple BPMN process
- Implementing a complex BPMN process
- Debugging
- Simulating
- Evaluations (Preview)
- Common implementation scenarios
- Building with Maestro Case
- Introduction to Maestro Case
- Maestro BPMN vs. Maestro Case: when to use case management
- The Maestro Case lifecycle: from event trigger to app experience
- Build your first case with Maestro Case
- Build a Maestro Case with a coding agent (preview)
- Defining case keys (system vs. external)
- Establishing task I/O and write-back contracts
- Exit rules and early stage termination
- Modeling primary and secondary stages
- Triggering a case from Data Fabric
- Implementing stage-level personas and permissions
- Setting SLAs and automated escalation rules
- Configuring a rework loop (re-entry)
- Configuring and testing the Case Manager Agent (preview)
- Case Manager input and output contract
- Maestro Case component dictionary
- Building with Maestro Flow
- Maestro Automate
- Integrations
- Operating
- Monitoring
- Optimizing
- Reference information
Replace the system-generated instance label with a dynamic, human-readable value derived from runtime data, such as an order number or customer name.
Overview
By default, Maestro identifies each process instance by a system-generated ID. A custom instance ID lets you replace that label with a dynamic, human-readable value—such as an order number or a customer name—derived from the data the process receives at runtime.
The custom instance ID is displayed directly in the instance list, so you can identify why an instance ran and for which value, without opening the instance.
Prerequisites
- An Agentic process open in the Maestro canvas.
- The process has a start event.
Configuring a custom instance ID
To configure a custom instance ID, set the expression in the start event's properties before publishing the process.
-
Select the start event on the canvas.
-
In the Properties panel, go to the General section.
-
In the Custom Instance ID field, set the value using one of the following options:
- Variable — select a start event variable or input argument.
- Expression — build an expression that combines variables or formats output, for example:
string.Format("Order: {0}", vars.OrderId). - Literal — enter a fixed text value.
-
Publish the process.
Result
When an instance runs, Maestro evaluates the Custom Instance ID expression after the start event completes and displays the result as the instance name in the instance list.
If the expression references variables that are not yet resolved at evaluation time, the custom instance ID displays as blank until the value is available.
Limitations
- You can configure custom instance IDs on start events only. Custom instance IDs are evaluated once, immediately after the start event executes. Values set on activities or end events are not applied.
- Searching and filtering instances by custom instance ID in Insights, and Process Mining is not yet supported.