KODE OS navigation is organized into two primary ways. The left hand navigation bar provides access to modules and functionality. And then within each building there are widgets guiding you to details of the building operation. Below we walk through each major navigational component.
Once you login to KODE OS, the page you land on is the Sites page.
The Sites page includes all building cards and allows you to navigate to building dashboard pages.
Building Cards display the name of the building, status of device, and active events in a specific building.
Clicking on the Devices down button will directly take you to a list of filtered down devices.
Clicking on the Active events button will directly take you to a list of active events in the FDD Dashboard.
To go to a building of your choice you can search for buildings on the search bar located at the top of the building card list.
Next to the search bar, you will find a sorting button. Clicking on that button allows you to sort by Active Events and Down Devices, Building Name and Creation Date. These can be sorted further by order - Ascending and Descending.
The Sites page also includes the map view.
Clicking on the address of a building in the building card will take you to the pin of that location.
Clicking on one of the pins will show the building card on which you can click to get to the Building Dashboard, as well as what type of events are active in that specific building.
You can navigate to all features through the left navigation bar.
Click on the Dashboard icon to navigate to the site or portfolio dashboard feature.
Click through the different tabs at the top of the page to get to different types of insights.
Click on the three dots button on the top right corner to add new dashboards, add new widgets or edit existing ones.
Clicking on the Schedules module from the main sidebar of a site will take you to the Schedules feature.
This will take you to the schedules list where you can duplicate, hide, edit or delete a schedule. From here you can Create a new schedule as well or Discover Schedules from data source.
Clicking on the Schedules Batch Update button will direct you to a new page from where you can edit schedules in batch.
Clicking on each of the existing schedules will display its details and properties, point trends, weekly schedule and special events. To edit the details click on the Edit button and apply the changes.
Clicking on the Point Reference button will display all points associated with the selected schedule. From here you can add new points by clicking on the Edit button and then on the Add point references button.
Clicking on the Discovery button on the top right will initiate a discovery of all devices that have embedded scheduling functions.
Clicking on the Calendar button on the top right will display a calendar view of existing schedules. The calendar can be displayed in a monthly, weekly, daily, and list view.
Clicking on the Bell icon will take you to the Events feature.
On top of the page, you have four cards showing all active events in their respective categories; critical, warning and alerts.
In all of these cards you will also see the number of acknowledged (abbreviated as Acked) and unacknowledged (abbreviated as UnAcked) events.
Below the event cards you will find a number of filters as drop down menus from which you can select: Type, Class, Status, Acknowledgement and Time Period. These options will filter out the events list below them.
Clicking on the three dots button will give you two actions:
Create Events: This gives you the ability to create and configure events of your liking from existing routines.
Routines: This gives you the ability to view all the routines available in KODE OS, as well as to edit them to your liking.
Click on the Audit module from the main left sidebar to navigate to the Audit feature.
A menu of Audit logs will be displayed on the left side showing all audit templates created for that specific building.
Clicking on the three dots button will give you the ability to Add New Template, Edit Template, Export CSV, and Delete Template.
When adding a new template you will be given the option to add it for Multiple Buildings or the selected (This) Building.
After giving the Audit template a name and a description you will be shown filters, to help you select the devices and points (Entities and fields) of your liking.
On top of the list of the audits you are able to search the type of device through the search bar.
Click the button on top right to enable the graph view of Audit Logs.
Click the graph button next to any of the points you wish to see to enable their graph on the right side of the page.
Clicking on the button on the top right displays available settings for the Audit page.
This allows you to export the selected data as a CSV file and to change the template of data being presented in the audit.
Through this button you are also able to add a new template or delete an existing one.
Go to Portfolio view and Click on the settings icon to navigate to Settings feature.
A menu will be displayed on the right including the option to navigate to:
Buildings:
A list of all buildings will appear.
Once you have selected a building of choice, you will see four options on the top right of the screen:
Details - View building information.
Areas - you can see and edit building areas.
Users - you can see, edit and remove building users. Also you can assign/unassign users from the building.
Files - add or modify Floor Plan files, Device files and BIM Models.
Users:
A list of all users will appear.
To add a new user, click on the plus icon on the bottom right, input the user details and click on Save.
Once you have selected a user of choice, you will see two options on the top right of the screen:
Details - you can view and edit user details.
Buildings - you can see all buildings that the user is assigned to, and assign/unassign buildings from the user.
Device Types:
A list of all device types will appear, you have the ability to edit existing types or add additional ones.
Units:
A list of all units available in the platform will appear, you have the ability to add a unit or delete any of the existing ones.
Tags:
A list of all device tags will appear, along with their descriptions. You have the ability to add new tags as well.
Events:
A list of event classes, their descriptions, and user roles which are assigned by default to them, will appear.
On the top right, you have the ability to switch tabs, and go to the Types section, to view all event types available, as well as add new ones through the plus icon on the bottom right.
Marker Icons:
We have added a list of Default Icons on the KODE Library tab for each device type and status, which you can use in floor plans and system graphics. However, you can also add your customized designs through our Custom Library tab.
Each icon visualizes a specific value/state according to the given range, which you can customize your own designs through the Custom Library tab.
On the All Icons tab you will see all the available icons that you can use.
Write multiple points or schedules simultaneously across a building or an entire portfolio!
The Mass Write feature is accessible from the portfolio level view of the KODE OS app.
When you visit the module for the first time, there will be nothing shown on the list. Once you start using this feature you will see the previous mass write actions (Jobs) listed here.
Clicking on the Write Point or Write Schedules button will redirect you to the Mass Write page. In the left side of the screen there will be a dialog from where you can filter to narrow down your query and then click Apply to access the points/schedules you want to write in bulk.
Select the points or schedules you want to set values for and click on Continue. Set the values and click Execute.
The Deployment Audit report is a snapshot of the deployment status on a building basis which gives you an easy to follow user-experience providing all configuration/integration features in one place and showing what is done and remains to unlock the full functionality of KODE OS.
Deployment Audit consists of two main parts:
Portfolio Score - the average score of the overall report per building
Overall Report - showing comprehensive data of what we have and where we stand in the integration part.
Total aggregation of the subitems/configuration features. Each widget shows what is done and what remains.
E.g: In the Devices progress report, one of the widgets we can see is “Area Assignment” - the number of devices that have Area Assignment.
Aggregated data of configuration features, expressed in numbers.
E.g: In the Devices progress report, one of the widgets we can see is “By Type” - the number of devices that belong to each device type.
A Graphic builder that gives you the ability to build Systems and Device graphics, and customize floor plans.
Smart Markers provide for dynamic features and logic to be added to the marker configuration, such as color-coded point ranges, adding greater value within graphics pages.
Easily create a table in a few clicks! Table views that list the points from certain devices can now be included in floor plan, device and system graphics.
Draw zones, choose which devices will control the zones, and how they will be colored. Now you won’t have to hard code them and you’ll be able to configure everything in the Graphics module.
The “Hover-over” feature allows users to reference multiple points in the marker, but only show one by default. The other points will show when the user hovers over it. This functionality can be used for Smart Markers and default markers. Also, you can hide marker headers or labels and on the hover they will show. When used with Smart Markers, this functionality allows users to see the Device name and navigate to Device Details.
You can create and modify System drawings within KODE OS:
There is a library of drawing elements which you can drag and drop to create a System graphic.
Drawing elements are single components such as pipes, valves, pumps and other component parts of the system.
Dragging components onto the graphic canvas will allow the creation of a System drawing.
You are not limited when adding system or floor plan layers, and can create any layer you may want.
Simply batch-select the markers by dragging the mouse or clicking on them, and perform batch updates to the marker properties.
Preventive maintenance are routine procedures that help reduce equipment failure and unplanned downtime.
If you click on Settings from the left sidebar you will see 2 categories of tasks:
Maintenance Tasks - the repairing or servicing tasks that restore equipment to optimal condition.
Inspection Tasks - an assessment of equipment conditions and performance without actually performing any servicing or corrective action.
The Preventive Maintenance Dashboard module is designed to provide an overview of maintenance and inspections activities. It features a variety of visualized charts and tools to help you monitor, manage, and analyze tasks.
In the Tasks section, you'll find a comprehensive list of all pre-created maintenance tasks. You can browse through the tasks or use the search function to find specific tasks.
A preventive maintenance schedule gives you a framework to organize all the preventive maintenance needs throughout your organization.
The Schedule Logs module provides a comprehensive list of all your triggered schedules. From this list, you can select a specific schedule log to view the status of each task and visualize the overall progress.
In order to obtain a visual representation of device placement throughout major systems and interact with the devices directly, you can rely on the Systems module.
Upon selecting the System you will be directed to the System Details view. At the bottom of the right navbar you can change your point of view to:
Graphics view - graphical overview of the system.
Dashboard view - from where you can see all System points visualized on charts.
Widget view - from where you can see all System devices and their points.
To Edit system graphic and device placement click on the 3 dots icon at the top right of the system.
Once clicking it you will be directed to the system edit mode from where you can modify and add more devices to the system graphic.
In areas you can view all available areas that you have in your site like floors or parking lots etc.
Once you are in the Floor Plan view you will be prompted with several options and features that you can benefit in order to enhance your experience.
Each floor plan has its own widget represented with a graphical view.
You will see laysers for each device type, including but not limited to:
HVAC
Lighting
Fire Detection
The FDD Events window showcases all area events, mirroring the information available in the FDD feature, with the only difference being that you will only see events related to the selected area.
Devices in a selected building can be accessed and managed through the Devices tab, allowing for filtering, batch updates, device details, history, and interaction with device points, with export options for charts and a right-hand sidebar for additional device information and management tools.
Clicking on the Devices from the left main sidebar of a site you will be redirected to the Devices list.
On the top right corner you can find a three dots menu where you can open the options that you can access for devices:
Devices Batch Update - Here you can update devices in a batch by selecting their type or area.
Points Batch Update - Redirects you to the point batch update feature.
Virtual Devices - On this option you enter the virtual devices where you can view and manage the virtual devices you create or want to create.
Linked Devices - Here you can see devices that are linked with the devices from myMSI.
Device Details helps you to determine device performance, status, history and allows you to interact with devices in order to adjust their functioning with the aim of increasing optimum performance.
Points represent specific data values (e.g., temperature, humidity, status) that are essential for monitoring and controlling building systems.
Clicking on Points from the left main sidebar of a site you will be redirected to the Points list.
On the top right corner you can find a three dots menu where you can open the options that you can access for points:
Write Multiple Points: Command multiple points simultaneously.
Points - Batch Update: Update points in batch.
Data sources are systems or devices that generate and provide raw data, such as sensors, databases, or external APIs, which are collected and used for analysis, reporting, or automation within KODE OS.
KODE OS integrates with these data sources to enable seamless data collection.
Clicking on Data Sources from the left main sidebar of a site you will be redirected to the Data Sources list.
On the top right corner you can find a “Add Data Source” option and a three dots menu:
Add Data Source: This will redirect you to the list of all existing APIs from where you can select the one you want to add.
Test Connections: Verifies whether the connection to the data source is functioning properly, ensuring that data can be accessed or retrieved successfully.
Discover: Searches for available data points, devices, or systems connected to the data source, allowing you to bring them into KODE OS.
Refresh Cache: Updates or refreshes the locally stored data by reloading it from the data source to ensure the most current information is available without delay.
At the bottom left of the Data Sources page, you will see the API Catalog. This is a central list where you can find all the available APIs, along with useful details like descriptions, endpoints, authentication methods, and how often data is collected.
Click on the Notification button to view all Event Notifications coming through for the buildings you're assigned to.
Click on the Question Mark button to navigate to the Knowledge Base or provide feedback to our team.
Click on the User Profile button to navigate to your User Profile details.
Click on the Manage Account button which will take you to a page where you can manage all of your account details through the General Information.
Click on Session to view your login session, and end any of the active sessions.
Click on the Switch Organization button on the top right to navigate to any other organization you are assigned to.
Click on the Logout button on the top right to log out of KODE OS.