Description:
This step is used to complete the selected step during workflow execution.
Inputs
- completeStepID – Select step to complete
- retValue – variable or global to hold the result
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “CompleteStepDef” example.
- Create a new definition called “CompleteStepDef” and open the definition in designer mode.
- Drag the “Wait, Decision, completeStep, and regular Task” steps to the canvas.
- Connect the “Start” step to other steps, as shown above.
- Define a variable or a global to store the result.
- Click the "Wait" step to configure its "Required" properties. Provide a duration time value to wait. Select the wait type from the drop-down list (minutes, hours, days, months, years, seconds). 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 "Decision" step to configure its "Required" properties. For example, the input condition 1==1 returns True. 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 "completeStep" step to configure its "Required" properties. Provide a name for the step. Select the step from the drop-down list. All process steps connected in the workflow on the design canvas are listed in alphabetical order. In this configuration, the "CompleteStep" shall complete the Task after 2 minutes when the process instance is executed. The step return value is stored in a “variable.returnValue”. 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 "completeStep" step to configure its "Optional" properties. Provide the variable or global reference to store the step return 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 below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. Render the process instance.
- The process step should complete the selected step as configured.
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.