Workflow navigation rule

Introduction

Workflow navigation rules control workflow navigation — determining whether activities are included, editable, or required. These rules are embedded in the workflow definition and cannot be shared across different workflows, unlike other rule types.

Rule syntax

Keywords

The following keywords are available in workflow navigation rules:

Name Type Description
@ctx DslCompilerContext Provides APIs to access data of the running workflow. Read more about @ctx here.
@apiFactory IManagedApiFactory To construct Casewhere API objects. Read here for the full list of available APIs.

Examples

Example 1: Conditional activity inclusion

A "Delete object" workflow has two activities in sequence:

  1. Form activity — shows a confirmation message and records the user's decision in the variable agreed.
  2. Scripted activity — deletes the data object if the user agreed.

Configure the inclusion rule for the scripted activity using "Included When":

@ctx.Get<bool>("agreed")

image-20250103171646444

Example 2: Make a form read-only after submission

Disable editing on the submission form after the user submits their application:

@ctx.Ref("CwAmtApplication")["Status"] == "Submitted"

image-20250103171715070