A tool or component that enables planning, organizing, and managing events or tasks over time. Schedulers can display calendars, allow for date and time selection, and provide reminders, aiding in time management and event planning.
What is a Scheduler?
The Scheduler functions as an input node that enables users to log events, such as shifts or meetings, on a calendar. Despite being named a "scheduler," this node is passive and does not actively trigger events or generate production schedules. Instead, it records the type of event occurring at the current time and includes its start and end times in the JSON payload. This capability is particularly useful for tracking and documenting time-specific activities within the workflow, ensuring that event-related data is accurately captured and integrated into the system. By using the Scheduler node, users can enhance the contextual information available for analysis and reporting, supporting better time management and operational oversight.
Inputs
The Scheduler node has a mandatory input. This is:
|
Input |
Requirement |
Comments |
|
Data Field Name |
Mandatory |
Set the field name that will hold the event name. |
Functionality
The Scheduler node acts much like a calendar UI, allowing users to create and edit events. For example, one may create a recurring event called ‘Day shift’, which has a start and end time and recurs only on weekdays. The node itself is passive, however, and will not trigger when an event occurs. Instead, it adds information about any current scheduled events to the flow as data is passed through the node. The developer may then examine these values and make decisions accordingly.
The number and types of events are defined in the node when it is first created – only these events are available in the UI to the dashboard user. In addition, the node only returns one event to the flow. Since events may overlap, it must decide which event to return, and it does this based on the precedence level set for each event. For example, if ‘Day Shift’ (with precedence 2) and ‘Break’ (with precedence 1) occur simultaneously, the Scheduler node will return the details for ‘Break’. It is important, therefore, for developers to maintain details of obscured events (in this case ‘Day Shift’) if they must be accessed when a higher precedence event is occurring.
Outputs
The Scheduler node will add to the JSON file the start and end times and the schedule event name (or default value) that is active and has precedence at the current time.
How to Use
Implementation
In the Rayven Workflow Builder:
- Select Controls.
- Drag the Scheduler node to the canvas.
- Double click on the Scheduler node to open the configuration window.
Configuration
|
Section: General |
||
|
This section contains basic configuration elements required for any Scheduler implementation |
||
|
Field |
Requirement |
Comments |
|
Widget Name |
Mandatory |
This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose. |
|
Data Field Name |
Mandatory |
Set the output field name that will hold the event name. |
|
Start Time Field Name |
Mandatory |
Set the output field name that will hold the event start time. |
|
End Time Field Name |
Mandatory |
Set the output field name that will hold the event end time. |
|
Default Status |
Mandatory |
Set the value of the default status. This is a value that will be used to indicate that no scheduled event exists. |
|
Schedule Type Display Name |
Mandatory |
Enter the name of the schedule event type. |
|
Schedule Type Value |
Mandatory |
Enter the value of the event type. When the event occurs, it will be included in the JSON as a key-value pair. The value can be alpha or numeric and is used to differentiate the various event types. |
|
Schedule Type Precedence |
Mandatory |
This provides the Schedule node with an order of precedence (1 being the highest) to apply when events occur simultaneously. No two event types should have the same precedence value unless it is unlikely or impossible for them to occur together. For example, ‘Day Shift’ and ‘Night Shift’ may have the same precedence values as they will not occur simultaneously, however ‘Meal Break’ and ‘Day Shift’ can occur at the same time and so must have different values. If two events occur simultaneously with the same precedence, the outcome is unpredictable. |
You must identify at least one schedule type and can add additional signals by clicking on the ⊕ Add Value button.
|
Section: Tooltip Info |
||
|
Field |
Requirement |
Comments |
|
Show Tooltip |
Optional |
When checked, it allows users to display their tooltip text on the widget. |
|
Tooltip Text |
Optional |
This section only exists when “Show Tooltip” is checked. Users are able to write any tooltip message they desire which will be displayed on the widget. |