Workflow: Schedules
Schedules raise tickets on a repeating cycle, such as a monthly inspection of a set of assets. Each time the schedule comes due, it raises a ticket, or puts an existing ticket back into its starting status and queue.
This article will cover how a schedule runs and how to manage schedules. You can read about tickets in Workflow: Tickets.
Data model
How a schedule runs
A schedule comes due at its start time and every "Recurrence.Days" after that. Each time it comes due:
- If a ticket it raised is still in the schedule's status and queue, nothing happens. The work from the last cycle has not started, so no second ticket is raised.
- Otherwise, if "Reset.On" is true and the schedule has a ticket to put back, that ticket is moved back into the schedule's type, status and queue, with a new due date.
- Otherwise a new ticket is raised, with a new Entity of the type's Entity Type. When "Reset.On" is true, this ticket becomes the one that is put back on later runs.
Tickets are raised as the user who created the schedule, and the queue's user groups are notified as usual. The type must have an Entity Type set, or the schedule is skipped.
Requesting records
You can list every schedule, or only the schedules about a given Entity.
Get a list of schedules
Get schedule by ID
Create and update records
You can create a schedule by setting the ID as '0', or update one by its ID. When updating, only the properties you include are changed. Send null for "DueDate.Interval.Days" to remove the due date.
Create or update schedule
Delete a record
Deleting a schedule stops future runs. Tickets it already raised are kept.