Scheduler Node

Scheduler Node

The Scheduler node acts like a calendar interface, allowing users to create and edit events. For example, in a factory setting, you could create a recurring event called 'Day shift' with a set start and end time that recurs only on weekdays. You must define the number and types of events in the node when it is first created: only these events will be available to dashboard users in Rayven Live. 

Only one event will be returned to the workflow by this node. Since events may overlap, the precedence level set for each event determines which event the node returns. For example, if 'Day Shift' (precedence 2) and 'Break' (precedence 1) happen simultaneously, the Scheduler node would return the details for 'Break'. You need to maintain the details of obscured events (in this case, 'Day Shift') if you require access to them when a higher precedence event is also occurring.

The Scheduler node adds the start time, end time, and schedule event name for the currently active and highest precedence event to the JSON file. You can then examine these values and run calculations or make decisions. This node does not trigger events or enable the creation of production schedules. 

"type": "Day",
"startTime": "9/7/2020 6:15:00 AM",
"endTime": "9/7/2020 2:45:00 PM"

Adding a Scheduler node to your workflow

1. First, select your desired solution and navigate to Rayven Workflow.
2. Select ‘Controls’ from the left-hand panel.
3. Find the Scheduler node and drag it onto the canvas.
4. Provide input to the Scheduler node by connecting it to another node
5. Double click on the Scheduler node to open its configuration window.

Configuring your Scheduler node

1. First, give your node a Name. Choose something simple that clearly explains its purpose.
2. Under Data Field Name, enter the field in the JSON payload that contains your event names. 
3. Under Start Time Field Name, enter the field holding the event start time.
4. Under End Time Field Name, enter the field holding the event end time. 
5. Enter a field name for the Default Status. A value will be output to this field when no event exists.
6. Enter the Event Type Name. You must identify at least one schedule type and can add additional events by clicking '⊕ Add Value'.
7. Enter an Event Type Value to differentiate your event type. When the event is occuring, this value will appear in the JSON output. It can be alpha or numeric.
8. Finally, you must set the Precedent Level for each event. If multiple events occur at once, the node will display the event with the highest precedence value (1 being the highest).
   • No two event types should have the same precedence value unless it is unlikely or impossible they will occur together. For example, ‘Day Shift’ and ‘Night Shift’ will not overlap and can have the same precedence values. However, ‘Meal Break’ and ‘Day Shift’ are not mutually exclusive and must have different values. 

Using the Scheduler Node in Rayven Live

With a scheduler widget showing on a dashboard, double-click on the time to create a new event:

You can give your event a name, add start and end times, configure repetition, add explanatory notes, and select the event Status. The 'Status' dropdown will allow you to choose between the different 'Status' types predefined in the Rayven Workflow Manager. For example, 'Day Shift', 'Break' or 'Nightshift'. You can also edit an existing entry by double-clicking.

If you configure events to recur weekly, you can select on which days events occur. You can specify the day or date for monthly recurrences and the day, date, and month for yearly repetitions.