renameInstance Step
Description:
This step renames the process instance that is currently executing. In some applications, process instances are initiated with a temporary name, and once the process begins to perform, a step may compute the instance's name.
Inputs
- instanceName – name of the instance
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
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. Provide a new name for the Process Instance. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the 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 then execute it. Note: The application makes the Process Instance name.
- Render the process instance. This step should rename the process instance. Note: The process instance name has changed after execution.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.