Description:
This step starts and executes a process instance.
Inputs
- definitionID--Definition to use
- passVariables--Pass variables to new instance
- passGlobals--Pass globals to new instance
- variablesToPass--Select variables to pass to new instance
- globalsToPass--Select globals to pass to new instance
- executionPriority--Select execution priority
- instanceName--Name of the instance
- variableToStoreID--Variable/Global to store instance ID
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “createExecuteInstanceDef” example.
- Create a new process definition named “createExecuteInstanceDef” and open it in designer mode.
- Drag the "createExecuteInstance" step to the canvas.
- Connect the dots between the “Start” and the “createExecuteInstance” steps, as shown above.
- Define a variable or a global to store the process instance ID.
- Click the "createExecuteInstance" step to configure its "Required" properties. Provide a name for the step, then select the process definition from the drop-down list. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description.
- Click the "createExecuteInstance" step to configure its "Optional" properties. Select the process definition from the drop-down list. Choose whether variables and globals must be passed to the new process instance. Provide specific variables to pass instead of passing all variables to the new process instance (separated by commas). Select the execution priority from the drop-down list (low, medium, high). Select the execution interval type from the drop-down list (days, months, hours, minutes). Note: Configuring the execution interval for a few minutes is recommended when executing this process step in a loop. Provide specific globals to pass, instead of passing all globals to the new process instance (separated by commas). Provide a name for the new process instance. Provide the execution interval value in time. Provide the variable or global reference to hold the new process instance ID. Click the Save button.
- The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 execute it. The process step should create and manage a process instance with the specified name.
- Navigate to the Process - Instances page to view the new instance. Render the new process instance to view the variables and globals passed from the source instance.
Definition Sample:
You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into 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 the import. Then, save the definition to confirm the changes.
Click here to download the sample file.