Skip to content
Honeywick Consulting

illegalActionsObject

Defines how Spiral handles scheduling errors when planning stops — a map from each illegal action to the reasons it applies to:

{ [<illegalAction>]: [ <illegalReason> ] }

illegalAction

Section titled “illegalAction”

The response to a potential illegal condition:

  • ignore — disregard these reasons as violations;
  • inform — not illegal, but notify the host when detected in generated plans;
  • ok — cannot be auto-generated; the host may request plans violating them;
  • warn — cannot be auto-generated; warn when the host requests violations;
  • refuse — cannot be auto-generated; removed via a corrected plan unless locked;
  • unlock — cannot be auto-generated; removed via a corrected plan, unlocking stops as needed.

illegalReason

Section titled “illegalReason”

Categories of detectable violation:

  • Resource & assignment — OTHER, RESOURCE, CAUSALITY, HANDOVER_WITH_PARENT, EXCLUDED, ONLY, LIVERY
  • Constraints — HARD_AREA, SOFT_AREA, SKILL_MISSING, SKILL_PLAN, TRAVEL_LIMIT, EXCEEDS_SHIFT_PERIOD, EXCEEDS_WORK_PERIOD
  • Positioning — BEFORE_FIRST, AFTER_LAST, MUST_BE_FIRST, MUST_BE_LAST, ONTIMEONLY, CURRENT_AREA
  • Reliability & availability — MUST_BE_RELIABLE, MUST_BE_IDLE, MUST_BE_EXCLUSIVE
  • Voluntary / staffing — VOLUNTARY_DECLINED, VOLUNTARY_OFFER_TOO_LATE, VOLUNTARY_NOT_RELIABLE, VOLUNTARY_NOT_ARVD, VOLUNTARY_NOT_FIRST, VOLUNTARY_FLEXIBLE_PLAN, VOLUNTARY_DEFERRED_APPT, VOLUNTARY_IMPACT, VOLUNTARY_NOT_ALLOWED
  • Other — CONTRIVED_LOAD
Section titled “Related”