Schedules Options and Features

The schedules feature allows you to manage and modify functioning schedules of various devices that are connected in a building.

• View, modify, delete numeric, boolean, string or enum schedules as required. 

• Create Special Events. Using a calendar style interface, schedule single dates, date ranges or weekly schedules. 

While you have the ability to discover schedules implemented in your data source, you can also create new schedules in KODE OS and sync them with your data source. 

After discovery you will be able to change schedules in KODE OS and those will be written back to your BMS controller. (KODE OS to BMS). Depending on the driver, updating schedules on the BMS will also synchronize with KODE (BMS to KODE OS). 

Create a New Schedule

• Go to the Schedules feature from the left hand navigation bar.

• On the first page you get to see the list of all existing schedules. To create a new schedule click on the “Create Schedule” button.

• On the “Create New Schedule” popup box give the schedule a name, select the data source and select the schedule type:

• Calendar Schedule

• Create Special Events and reference them on each Weekly Schedule.

• Weekly Schedule

• Boolean Schedule

• Numeric Schedule

• Enum Schedule

• String Schedule

• Once you have chosen the schedule type hit on Save.

Calendar Schedule

You can add exceptions to a typical schedule week by creating Calendar Schedules that can be referenced in more than one individual schedule to control various devices. This makes it much easier to manage holidays and other exceptions. All that is necessary is to change the calendar schedule rather than changing the individual schedules.

• Go to the Schedules feature from the left hand navigation bar.

• On the first page you get to see the list of all existing schedules. To create a new schedule click on the “Create Schedule” button.

• On the “Create New Schedule” popup box give the schedule a name, select the data source and select the schedule type - Calendar Schedule and then hit on Save.

You can expand the schedule to see the devices connected to it.

To add special events to the schedule click on the Edit button at the top right of the page and then click on “+ New Event”.

• On the “Add Special Event” page you can add events such as New Year’s Day:

• Select type - Date.

• Weekday - Any

• Day - 1

• Month - January

• Year - Any

• Using the Any Year feature allows you to create a holiday every calendar year going forward.

You can use different types of dates and customize them to meet your use cases.

• Click on Save to add the date. 

• Once you have the list of exceptions and holidays click on Save to save the changes and you are done! Now you have created your holiday calendar that you can use in more than one schedule.
  
  

What’s Next?

Now you can go into all the individual schedules that you want to reference the holiday calendar and add it as an exception to the regular calendar.

• Go to Schedules feature from the left hand navigation bar.

• Search and select the schedule you want to add the holiday calendar to.

• Go to the Special Events tab and click on the Edit button.

• Click on the “+New Event” button.

• On the Add Special Event page, give the event a name.

• Select Type - Reference, from the reference drop down list select the Calendar Schedule you want to add to the selected schedule and click on Save.

• The final thing to do here is to select the time slots for the dates that are listed in the holiday schedule. 

• Clicking on Holiday schedule will open up a side calendar block, clicking on it will open a drop down menu from where you can Create a Custom Event or All Day Event to make sure that on the holidays listed in the holiday schedule your regular schedule will remain unoccupied/false all day.

• Click on Save to add the dates as exceptions.

Weekly Schedule

To Create a Schedule for different devices that are connected in a building, follow the below steps:

• Go to the Schedules feature from the left hand navigation bar.

• On the first page you get to see the list of all existing schedules. To create a new schedule click on the “+ New Schedule” button.

• On the “Create New Schedule” popup box give the schedule a name, select the data source and select the schedule type:

• Weekly Schedule

• Boolean Schedule - which represents a binary value with only two states, such as off or on.

• Numeric Schedule - which represents a value, such as a temperature, level, rate or similar point numbers.

• Enum Schedule - which represents an enumerated state, more than two states such as off, slow, and fast.

• String Schedule - which represents one or more special characters.

• Once you have chosen the schedule type hit on Save.

• The schedule will be created and it will direct you to the Schedule view which is divided into three tabs (Weekly Schedule, Special Events, Properties). 

• Click on the Edit Schedule button to adjust the schedule to your preference.
  
  

Weekly Schedule tab - in the first tab you will see the weekly schedule, where you can schedule the things that run common each week.

• Clicking on the schedule block of each weekday it will open up a dropdown menu with three options: 

• Create Event - add the start and end time of the event, select the output value (e.g. Occupied or UnOccupied) and click on Save.

• All Day Event - if you want to add an all day event choose the All day event option and the output value you want to command devices with.

• Clear Week - this option will clear the events created within the week calendar.

• If you want to apply the same time slots for the whole week you simply click on the event and select apply Monday to Friday.

• Special Events tab - you can add exceptions or holidays to a typical schedule week by creating Special Events.

• To add special events to the schedule click on the Edit Schedule button at the top right of the page and then click on “+ New Event”.

• On the “Add Special Event” page you can add events such as New Year’s Day:

• Select type - Date.

• Weekday - Any

• Day - 1

• Month - January

• Year - Any - Using the Any Year feature allows you to create a holiday every calendar year going forward.

