MineSync Docs
MineSync Docs
MineSync Documentation
ApprovalsConfigurationDispatchScheduler OverviewRequestsResourcesScenariosTasks
Scheduler

Approvals

Configure and manage approval workflows for schedule changes and overrides.

Overview

The Approvals module adds a governance layer to the Scheduler. It defines rules for when approvals are required, routes approval requests to the right people, and tracks the approval lifecycle. Approvals can gate schedule publishing, overtime, priority overrides, resource reassignments, and deadline extensions.

Approvals

Key Concepts

Approval Types

The system supports five types of approval:

TypeWhen Triggered
SCHEDULE_PUBLISHBefore a scenario can be published/activated
OVERTIME_APPROVALWhen scheduling work outside standard hours
PRIORITY_OVERRIDEWhen changing a task's priority beyond thresholds
RESOURCE_REASSIGNWhen reassigning tasks to different resources
DEADLINE_EXTENSIONWhen extending a work order's due date

Approval Rules

Rules define who can approve each type of request and under what conditions:

FieldDescription
NameHuman-readable rule name
TypeWhich approval type this rule applies to
Approver RolesTenant roles that can approve (e.g., ADMIN, MANAGER)
Approver User IDsSpecific users who can approve
PriorityRule matching priority (lower number = higher priority)
ConditionsOptional JSON conditions for when the rule applies
Requires All ApproversWhether all approvers must respond, or just one
Auto-Approve After HoursAutomatically approve if no response within this time
ActiveWhether the rule is currently in effect

Rules are matched by type, and the highest-priority (lowest number) active rule is used.

Approval Instances

When an approval is requested, an instance is created:

StatusDescription
PENDINGWaiting for approver response
APPROVEDAt least one approver approved (or all, if required)
REJECTEDAn approver rejected the request
ESCALATEDThe request was escalated to a different level
EXPIREDThe auto-approve timer elapsed

Each instance links to:

  • The rule that governs it
  • The user who requested it
  • The entity being approved (e.g., a task or scenario)
  • Individual approver responses with decisions and comments

Approval Responses

Approvers submit individual responses:

  • Decision -- APPROVED or REJECTED
  • Comment -- Optional explanation for the decision

If the rule requires all approvers, the instance stays PENDING until everyone responds. If only one approval is needed (the default), the first APPROVED response resolves it. Any REJECTED response immediately rejects the instance.

Readiness Gating

The approvals system integrates with task readiness:

  • The Check Readiness endpoint examines a task for pending approvals and other blockers
  • Tasks with pending approvals are not considered ready for scheduling
  • The Update Task Readiness endpoint lets planners manually override readiness status

How to Use

Creating Approval Rules

  1. Navigate to Scheduler > Approvals

  2. Click New Rule

  3. Select the approval type (e.g., SCHEDULE_PUBLISH)

  4. Set the approver roles and/or specific user IDs

  5. Configure whether all approvers must respond or just one

  6. Optionally set an auto-approve timer

  7. Set the rule priority and activate it

Requesting an Approval

  1. When an action requires approval, click Request Approval

  2. Select the type and provide a title and description

  3. Optionally link the request to a specific entity (task, scenario)

  4. The system finds the matching rule and creates a pending instance

  5. Approvers see the request in their pending approvals list

Responding to Approvals

  1. Check the Pending tab on the Approvals page
  2. By default, only approvals where you are an eligible approver are shown
  3. Review the request details
  4. Click Approve or Reject with an optional comment
  5. The instance status updates based on the rule's requirements

Escalating an Approval

If an approval is stuck or needs higher-level attention:

  1. Open the pending approval instance

  2. Click Escalate

  3. Provide a reason for escalation

  4. Optionally specify new approver user IDs or roles

  5. The instance moves to ESCALATED status

Checking Task Readiness

  1. Use the readiness check on any task to see its approval status
  2. The system returns:
    • Whether the task is ready
    • A list of blockers (including pending approvals)
    • Details of any pending approval instances
  3. Resolve blockers before scheduling the task

Common Questions

What if no approval rule exists for a type?

Attempting to request an approval when no matching rule is configured will return an error. Configure rules for each approval type you want to enforce.

Can I change approvers after a request is submitted?

Not directly. You can escalate the approval to different approvers, which creates a new escalation record while marking the original as ESCALATED.

Does auto-approve bypass the approval completely?

When configured, the system automatically approves the request after the specified number of hours if no approver has responded. This prevents approvals from blocking critical work indefinitely.

Can approvers see each other's decisions?

Yes. All responses (with decisions and comments) are visible on the approval instance detail view.

Roles and Permissions

User roles in MineSync and what each role can access and modify.

Configuration

Configure scheduler settings, option sets, and workflow templates.

On this page

OverviewKey ConceptsApproval TypesApproval RulesApproval InstancesApproval ResponsesReadiness GatingHow to UseCreating Approval RulesRequesting an ApprovalResponding to ApprovalsEscalating an ApprovalChecking Task ReadinessCommon QuestionsWhat if no approval rule exists for a type?Can I change approvers after a request is submitted?Does auto-approve bypass the approval completely?Can approvers see each other's decisions?