Skip to content

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.

CommandPurpose
addAdds the following schedule object into Spiral.
updateUpdates the following schedule object within Spiral.
coerceUpdates a schedule object but temporarily forces specific resource assignments (manual override) before returning to optimised positions.
deleteRemoves a schedule object from Spiral, using only its id.
defineEstablishes reference data (a define object) — submit before schedule objects.
setConfigures properties (a set object) affecting the current Spiral run.
pauseHalts processing until specified conditions are met (primarily for testing).
commentA string for documentation within test scripts; ignored during processing.
checkValidates that schedule-object properties match referenced values (test success criteria).
refuteConfirms that schedule-object properties do not match referenced values (test validation).
tagAn integer to synchronise between Spiral and the host system.
includeSwitches the input source to load parameter files and licence keys, then resumes the normal input stream.