Wait for condition workflow activity

  • Release version: Xanadu
  • Updated November 14, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Wait for condition workflow activity

    The Wait for condition workflow activity in ServiceNow pauses a workflow until a specified condition on the current record is met. It continuously evaluates the condition each time the record is updated and only proceeds when all defined conditions are true. This activity is designed to wait for external events, such as record updates, rather than changes made internally by the workflow itself. For pausing workflows based on time durations, Timer workflow activities should be used instead.

    Show full answer Show less

    Key Features

    • Condition Evaluation: The workflow waits until the specified condition or script-based condition evaluates to true on the current record.
    • Timeout Capability: An optional timeout can be enabled to limit how long the workflow waits before automatically continuing. Duration can be specified in hours, minutes, and seconds, and scheduling can be applied for work schedules.
    • Result Assignment: The workflow designer can assign a result value via script within the activity; the workflow proceeds when this result becomes true.
    • Activity States: The activity can be in Executing, Waiting, Finished, Cancelled, or Error states, which control how the workflow engine manages the activity during execution.

    Practical Considerations for ServiceNow Customers

    • This activity is ideal for workflows needing to pause until an external record update meets certain criteria.
    • It should not be used to wait for changes made by the workflow itself; instead, use a short timer activity to detect such changes.
    • Enabling timeout helps prevent workflows from stalling indefinitely if the condition is never met.
    • Understanding activity states aids in troubleshooting and managing workflow execution flow.

    The Wait for condition activity causes the workflow to wait at this activity until the current record matches the specified condition.

    The workflow evaluates the Wait for condition activity each time the current record is updated. Use this activity to pause a workflow indefinitely until a particular criteria is met by a record update. To pause a workflow for a timed duration see Timer workflow activities.

    For workflow to consider the condition met, all conditions specified – whether in the builder or in a script – must be true.
    Note:
    A Wait for condition activity should only be used to wait for an external event such as a record update, and not one from a workflow setting a value. If you have a workflow setting a value and want to wait for that same field to be seen as 'changed,' try inserting a one-second timer.

    Results

    The workflow designer can assign a result value using activity.result from within a script field of the activity. The activity transitions when the result value is true.

    Input variables

    The following variables determine the behavior of the activity.
    Note:
    Condition activities run as the user whose actions match the conditions the workflow was waiting for and advances the workflow.
    Table 1. Wait for condition activity input variables
    Field Description
    Condition The workflow is paused at this activity until this condition matches the current record.
    Condition script If specified, the workflow is paused at this activity until this script sets the answer variable to true.
    Enable Timeout Option to limit the amount of time that the workflow waits for the activity to be completed before continuing.
    Note:
    Use the Enable timeout option to prevent this activity from continuing to run. If the condition to continue is never met, a timeout value specifies when the system skips the Wait for Condition activity and goes to the next item in the workflow. You must set a Duration value to enable a timeout. You can also select a Schedule if you want to compute the duration end date based on a specific work schedule.
    Duration Amount of time that the workflow waits before continuing when the Enable timeout option is selected. Enter the time to wait in hours, minutes, and seconds. If you leave this field empty, the workflow does not wait.

    States

    The activity state tells the workflow engine what to do with the activity.
    Table 2. Wait for condition activity states
    State Description
    Executing The workflow engine knows to start the onExecute function of the activity.
    Waiting The workflow engine ignores the activity until a specific event to restart the activity is fired.
    Finished The activity finished running. See the result value for the outcome of the activity.
    Cancelled This activity, or the workflow that contains this activty, was canceled.
    Error A JavaScript error occurred. Review the logs for error details.