removeFormInstance Step

Use this step to remove the form instance and the data

Last published at: October 22nd, 2024

Description:

This step removes the Form Instance and the data permanently. 

 

Inputs

  • formID – Variable that holds the form id
 

 

Returns

  • True – True condition
  • False – False condition 
 

 

Usage:

 

 

Example:

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

  • Create a new definition called “removeFormInstanceDef” 
  • Select the definition and click the “design” button
  • Drag the above steps from the toolbox to the canvas
  • Connect the dots between the Start and the above steps
  • Define a variable/global to store FormInstanceID
  • Click the “routeForm” step to configure its “Settings” properties. Provide a step name. Select the Form Definition from the drop-down list. Provide a variable/global reference to store the FormInstanceID. 

 

  • You may also configure a form variable to hold the FormInstanceID. To do so, Select the Actions—Manage Form Variables menu option. 

 

  • Provide a form variable name. Select the form definition from the drop-down list. 

 

  • Click the Add button to include the form variable in the workflow. A notification alert is displayed in the top right corner as below. You may now use the form variable reference to hold the FormInstanceID on the “routeForm” step. 

 

  • Click the “Wait” step to configure its “Settings” properties. Provide a step name. Provide the wait time value and select the type of Wait from the drop-down list. Click the Save button to Confirm. 

 

  • Click the “removeFormInstance” step to configure its “Settings” properties. Provide a step name. Provide the variable/global reference which holds the FormInstanceID value.  

 

  • 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 process instance, and execute. Render the process instance. Click on the process step to view its properties. The step should remove 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.