resourceParamsObject

The resourceParams object describes properties for resource types, typically pre-declared via a define in the domain parameter file. Attribute names and types are links; the sub-object fields and the Helix extension block are documented below.

{

"key": <string>,

"clone": <resourceParamsKey>,

"livery": <string>,

"speedFactor": <real>,

"costKm": <real>,

"costHour": <real>,

"overheads": <real>,

"productiveTravelFactor": <real>,

"cityBias": <real>,

"softWorkingLimit": <distance> | null,

"hardWorkingLimit": <distance> | null,

"atSensitivity": <distance>,

"idleDiscount": <real>,

"reliableDiscount": <real>,

"calloutMargin": <real>,

"stopOnCaution": <real>,

"voluntaryCaution": <real>,

"deassignCost": <real>,

"voluntaryDeassignCost": <real>,

"deassignEarlyArrival": <timeInterval>,

"minimumIncome": <real>,

"stbyUsageFactor": <real>,

"stbyUsagePreWorkFactor": <real>,

"hostClockResolution": <timeInterval>,

"hostClockSpread": <timeInterval>,

"stopOnMode": IDLE | RELIABLE | ARVD | ONE | MAX,

"typicalStop": <stopParamsKey> | null,

"typicalToStop": <stopParamsKey> | null,

"typicalLeadTime": <timeInterval>,

"typicalTravelTime": <timeInterval>,

"typicalUsableTime": <timeInterval>,

"leadFactor": [dow: real] | null,

"coreSkills": [skill: null | real],

"exclusiveSkills": [skill: null | real],

"secondaryActivity": <secondaryActivityObject> | null,

"baseDeploy": <baseDeployObject>,

"surcharge": <surchargeObject> | null,

"planEarlyBase": <bool>,

"alpha": <real> | null,

"beta": <real> | null,

"helix": <helixObject>,

}

key string: Unique identifier for the resource type.
clone resourceParamsKey: Inherit values from another resource type.
livery string: Resource livery (visual identification / branding).
speedFactor real default 1.0: Relative speed within the topography.
costKm real default 0.0: Cost per kilometre travelled.
costHour real default 0.0: Hourly operational cost.
overheads real default 0.0: Additional hourly cost while signed on.
productiveTravelFactor real default 0.0: Value attributed to travel that is considered productive.
cityBias real default 0.0: Area-preference bias toward or away from urban areas.
softWorkingLimit distance: Maximum distance from base (soft constraint).
hardWorkingLimit distance: Maximum distance from base (hard constraint).
atSensitivity distance: Resolution applied to the resource’s location (positional sensitivity).
idleDiscount real default 0: Discount for immediate deployment after sign-on.
reliableDiscount real default 0: Discount when placed after reliable stops.
calloutMargin real default 0: Penalty for the standby → call transition.
stopOnCaution real: Cost penalty for mandatory extended (stop-on) time.
voluntaryCaution real: Cost penalty for voluntary extended time.
deassignCost real: Cost penalty for deassigning a stop from this resource.
voluntaryDeassignCost real: Cost penalty for deassigning a voluntary stop.
deassignEarlyArrival timeInterval: Early-arrival allowance considered when deassigning.
minimumIncome real: Minimum income per hour the resource expects; weighs voluntary / standby work decisions.
stbyUsageFactor real: Weight affecting standby callout likelihood / cost during work hours.
stbyUsagePreWorkFactor real: Weight affecting standby callout likelihood / cost before work starts.
hostClockResolution timeInterval default 1 min: Resolution of roster-related stop times.
hostClockSpread timeInterval default 10 s: Spread applied to roster events.
stopOnMode IDLE | RELIABLE | ARVD | ONE | MAX: Mode for determining stop-on (extended-time) behaviour.
typicalStop stopParamsKey: Most common stop type attended (planning estimate).
typicalToStop stopParamsKey: Most common destination (to) stop type.
typicalLeadTime timeInterval: Typical idle time before the next work is available.
typicalTravelTime timeInterval: Typical travel time between stops.
typicalUsableTime timeInterval: Typical usable time at a stop.
leadFactor [dow: real]: Per-day-of-week multiplier on the typical lead time.
coreSkills [skill: null | real]: Core skills and proficiencies the resource provides.
exclusiveSkills [skill: null | real]: Skills exclusive to this resource (capacity / competition constraints).
secondaryActivity secondaryActivityObject: A secondary capability the resource can perform.
baseDeploy baseDeployObject: Controls base-deployment timing at the end of a shift.
surcharge surchargeObject: Additional costs for loaded vs unloaded travel.
planEarlyBase bool default true: Plan sign-off as early as possible.
alpha real default 0.0: Reserved / advanced — currently unused.
beta real default 0.0: Reserved / advanced — currently unused.
helix helixObject: Helix-specific presentation configuration (see below).

Helix extensions

The helix block is a Helix addition to the Spiral resourceParams (ignored by Spiral itself). It controls how the resource type is presented in the Helix client, plus server-side lifecycle hooks. onCreate / onDelete are "fnName()" specs resolved against the client crud module — see Backend hooks.

{

"icon": <string>,

"label": spec | null,

"nextEvent": spec | null,

"nextIncrements": spec | null,

"rosterStop": { [NOW | REST | STBY]: helixObject } | null,

"onCreate": spec | null,

"onDelete": spec | null,

}

icon string: Name of the map-marker icon rendered for this resource type (resolves to a canvas-rendered icon in the client).
label spec: Expression producing the resource’s display label (default resourceLabel()), with `this` = the resource.
nextEvent spec: Expression producing the resource’s next roster event summary shown in the resource editor (default helixNextEvent()).
nextIncrements spec: Expression producing the time-increment choices offered when adjusting the next roster event (default helixNextIncrements()).
rosterStop { [NOW | REST | STBY]: helixObject }: Per-roster-state overrides of the presentation (helix block) applied to this resource type’s roster stops — deep-merged over the core roster-stop defaults.
onCreate spec: Function called when a resource of this type is created live (after scheduling has started), with `this` = the resource.
onDelete spec: Function called when a resource of this type is deleted, with `this` = the resource being removed.

resourceParamsObject

Helix extensions

Related