Moogsoft Docs

checkSituationState

A Workflow Engine function that returns true if the specified state exists for a Situation. For example TICKETED, LEAVE_MANUAL_DESCRIPTION. Not to be confused with Situation status.

This function is available for Situation workflows only.

The workflow sweep up filter applies to this function.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function checkSituationState takes the following arguments:

Name

Required

Type

Description

state

Yes

String

Situaton state or flag to check for. For example: "TICKETED".

Example

The following example demonstrates typical use of Workflow Engine function checkSituationState. If you want to set the state to TICKETED, enter the following:

  • state: TICKETED

The UI translates your settings to the following JSON:

{"state":"TICKETED"}

Returns true for Situations that have a state of "TICKETED". For example a Situation 22 which returns the following for getSituationFlags :

{"22": ["TICKETED"]}