Skip to content

PauseProcessActivity#

Overview#

Pauses a Process Activity that is currently In Progress. If there is an active Checklist Instance running, it will also be paused with a specified Reason. Additionally, employees may be automatically checked out if the Process Activity Definition requires it.

Action Groups#

  • Orchestration.IndEqManagementOrchestration.PauseProcessActivity.Pre
  • Orchestration.IndEqManagementOrchestration.PauseProcessActivity.Post

Input Object#

Name Type Description
ProcessActivity IndEqProcessActivity The Process Activity that will be paused.
Reason IReason The reason used when pausing the active Checklist Instance.

Output Object#

Name Type Description
ProcessActivity IndEqProcessActivity The Process Activity that has been paused.

Pre Conditions#

  • Input must not be null.
  • The Process Activity must be in the In Progress state.
  • If an active Checklist Instance is running, a valid reason must be provided.

How it works#

  1. Validates the input object and required properties.
  2. Loads the Process Activity and verifies it is in the In Progress state.
  3. Updates the Process Activity’s system state to Paused and saves it.
  4. If an active Checklist Instance is running, pauses it using the provided reason.
  5. If the Process Activity Definition has AutoCheckOutOnPause enabled, automatically checks out all employees currently checked in.
  6. Returns the updated Process Activity.