Skip to main content

Making a Step Optional in Unmeshed

In Unmeshed, workflow steps can be marked as optional, meaning that their execution is not mandatory for the overall process to continue. This is useful when dealing with steps that might fail or may not always be required.

This guide explains how to configure a step as optional using the Unmeshed UI.

Steps to Mark a Step as Optional​

  1. Open the Process Definition

    • Navigate to the Process Definitions section in the Unmeshed UI.
    • Select the process definition that contains the step you want to modify.

  2. Select the Step

    • Click on the specific step in the process diagram that needs to be made optional.
    • The right-hand panel will display the step's settings.

  3. Locate the Optional Setting

    • In the right settings panel, find the Optional? configuration under the step settings.
    • This setting determines whether the step must execute successfully for the workflow to proceed.

  4. Enable Optional Mode

    • Select Yes to make the step optional.
    • If the step encounters an issue, the workflow will proceed without failure.
    • If No is selected, the step is mandatory, and any failure will stop the workflow.

  5. Save and Deploy Changes

    • Click the Save button to apply the configuration changes.
    • Run a test process execution to verify the behavior of the optional step.

Example Use Case​

If your workflow includes an API call that fetches optional metadata, marking it as optional ensures that the primary business process is not blocked if the API fails or returns no data.

Visual Reference​

Refer to the image below for a clear illustration of the Optional setting within the step configuration panel.

Mark Step Optional

By following these steps, you can make any step in your workflow optional, ensuring greater flexibility and fault tolerance in your orchestrations.