completeStep Step
Description:
This step completes the selected step during workflow execution.
Inputs
- completeStepID – Select step to complete
- retValue – step return value
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “CompleteStepDef” example.
- Create a new definition named “CompleteStepDef” and open it 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.
- Click the "Wait" step to configure its "Required" properties. Enter a duration 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 to have Copilot 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 evaluates to True. 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 "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" completes the Task after 2 minutes when the process instance is executed. The step's return value is stored in a “variable.returnValue”. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description.
- Click the "completeStep" step to configure its "Optional" properties. Type “completed” for the step return value. 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, execute it, and then render the process instance. The instance is “sleeping” at the “Wait” step.
- Click Items > Tasks menu to view the open tasks.
- The process step should complete the selected step as configured.
- Click Items > Tasks menu to view the closed tasks.
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.