getFormFieldValues Step

Use this step to fetch the Form field values.

Last published at: August 18th, 2025

Description:

This step fetches the Form field values by the Form Instance ID.

 

Inputs

  • formInstanceID – Variable that holds the form instance ID
  • fieldMappings – Mapping of values to fields 
  • formID - Select Form Definition 
 

 

Returns

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

 

 

Usage:

 

 

Example:

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

  • Create a new Form Definition called “getFormFieldValuesDef” and open the definition in designer mode. 
  • Drag the “bootstrapGrid, Labels, Textboxes, TextArea, Date, and Submit” controls and arrange them as shown below. Save the Form definition.

 

  • Create a new Process Definition called “getFormFieldValuesDef” and open the definition in designer mode. 
  • Drag a “routeForm, getFormFieldValues” step to the canvas.
  • Connect the dots between the “Start” step and other steps, as shown above.
  • Define the variables and globals to store the Form field values.
  • Click the “routeForm” step to configure its “Required” properties. Select the above Form Definition from the drop-down list. Configure the user to route in the “Advanced” tab. Provide a variable or 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 “getFormFieldValues” step to configure its “Required” properties. Provide a name for the step. Provide a variable or global reference to hold the Form Instance ID. Click the button to map the Form fields to variables or globals. Select the Form definition from the drop-down list. 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 button to map the Form fields to variables or globals. Click the Add Row (+) button to insert an empty row. Select the Form field value from the list and provide a variable or global value. Click the Save button. You may insert multiple mappings by using the Add Row button. 

 

  • 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 process instance is sleeping, and the Form task is assigned to the user configured.

 

  • Navigate to the Engage - Tasks page to view the Form Task. 

 

  • Click the Form task to render the Form. Provide the values and submit the Form. 

 

  • The process instance completes with the “getFormFieldValues” step. Click the process step to view its properties. The step gets Form field values and assigns them to a given variable or global.

 

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 Form Definition sample file.

Click here to download the Process Definition sample file.