Input stream
The input object is the primary container for operations sent to the Spiral Scheduler. It accepts one or more of the following command types.
Command types
Section titled “Command types”| Command | Purpose |
|---|---|
add | Adds the following schedule object into Spiral. |
update | Updates the following schedule object within Spiral. |
coerce | Updates a schedule object but temporarily forces specific resource assignments (manual override) before returning to optimised positions. |
delete | Removes a schedule object from Spiral, using only its id. |
define | Establishes reference data (a define object) — submit before schedule objects. |
set | Configures properties (a set object) affecting the current Spiral run. |
pause | Halts processing until specified conditions are met (primarily for testing). |
comment | A string for documentation within test scripts; ignored during processing. |
check | Validates that schedule-object properties match referenced values (test success criteria). |
refute | Confirms that schedule-object properties do not match referenced values (test validation). |
tag | An integer to synchronise between Spiral and the host system. |
include | Switches the input source to load parameter files and licence keys, then resumes the normal input stream. |
Referenced sub-objects
Section titled “Referenced sub-objects”- inputObject — the full command container
- Schedule object (resource / project / stop / desk)
- Define object
- Set object
- Pause object
- Include object