Skip to main content

removeSituationFlag

A Workflow Engine function that removes a specific flag from a Situation.

This function is available as a feature of the Workflow Engine v1.1 download and later.

This function is available for Situation workflows only.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function removeSituationFlag takes the following arguments:

Name

Required

Type

Description

flag

Yes

String

Flag to remove.

Example

The following example demonstrates typical use of Workflow Engine function removeSituationFlag. If you want to remove the "TICKET_PENDING" flag from a Situation, enter the following:

  • flag: TICKET_PENDING

The UI translates your settings to the following JSON:

{"flag":"TICKET_PENDING"}

Given a Situation with the following flag:

{
    "situationFlags": [
        "TICKET_PENDING"
    ]
}

The Workflow Engine updates the object as follows:

{
    "situationFlags": []
}