You can use different types of dates and customize them to meet your use cases.

• Click on Save to add the date. 

• Once you have the list of exceptions and holidays click on Save to save the changes.

• The final thing to do here is to select the time slots for the dates that are listed in the holiday schedule. To do so click on the event you have created to open up the side calendar block, clicking on it will open a drop down menu from where you can Create a Custom Event or All Day Event to make sure that on the holidays your regular schedule will remain unoccupied/false all day.

• Click on Save and you are done!

Properties tab - The schedule has a few configurable properties that can be used to modify the schedule details, set up the Effective Period (the start and end date the schedule will run), facets which will be displayed based on the type of the schedule.

• In the Point Reference section you get to select the devices you want to be controlled by the schedule.

• To pick points you want to reference in the schedule click on the “+ Add point reference” button.

• On the “Apply Point References” popup box select the Area, Device Type and Field.

• Click on Next and select the Points and Devices you want to reference to the schedule and click on the Apply Point Reference button.

• Click on Save and you are done!

On Type relation you can check the point relation to the data source, which can be Direct or Indirect. 

       Direct - when adding this relation type, KODE will try to save that reference on the data source.

       Indirect - it will only be part of KODE OS, and will not try to synchronize it with the data source.

Points table

Once points are picked, they will get displayed on a table. The table has the below columns:

• Source slot

• Will get the default value as out

• Point

• Name of the point

• Device

• Name of the device

• Type

• Strong - the point reference is synced and saved on the data source. 

• Weak - the point reference can not be synced with the data source. However, the reference will be available on KODE OS.

• Target slot

• The default target is 16, however you can get target slots values from 1 to 16.

• Trash Icon

• At the far right of each point you have the ability to remove specific rows and devices by clicking on the Trash Can icon. 

• Kind

• Displays the kind of the point like enum, boolean.

• Area

• Show at which area the point is found.

Schedules History

You can view logs for each version you save and in case you need to refer or switch to earlier versions you can easily
restore earlier versions. To do so follow these steps:

• Go to the Schedules feature from the left hand navigation bar.

• Search and select the schedule of your choice.

• Click on the History tab at the top right of the screen to see the version history.

• To revert to a previous version click on a timestamp and then click on Revert.

• The changes will be active immediately and pushed to the data source.

Schedules Discovery

Schedules Discovery allows you to explore data sources and select which schedules to import into KODE OS.

Navigating and using Schedules discovery

There are two main ways to access Schedules Discovery:

1. "Discover Schedules" button: Located in the “Schedules” module.

2. "Discover" button: Located in the “Data Source” module.

Performing “Schedule Discovery”

Clicking the “Discovery" button on the “Schedules" module and clicking the “Discovery" button from the “Data Source” module, will direct you to the same page. 

• Clicking “Discover” will prompt you to the data sources list.

• Select the data source from  which you want to discover schedules.

• There will be two buttons at the bottom to initiate the discovery process.

• The counts on the buttons represent the selected data sources that support the Device or Schedule discovery.

• Clicking “Discover Schedules” will initiate the process and a progress popup will be shown at the bottom right.

• On this page now you can see all the schedules that are coming from the data source where you performed discovery.

• They are divided in two parts the “New Schedules” and “Existing Schedules” where you can click to the tab to switch the view.

• New Schedules: Schedules that are discovered and not added to KODE OS yet.

• Existing Schedules: Schedules added previously to KODE OS.

•  Here you can search for a specific schedule by name or filter them out by using the tabs:

• All: Shows all the schedules.

• No time periods: Weekly schedules that do not have time periods setup.

• No references: Weekly schedules that don’t have device references.

• Duplicate references: Weekly schedules that have the same devices assigned in two or more schedules

• You can also filter further by clicking on the “Filters” button on the right side to use the classic filter options.

Schedules discovery table view

• The schedules discovery table view shows the list of schedules with information such:

• Schedule Name and Path

• Number of points

• Points/device references

• Current & Next Value

• Type

• Weekly or Calendar

• Special Events

• Number of special events

• If you want to view the point references for a specific schedule, click on the down arrow button to expand the view.

Note: The orange icon next to schedule point reference indicated that the point does not exist in KODE OS. Adding the schedule to the database will not add that point since it does not exist in KODE OS.

• In order to save or bring a schedule to KODE OS, select the one you desire on the check box, and click on the bottom blue button “Add to Database ''.

Click on the “Complete Discovery” button at the top right of the page to exit from the “Schedules discovery page”.

Schedules Calendar view

The Schedules Calendar View provides a visual representation of schedules across various timeframes, enhancing visibility and planning.

This dynamic view allows users to:

• Visualize Schedules: Switch between daily, weekly, and monthly views to manage schedules with both detailed and broad perspectives.

• Plan around special events: Easily see how holidays and special events impact schedules, allowing proactive adjustments.

• Streamline multi-schedule oversight: Compare multiple schedules side-by-side to understand overlapping activities and resource allocation.

