renameInstance Step

Use this step to rename the current process instance

Last published at: October 26th, 2024

Description:

This step renames the process instance under execution.  In some applications, process instances are initiated with a temporary name, and once the process starts to execute, a step might compute the name of the instance.

 

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 definition called “renameInstanceDef” 
  • Select the definition and click the “design” button
  • Drag a “renameInstance” step from the toolbox
  • Connect the dots between the Start and the “renameInstance”  step
  • Click the “renameInstance”  step to configure its “Settings” properties. Provide a step name. Provide a new name for the process instance. 

 

  • 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 execute. Note: The process instance name is created as default by the application.  

 

  • 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 it (drag-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.

Click here to download the sample file.