renameFormInstance Step

Use this step to rename a Form Instance

Last published at: October 26th, 2024

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”  
  • Select the definition and click the “design” button
  • Drag the above step from the toolbox to the canvas
  • Declare a variable/global to store the form instance ID
  • Connect the dots between the Start and the other steps 
  • Click on the “instantiate” step to configure its “Settings” properties. Provide a step name. Select the form definition from the drop-down list. Provide a variable/global to store the form instance ID. 

 

  • Click the “renameFormInstance” step to configure its “Settings” properties. Provide a step name. Provide the variable/global reference that holds the form instance ID. Provide a new name for the form instance. Click the Save button to confirm changes. 

 

  • 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. 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 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.