Description:

The RenameInstance workflow step changes the name of the current process instance to the value specified in the Name of the instance input. The step is defined in the Engine category and displayed in the FlowWright designer as "Rename Process Instance".

The step supports:

• Changing the process instance name
• Providing the new instance name through a string input
• Using a workflow-configured value for the instance name
• Continuing the workflow through True or False return paths 

This step can be used for:

• Giving process instances meaningful business names
• Naming instances using workflow-generated information
• Improving process-instance identification
• Updating an instance name as workflow information becomes available
• Supporting easier identification of process instances during workflow monitoring

Usage:

The RenameInstance step is typically placed at a point in the workflow where the workflow has sufficient information to assign a meaningful name to the current process instance.

A typical workflow pattern is:

Collect/Generate Information → Rename Process Instance → Continue Workflow

The new instance name can be configured before the step executes and can then be used to make the process instance easier to identify during subsequent workflow activities and process administration.

Another common pattern is:

Start → Gather Business Information → Rename Process Instance → Process Workflow

For example, a workflow may first obtain an identifier or other business information, then use it to configure the instance name.

Typical Workflow Suggestions:

Give Instances Meaningful Business Names

Use the RenameInstance step when the default process-instance name does not provide enough business context.

For example, an instance can be named using information associated with the business transaction being processed.

A typical pattern is:

Receive Request → Rename Process Instance → Process Request

Use a consistent naming convention so that users can easily recognize related process instances.

Include a Business Identifier

Use a workflow value containing a business identifier as part of the instance name.

For example:

Customer Request - {{RequestID}}

Rename After Form Information Is Available

Place the RenameInstance step after a workflow activity that provides information useful for identifying the process.

For example:

Start → Route/Form Activity → Rename Process Instance → Continue

This allows the workflow to assign an instance name once relevant process information becomes available.

Use Consistent Naming Conventions

For workflows that create many process instances, establish a consistent naming convention.

For example:

<Process Type> - <Business Identifier>

<Department> - <Request Type> - <Request ID>

Rename When Process Context Changes

A workflow can use the step when additional information becomes available, and the existing instance name no longer provides sufficient context.

Use this carefully and avoid unnecessary renaming that could make instances harder to recognize over time.

Handle the False Return Path

Connect the False return path to an appropriate alternative or error-handling workflow when the name-changing operation must be explicitly handled if it fails.

A typical pattern is:

Rename Process Instance
        ├── True  → Continue Workflow
        └── False → Handle Failure

Use Meaningful Names

Avoid generic instance names that provide little information to workflow users.

Prefer names that identify the business process or transaction being handled. When a naming convention is established, use it consistently across instances of the same workflow.

Example:

Let’s build and execute the “renameInstanceDef” example.          

• Create a new process definition called “renameInstanceDef” and open it in Designer mode.
• Drag a “renameInstance” step to the canvas. 
• Connect the dots between the “Start” and the “renameInstance”  steps, as shown above. 
• Click the “renameInstance” step to configure its “Required” properties. Provide a name for the step and a new name for the Process Instance. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Note: The application generates the Process Instance name.  When the workflow reaches the RenameInstance step, FlowWright uses the configured Name of the instance value for the process instance. The workflow then continues along the configured True-or-False return path.

• Render the process instance. This step should rename it. Note: The process instance name has changed after execution. 

Tips:

• Use meaningful instance names that provide useful business context.
• Establish a consistent naming convention for related process instances.
• Use a business identifier when it helps distinguish individual instances.
• Place the step after the information required to construct the instance name becomes available.
• Verify the resulting instance name after executing the workflow.
• Avoid unnecessary renaming of the same process instance.
• Test the naming convention with representative workflow data.
• Consider how the name will appear to workflow users and administrators.
• Connect the True and False return paths appropriately.
• Use the False path for alternative or error-handling logic when required.
• Test the workflow after changing the instance-naming convention.
• Do not assume specific name-length, uniqueness, duplicate-name, or validation rules unless confirmed by the FlowWright implementation.
• Do not assume a particular variable-substitution syntax for constructing dynamic names unless it is supported and verified in the target environment.

Notes:

• The RenameInstance step is defined in the Engine category with the internal name renameinstance, label “Change the name of the instance”, and display name “Rename Process Instance.” It is implemented by FlowWright.Workflow.RenameInstance in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
• The step defines one required property:
  • instanceName – Name of the instance 
• The instanceName property uses the string data type, implemented by FlowWright.DataTypes.ClsTextBox.
• The step provides two return values:
  • False
  • True

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition XML or Form Definition HTML page.

Note: Verify and complete any missing configuration after importing a sample, including:

• Instance name.
• Workflow Variable references, if used to construct the name.
• Environment-specific configuration.
• Downstream True and False workflow paths.
• Any subsequent workflow activities that depend on the renamed instance.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.