instantiateForm Step

Use this step to create a new Form Instance

Last published at: October 14th, 2024

Description:

This step creates a new Form Instance.

 

Inputs

  • selectFormDefintions – Select a form definition
  • formInstanceName– name of the new form instance
  • formInstanceID -- Variable to hold the form instance ID
  • useSameForm - Use the same form (select Yes / No) 
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new definition called “instantiateFormDef”
  • Select the definition and click the “design” button
  • Drag an instantiateForm, RouteForm, Loop, Decision, Placeholder step from the toolbox
  • Connect the steps as shown in the below graphic 

 

  • Click on the “instantiateForm” step to configure its “Settings” properties, as shown in the graphic below. Select an existing form definition. Define a variable/global to hold the form instance ID. 

 

  • Click on the “instantiateForm” step to configure its “Advanced” properties, as shown in the graphic below. The name of the form instance is optional; keep it blank if you intend to use the same form. Configure the same form option to Yes to retain the same form instance ID or select option No to instantiate a new form instance ID each time the step is processed.

 

  • Click on the "RouteForm" step to configure its “Settings” properties, as shown in the graphic below. Select the exact form definition. Select the variable/global that holds the form instance ID. Select the users to route the form to. The other step properties may be configured as necessary.    

 

  • Click on the "Loop" step to configure its properties, as shown in the below graphic. Mention the loop value and the variable/global to hold it. 

 

  • Select the link connections and identify one as 'loop Returns' and the other as ‘loop Completed.’  

 

  • Click on the "Decision" step to configure its properties as shown in the graphic below

 

  • Save the process definition, create a new process instance, and execute. The instantiateStep should create a new form instance ID each time or retain the same form instance ID configured in the process flow above. 

 

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

Click here to download the Form Definition sample file.