clsGetFormInstanceData Step

Use this step to get Form Instance data.

Last published at: August 25th, 2025

Description:

This step fetches the Form Instance data as an XML or JSON value.

 

Inputs

  • formInstID – form instance ID
  • resultType - result format as JSON or XML
  • varGlobalStoreID - variable or global to store the form instance value
 

 

Returns

  • True – expression evaluates to a true result
  • False – expression evaluates to a false result
 

 

 

Usage:

 

 

Example:

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

  • Create a new process definition called “clsGetFormInstanceDataDef" and open the definition in designer mode. 
  • Drag “RouteForm, clsGetFormInstanceData” steps to the canvas.
  • Connect the dots between the “Start” step and other steps, as shown above.
  • Define a variable or a global to store the result.
  • Click the “RouteForm” step to configure its “Required” properties. Provide a name for the step. Provide the task description. 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 “RouteForm” step to configure its “Optional” properties. Select the users to route to. Provide the task priority and complete duration. Click the Save button. 

 

  • Click the “clsGetFormInstanceData” step to configure its “Required” properties. Provide a name for the step. Provide the variable or global reference that holds the Form Instance ID. Select the result format from the drop-down list, such as XML or JSON. Provide the variable or global reference to store the result value. 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 below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and then execute it.  

 

  • The Form task is routed to the user, who shall complete and submit it. 

 

  • The “clsGetFormInstanceData” step should fetch the Form Instance data and store it in the variable or global reference, as configured. 

 

Definition Sample:

You may download and extract 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.