stopObject

A stop represents an activity to be serviced by a resource or outsourced. Stops are the core of Spiral’s scheduling model; their costs are determined by resource deployment and service-quality metrics. Attribute names and types are links.

The fields below are grouped into the input attributes (supplied to Spiral) and the output / runtime attributes Spiral reports back for each stop — including its identity (id) and its position within the resource’s schedule as a doubly-linked list (after → this stop → next).

Attributes

{

"type": <stopParamsKey>,

"customer": <contractCustomerKey> | null,

"delayFactor": <real>,

"noSolnFactor": <real>,

"did": <deskId> | null,

"rid": <resourceId> | null,

"dep": <time>,

"arv": <time>,

"fin": <time>,

"at": <location> | null,

"earliest": <time>,

"latest": <time>,

"lock": <bool>,

"hold": <bool>,

"areaExempt": <bool>,

"minLeaveIn": <timeInterval>,

"option": [skillOption] | null,

"exclude": [resourceId] | null,

"only": [resourceId] | null,

"to": <stopObject> | null,

"and": <stopObject> | null,

"with": <stopObject> | null,

"then": <stopObject> | null,

"asset": <stopObject> | null,

}

type stopParamsKey: Defines stop properties and behaviour.
customer contractCustomerKey default null: Customer identifier; inherited from the parent if null.
delayFactor real default 1.0: Local multiplier for calculated delay costs.
noSolnFactor real default 1.0: Consult Honeywick for details.
state INIT | PLAN | DPLY | HEAD | CMTD | ARVD | DONE: Current stop state (settable input states). OSRC is an output-only state.
did deskId: Desk assignment; 0 triggers recalculation.
rid resourceId: Resource assignment; 0 triggers recalculation; null assigns no resource.
dep time: Deployment time; triggers resequencing if conflicts exist.
arv time: Arrival time; triggers resequencing if conflicts exist.
fin time: Finish time.
at location: Stop location.
earliest time: Earliest possible start (respects parent constraints).
latest time: Latest acceptable start.
lock bool default false: Prevents Spiral from rescheduling.
hold bool default false: Prevents deployment; planning continues; the host can update state.
areaExempt bool default false: Exempts from working-area restrictions.
minLeaveIn timeInterval: Minimum time from now until stop completion.
option skillOption: The service options (required skills) for this stop; null means any capable resource qualifies.
exclude resourceId: Resources prohibited from assignment.
only resourceId: Resources exclusively eligible for assignment.
to stopObject: Sequential delivery stop; null options reverse the parent action.
and stopObject: Unrelated concurrent activity.
with stopObject: Concurrent activity at the same time.
then stopObject: Sequential follow-up activity.
asset stopObject: Collects resource skills; releases them at the delivery stop.

Schedule / output fields

Reported by Spiral on each stop in the output stream (and read back from a resource’s schedule). The id, after and next fields define the stop’s identity and its order within the resource’s plan.

{

"id": <integer>,

"after": <integer> | null,

"next": <integer> | null,

"tvl": <timeInterval> | null,

"dst": <distance> | null,

"fullTvl": <timeInterval> | null,

"fullDst": <distance> | null,

"cbt": <time> | null,

"rndvz": <integer> | null,

"solnTier": <string> | null,

"voluntary": <bool> | null,

"surgeZone": <integer> | null,

"info": <string> | null,

}

id integer: Unique identifier for the stop, assigned by Spiral.
after integer: The id of the preceding stop in the resource’s schedule; null at the start.
next integer: The id of the following stop in the resource’s schedule; null at the end.
tvl timeInterval: Travel time to reach this stop.
dst distance: Travel distance to reach this stop.
fullTvl timeInterval: Total travel time including any reverse / return legs.
fullDst distance: Total travel distance including any reverse / return legs.
cbt time: Commit-by time — the latest time the stop can remain uncommitted.
rndvz integer: The rid of a resource that will arrive at the same location and time to facilitate this stop’s delivery (a rendezvous); null when none is planned.
solnTier string: The solution tier attached to this stop’s current solution.
voluntary bool: True when the stop is currently in a voluntary solution for its allocated resource (output-only; indicates a contractual refusal option).
surgeZone integer: The id of the surge zone affecting this stop, or null.
info string: Informational message about the stop; content controlled by the debug setting.

stopObject

Attributes

Schedule / output fields

Related