- Introduction
- Getting started
- Process modeling
- Process implementation
- Debugging
- Simulating
- Publishing and upgrading agentic processes
- Common implementation scenarios
- Extracting and validating documents
- Process operations
- Process monitoring
- Process optimization
- Reference information
Maestro user guide
Custom instance ID
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
-
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 instance management, Insights, and Process Mining is not yet supported.