Description:

The Complete Step workflow step is an Engine step used to complete a selected step within the process.

The step supports:

• Selecting a workflow step to complete.
• Providing an optional return value for the selected step.
• Completing another step as part of workflow processing.
• Using workflow values to determine the selected step or return value.
• Incorporating step completion into larger workflow-control scenarios.

Usage:

The Complete Step step is typically used when workflow processing needs to explicitly complete another selected workflow step.

A typical workflow pattern is:

Determine Step → Complete Step → Continue Process

For example:

Workflow Processing
        ↓
Determine Target Step
        ↓
    Complete Step
        ↓
Continue Workflow

Potential uses include:

• Completing a selected workflow activity.
• Controlling the state of another workflow step.
• Completing a step based on workflow conditions.
• Supplying a return value when completing the selected step.
• Supporting exception or alternate processing flows.
• Implementing workflow-control logic.
• Completing a previously selected or identified step as part of a larger process.

Typical Workflow Suggestions:

Complete a Selected Workflow Step

Use Complete Step when a workflow needs to explicitly complete another step.

Example:

Start
  ↓
Determine Target
  ↓
Complete Step
  ↓
Continue Process

Complete a Step After a Condition Is Met

Use a condition or decision point to determine whether another step should be completed.

Example:

Evaluate Condition
       ↓
   Condition Met
       ↓
   Complete Step
       ↓
 Continue Process

Complete a Step Based on Workflow Data

Use workflow data to determine when a selected step should be completed.

Example:

Get Workflow Data
        ↓
Evaluate Data
        ↓
Complete Step
        ↓
Continue Processing

Complete a Step with a Return Value

Use Step return value when the selected step requires a return value as part of its completion.

Example:

Determine Result
      ↓
Complete Step
      ↓
Target Step = Approval
Return Value = Approved

The specific return value should correspond to the behavior expected by the selected target step.

Complete an Approval-Related Step

Use Complete Step when workflow logic determines that an approval-related activity should be completed.

Example:

Evaluate Approval Condition
          ↓
      Complete Step
          ↓
     Continue Process

If the target step supports a return value, an appropriate value can be supplied through Step return value.

Complete a Step from an Alternate Workflow Path

Use Complete Step as part of an alternate processing route.

Example:

                ┌→ Normal Processing
Decision ───────┤
                └→ Complete Step
                      ↓
                Continue Process

Complete a Step During Exception Handling

Use Complete Step as part of an exception-handling workflow when the process design requires another step to be completed as part of the recovery path.

Example:

Process Error
     ↓
Exception Handling
     ↓
Complete Step
     ↓
Recovery Processing

The XML does not define the specific exception-handling behavior, so validate the exact result in the workflow implementation.

Complete a Step After External Processing

Use Complete Step after an external operation determines that another workflow step can be completed.

Example:

External Processing
       ↓
Evaluate Result
       ↓
Complete Step
       ↓
Continue Workflow

Complete a Step from a Workflow-Control Process

Use Complete Step when the process contains workflow-control logic that needs to operate on another step.

Example:

Workflow Control
      ↓
Identify Target Step
      ↓
Complete Step
      ↓
Continue Process

Complete a Step with a Dynamic Result

Use the optional Step return value when the return value is determined during workflow execution.

Example:

Evaluate Request
      ↓
Determine Result
      ↓
Complete Step
      ↓
Return Value

Approved

Rejected

Complete a Selected Step After Data Validation

Use Complete Step after validating required workflow information.

Example:

Validate Data
     ↓
Validation Successful
     ↓
Complete Step
     ↓
Continue Process

Complete a Step as Part of a Multi-Path Workflow

Use Complete Step within a workflow containing multiple processing paths.

Example:

                 ┌→ Process A
Decision ────────┤
                 ├→ Process B
                 │
                 └→ Complete Step
                         ↓
                   Continue Process

Complete a Step and Continue with the Process

Use Complete Step as an intermediate workflow-control activity.

Example:

Start
  ↓
Prepare Completion
  ↓
Complete Step
  ↓
Next Workflow Activity

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.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• 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. Configure 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. Render the process instance and click the process step to view its properties. When the workflow reaches the Complete Step activity, verify that:
  • The intended target step is selected.
  • The optional return value is correctly configured, if required.
  • The selected target step is completed as expected.
  • The workflow continues according to the process design.

• Click the 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. 

Tips:

• Select the intended target step using Select step.
• Verify that the selected target step is the step that should be completed.
• Use a meaningful value for Step return value when the target step requires one.
• Leave Step return value unconfigured when no return value is required.
• Verify the expected return-value convention of the selected target step before supplying a value.
• Test the workflow using representative process paths before deployment.
• Test scenarios in which Complete Step is executed and scenarios in which it is not reached.
• Verify the state of the selected target step after execution.
• Use meaningful descriptions or step names so the target step can be easily identified.
• Avoid selecting a target step unintentionally when the workflow contains multiple similar activities.
• Test the workflow after changing the target step.
• Test the workflow after changing the configured return value.
• Consider documenting why a particular step is explicitly completed when the workflow design is complex.
• Verify that the completion operation does not interfere with other workflow paths that depend on the selected step.
• Use the optional return value only when it has a defined purpose in the target step's processing.
• Test alternate and exception-handling paths that use Complete Step.
• Verify workflow behavior when the selected target step has already reached a completed state.
• Do not assume how FlowWright handles a target step that is already completed unless confirmed by the implementation.
• Do not assume that every target step accepts the same return values.
• Do not assume that the Complete Step activity itself produces a True/False return result; the supplied XML defines no return values for this step.
• Validate step-completion behavior in the FlowWright runtime when using Complete Step in complex workflow-control scenarios.

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.

Before executing the imported definition, verify:

• Select step
• Step return value, if required
• The intended target workflow step
• Workflow connections
• Any workflow Variable references used to construct the return value
• The expected state of the selected target step after execution
• Any dependencies on the selected step
• Environment-specific workflow configuration

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.