clsFormDefID Step

Use this step to fetch the form definition's GUID info

Last published at: January 28th, 2025

Description:

This step fetches the form definition's GUID information. 

 

Inputs

  • varGlobalStoreID – variable/global to store the form definition GUID info
  • formInstID  – form instance's GUID info 
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new definition called “clsFormDefIDDef”
  • Select the definition and click the “design” button
  • Drag an “instantiateForm, clsFormDefID” steps from the toolbox
  • Connect the dots between the Start and the other steps as above
  • Define a variable/global to store the result after execution
  • Click the "instantiateForm" step to configure its "Required" properties. Provide a name to the step. Select a form definition from the drop-down list. Provide the variable/global reference to store the form instance GUID info. Click the Save button to confirm. 

 

  • Click the "clsFormDefID" step to configure its "Required" properties. Provide a name to the step. Provide the variable/global reference to store the form definition GUID info. Provide the variable/global reference that holds the form instance GUID info. Click the Save button to confirm. 

 

  • 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. Click on the process step to view its properties. The “clsFormDefID” step should fetch the form definition GUID info and store the information in the variable/global as configured. 

 

  • You must navigate to the Form Definition page and search for the definition by its name. Use the column selector to view the DefinitionID column in the table. You notice the definitionID matches the variable/global holding the GUID value from the process 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.