renameFormInstance Step

Use this step to rename a Form Instance.

Last published at: August 8th, 2025

Description:

This step renames a Form Instance.

 

Inputs

  • formInstanceID -- Variable holds the form instance ID
  • formName-- name of the form instance 
 

 

Returns

  • True – step executed successfully 
  • False – step failed to execute 
 

 

Usage:

 

 

Example:

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

  • Create a new definition called “renameFormInstanceDef” and open it in Designer mode.
  • Drag the "instantiateForm, renameFormInstance" steps to the canvas
  • Connect the dots between the “Start” and the other steps, as shown above.
  • Declare a variable or a global to store the Form Instance ID.
  • Click the “instantiateForm” step to configure its “Required” properties. Provide a name for the step. Select the Form Definition from the drop-down list. Provide a variable or a global to store the Form Instance ID. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

  • Click the “renameFormInstance” step to configure its “Required” properties. Provide a name for the step. Provide the variable or global reference that holds the Form Instance ID. Provide a new name for the Form 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. Render the process instance.  This step should rename the Form Instance.

 

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. 

Click here to download the sample file.