Schedules Monthly view

The Monthly View is an addition to the current Schedules module which allows better visibility of schedules
across different and longer timeframes. 

Note: This doesn’t impact or change the weekly schedule functionality and behavior.
Monthly View is a view-only feature. Editing the schedule should be performed within the schedule details page.

Navigating Schedules Calendar view

The Calendar view can be accessed by navigating the Schedules module:

• Go to KODE OS.

• Select the site of your choice.

• From the main left side bar select “Schedules”.

• At the top of the “Schedules” page, you will see a “View switcher”:

• Schedule Table View and 

• Calendar View. 

• Click on the “Calendar view” option to switch the view to the calendar view.

Calendar view

In the calendar view of schedules, on the left side there is a list of schedules where you can choose
the schedules that you want to be appeared in the calendar view:

• Selecting a schedule it will be listed in the middle section, displayed as calendar events.

• You can switch to different views like “Days”, “Weekly” and “Monthly”. See the breakdown of the views in the Schedules Calendar views section of this article. 

• You also have the small calendar icon where you can click it and go to a specific date or scroll with the arrows. If you find yourself lost just click “Today” and the view will be set to the present day:

• You can also use the search bar to find your schedule, and the results will be listed on the left pane.

• Next to the search bar you have additional filters to be applied on the schedules that will be listed.

• You can select the first drop down menu to select between Weekly schedules and Calendar schedules:

• The schedule visible/hidden drop down menu allows you to filter them out according the view attribute:

• Also there you will see the “Filters” button which offers you to apply different filters like Kind, Area:

• To organize the view you can select what to be shown on the calendar view. You can select to view only “Weekly events”, “Special events” or to view them all.

Change your calendar view - day, week, or month

After you choose a new view, it becomes your default view until you change it.

Monthly View

• The events for the selected schedules will show up for each day

• If all the events can’t fit, there will be a “+… more” button that will show every selected schedule and their events.

• The “alarm icon“ is an indication that the event is a Special Event.

• You can click any schedule and go to schedule details.

Weekly View

• Weekly View will show all days of that week and all events for the selected schedules.

• Hovering over the name of the event will show the details for that event and the schedule.

• Special Events will be highlighted with an orange color.

Daily View

• The day view will show all the events for the selected schedules for that day.

Schedule functionalities that depend on the driver

In this section we will break down the functionalities and limitations of the Schedules Module that depend on the Niagara Driver installation.

Functionalities that are available when the driver is installed

1. You will get to see the list of all schedules that have been created.

1. Discover Schedules from the data source.

2. Filter the list of schedules to see Hidden, Visible or All Schedules.

2. Create Schedule

1. You can create new schedules directly from KODE OS by clicking on the “+New Schedule” button. Check this article here to learn more about Creating New Schedules.

3. Update Schedule

1.  Update Schedules time slots, add holiday schedules to the regular schedule and edit schedule properties by selecting the schedule of your choice from the list and then click on the “Edit Schedule” button.

4. Edit Schedule Details

1. Rename the schedule, assign an area to it by clicking on the 3 dots icon that shows up once hovering over each schedule name, from the drop down menu select “Edit Schedule” and you will be good to go.

5. See the Next Value change date & time and the value

1. On the “Next Value Change” column of schedules, you will get to see the next value that will occur, the date and time of occurrence as well as the value state.

6. Delete schedule

1.  Only the schedules created on KODE OS can be deleted. Click on the 3 dots icon that shows up once hovering over each schedule name, from the drop down menu select “Delete Schedule”.

Schedule Details

1. Create and Update Weekly Schedule Days

1. Create and Update time slots on the Weekly Calendar by selecting the schedule of your choice and then clicking on the “Edit Schedule” button.

2. Create, Edit and Delete Special Events

1. Create and Edit time slots on the Weekly Calendar by selecting the schedule of your choice and then clicking on the “Edit Schedule” button. Go to the Special Events tab to add new events, edit or delete the existing one/s.

3. Edit Schedule Properties

1. Go to Properties tab to create, update and delete effective period

2. Create, update and delete default value

3. Create, update and delete point enums

4. Create and update relations (Point referencing)

5. Sync scheduling properties

Functionalities that are available when the driver is not installed

1. You will get to see the list of all schedules that have been created.

1. Discover Schedules from the data source.

2. Filter the list of schedules to see Hidden, Visible or All Schedules.

2. Update Schedule

1.  Update Schedules time slots, add holiday schedules to the regular schedule and edit schedule properties by selecting the schedule of your choice from the list and then click on the “Edit Schedule” button.

3. You won’t be able to see the Next Value Change, Date & Time and the Value state.

Schedule details

1. Create and Update Weekly Schedule Days

1.  Create and Update time slots on the Weekly Calendar by selecting the schedule of your choice and then clicking on the “Edit Schedule” button.

2. You won’t be able to add Special Events.

3. From Properties tab - create, update and delete default value

4. Create and Update Relations (Point Referencing) 

1. Only Week references can be created if the driver is not there