Skip to content

BeginProcessActivity#

Overview#

Begins a specified Process Activity by validating system and user state, optionally performing an automatic check-in of the employee, and opening the checklist instance associated with the material. This moves the activity into an "In Progress" state and prepares it for further execution.

Action Groups#

  • Orchestration.IndEqManagementOrchestration.BeginProcessActivity.Pre
  • Orchestration.IndEqManagementOrchestration.BeginProcessActivity.Post

Input Object#

Name Type Description
ProcessActivity IndEqProcessActivity The Process Activity to be started

Output Object#

Name Type Description
ProcessActivity IndEqProcessActivity The updated Process Activity in "In Progress" state

Pre Conditions#

  • The input ProcessActivity must not be null and must exist in the system.
  • The ProcessActivity must be in the Open state before starting.
  • The current user must have the required role specified by the ProcessActivityDefinition.
  • If check-in is enabled and auto check-in on begin is true, the employee must be checked in automatically; otherwise, a manual check-in is required.
  • The checklist associated with the ProcessActivityDefinition must be defined for the material.

How it works#

  1. Validates the input is not null and loads the full ProcessActivity entity.
  2. Checks that the ProcessActivity system state is Open. If not, throws an exception.
  3. Retrieves the current user and checks if the user has the required role defined by the activity.
  4. Checks if the employee is already checked in.
  5. If not checked in, and check-in is enabled and auto check-in on begin is enabled, it triggers CheckInProcessActivity.
  6. Otherwise, it throws an exception requiring the employee to be checked in manually.
  7. Opens the checklist instance for the material related to the Process Activity.
  8. Updates the Process Activity state to In Progress, sets the active checklist instance, start time, and flow path.
  9. Saves the updated ProcessActivity and returns it in the output.

Assumptions#

  • User roles and permissions are properly managed outside this service.
  • Check-in logic correctly associates employees with activities.
  • The checklist and material relationship is valid and configured.
  • Time is managed in UTC to avoid timezone conflicts.