← All types
ProductionOb Object

ScheduleScenarioState

A versioned schedule scenario

Fields

TypeID of this schedule scenario (prefix "sch", e.g. "sch_01K…").

name

String!Non-null

Human-facing label for the scenario, unique only by convention. Cannot be blank.

version

Int!Non-null

Planner-assigned revision number for this scenario. At least 1; defaults to 1 on create. Not an optimistic-concurrency token — the server never bumps it, callers set it.

Lifecycle status: DRAFT (being built), PUBLISHED (the schedule in force), ARCHIVED (superseded, kept for history), SIMULATION (what-if run, never in force).

Possible values (4)
DRAFT

The scenario is still being built: the planner is free to add, move and remove allocations, and nothing on the shop floor works to it yet.

PUBLISHED

The scenario is the schedule currently in force — the one the shop floor is expected to work to.

ARCHIVED

Superseded by a later scenario and kept only for history; no longer in force.

SIMULATION

A what-if run used to compare planning options. Never in force, however recent it is, and typically discarded once the comparison is over.

Whether the scenario schedules the whole plant (GLOBAL) or a single production cell (PARTIAL, in which case targetProductionCellId is set).

Possible values (2)
GLOBAL

The scenario plans the whole plant, so every work centre in the tenant is in play and targetProductionCellId is null. The default when scope is omitted.

PARTIAL

The scenario is confined to a single production cell, named by targetProductionCellId — which validation then requires.

TypeID of the production cell this scenario is confined to (prefix "pcl"). Required when scope is PARTIAL; null when scope is GLOBAL.

ISO-8601 timestamp at which the planning window opens. Null when the scenario has no bounded horizon.

ISO-8601 timestamp at which the planning window closes. Must be strictly after planningHorizonStart when both are set. Null when the scenario has no bounded horizon.

TypeID of the user who created the scenario (prefix "usr"). Null when it was created by a non-user principal, e.g. an automated planning run.

ISO-8601 timestamp at which the scenario was frozen by lockScheduleScenario. Null while the scenario is still editable; once set, all further updates are rejected.

ISO-8601 timestamp at which the scenario was first persisted. Never changes.

ISO-8601 timestamp of the most recent accepted mutation, including locking.

Referenced by (5)
Exact type SDL
"""A versioned schedule scenario"""
type ScheduleScenarioState {
  """TypeID of this schedule scenario (prefix "sch", e.g. "sch_01K…")."""
  id: ScheduleScenarioID!
  """
  Human-facing label for the scenario, unique only by convention. Cannot be blank.
  """
  name: String!
  """
  Planner-assigned revision number for this scenario. At least 1; defaults to 1 on create. Not an optimistic-concurrency token — the server never bumps it, callers set it.
  """
  version: Int!
  """
  Lifecycle status: DRAFT (being built), PUBLISHED (the schedule in force), ARCHIVED (superseded, kept for history), SIMULATION (what-if run, never in force).
  """
  status: ScheduleStatus!
  """
  Whether the scenario schedules the whole plant (GLOBAL) or a single production cell (PARTIAL, in which case targetProductionCellId is set).
  """
  scope: ScheduleScope!
  """
  TypeID of the production cell this scenario is confined to (prefix "pcl"). Required when scope is PARTIAL; null when scope is GLOBAL.
  """
  targetProductionCellId: ProductionCellID
  """
  ISO-8601 timestamp at which the planning window opens. Null when the scenario has no bounded horizon.
  """
  planningHorizonStart: ISO8601
  """
  ISO-8601 timestamp at which the planning window closes. Must be strictly after planningHorizonStart when both are set. Null when the scenario has no bounded horizon.
  """
  planningHorizonEnd: ISO8601
  """
  TypeID of the user who created the scenario (prefix "usr"). Null when it was created by a non-user principal, e.g. an automated planning run.
  """
  createdByUserId: UserID
  """
  ISO-8601 timestamp at which the scenario was frozen by lockScheduleScenario. Null while the scenario is still editable; once set, all further updates are rejected.
  """
  lockedAt: ISO8601
  """
  ISO-8601 timestamp at which the scenario was first persisted. Never changes.
  """
  createdAt: ISO8601!
  """
  ISO-8601 timestamp of the most recent accepted mutation, including locking.
  """
  updatedAt: ISO8601!
}