The table below lists the KODE OS modules and submodules, and describes what functions users are allowed to do for each Permission Name.
Modules | Submodule | Permission Name | Access Level | Description |
BuildingBI | Dashboards | Manage Collections | WRITE | Manage dashboard collections within BuildingBI. Includes:
|
BuildingBI | Dashboards | Get Dashboards | READ | Retrieve and view all dashboards within the BuildingBI module. Visibility can be restricted via:
|
BuildingBI | Dashboards | Create Dashboards | WRITE | Create new dashboards within the BuildingBI module. |
BuildingBI | Datasources | Get Datasources | READ | View all data sources (both physical and virtual) within the BuildingBI module. |
BuildingBI | Datasources | Create physical data sources | WRITE | Add data sources. |
BuildingBI | Datasources | Create virtual data sources | WRITE | Create virtual data sources by writing queries on top of data sources. |
BuildingBI | Datasources | Delete data sources | WRITE | Delete both physical and virtual data sources from the BuildingBI module. |
BuildingBI | Sharings | Share Links | READ | Generate public, shareable links to dashboards or widgets for external users. |
BuildingBI | Sharings | Delete Sharing Links | WRITE | Revoke or delete existing public sharing links. |
BuildingBI | Templates | Get Templates | READ | View and select from all available dashboard templates within BuildingBI. |
BuildingBI | Templates | Create templates | WRITE | Save dashboards or views as templates for reuse. |
BuildingBI | Templates | Delete templates | WRITE | Delete existing templates from the BuildingBI module. |
Buildings | Areas | Get areas | READ | View the Areas module in the side panel and list areas within a building. |
Buildings | Areas | Create areas | WRITE | Define and create new areas (zones, rooms, floors) within a building. |
Buildings | Areas | Create area dashboards | WRITE | Create dashboards specific to an area, accessible within the area detail page. |
Buildings | Areas | Delete areas | WRITE | Delete existing areas from the building layout. |
Buildings | Areas | Delete area dashboards | WRITE | Delete dashboards created within the context of an area. |
Buildings | Dashboards | Get dashboards | READ | View dashboards tied to a building (Old Dashboards tool). Displays the Dashboards module at the building level. |
Buildings | Dashboards | Create dashboards | WRITE | Create building-level dashboards (Old Dashboards tool). |
Buildings | Dashboards | Delete dashboards | WRITE | Delete building-level dashboards (Old Dashboards tool). |
Buildings | Datasources | Get data sources | READ | View the Data Sources module and see all configured sources within a building. |
Buildings | Datasources | Create data sources | WRITE | Create new data sources within the building context. |
Buildings | Datasources | Delete data sources | WRITE | Delete existing data sources from a building. |
Buildings | Datasources | Clear data source cache | WRITE | Manually clear the cached data of data sources. Useful for refreshing stale or outdated data. |
Buildings | Datasources | Discover data source devices | WRITE | Run device discovery from a data source, and import discovered devices, points, and schedules into KODE OS. |
Buildings | Devices | Manage device types | WRITE | Create, modify, or delete custom device types used across the platform. This is typically accessed via the Admin module. |
Buildings | Devices | Manage device and system attachments | WRITE | Attach or detach devices to systems or locations within a building. Enables relationships like "device is part of HVAC system". |
Buildings | Devices | Get device graphic templates | READ | View available device graphic templates (Old Graphics tool) for visual representation of devices. |
Buildings | Devices | Create device graphic templates | WRITE | Create new graphic templates for devices using the legacy graphics tool. |
Buildings | Devices | Delete device graphic templates | WRITE | Delete existing graphic templates used in the legacy (Old Graphics tool) system. |
Buildings | Devices | Get devices | READ | View the Devices module for a building and access all devices and their associated points. |
Buildings | Devices | Get device types | READ | View all available device types, including system-defined and custom types. |
Buildings | Devices | Get linked devices | READ | Retrieve the list of linked devices (device-to-device or device-to-system relationships). |
Buildings | Devices | Get building device graphics | READ | View the graphical representation of devices from the device details page (Old Graphics tool). |
Buildings | Devices | Update devices | WRITE | Modify device configurations, including metadata and mappings. |
Buildings | Devices | Delete devices | WRITE | Permanently delete devices from the building. |
Buildings | Devices | Delete device graphics | WRITE | Delete individual graphics assigned to devices in the Old Graphics tool. |
Buildings | Devices | Manage linked devices | WRITE | Access and manage the Linked Devices module (primarily used with myMSI integration), including creating or removing device associations. |
Buildings | Devices | Manage virtual devices | WRITE | Access the Virtual Devices page and create, update, or delete virtual devices (aggregated or logical devices built from multiple data points). |
Buildings | Devices | Manage device and point templating | WRITE | Access the Point Templating module and configure device/point mappings to standardized ontology templates. |
Buildings | Devices | Update device graphics | WRITE | Modify the device’s graphic in the legacy graphics interface (Old Graphics tool). |
Buildings | General | Manage attachments related to buildings | WRITE | View, upload, and delete documents or media files attached to buildings, systems, or devices in the Attachments section. |
Buildings | General | Get buildings | READ | View the list of buildings they are assigned to when logging into KODE OS. |
Buildings | General | Assign users to buildings | WRITE | Assign or revoke user access to specific buildings (typically managed by Admins or Portfolio Managers). |
Buildings | Miscellaneous | Get notifications | READ | Retrieve and view system-generated notifications (alerts, updates, warnings) related to buildings. |
Buildings | Miscellaneous | Get geocode address | READ | Retrieve the geolocation and address of a building using reverse geocoding. |
Buildings | Miscellaneous | Get weather data | READ | Retrieve real-time weather data integrated with the building's location. |
Buildings | Points | Get points | READ | Access the Points module and view all points (sensors, commands, statuses) associated with devices. |
Buildings | Points | Get point units | READ | View the measurement units associated with points, typically visible in Admin settings. |
Buildings | Points | Update points | WRITE | Modify point configurations, such as renaming, reconfiguring units, or modifying descriptions. |
Buildings | Points | Delete points | WRITE | Remove points from a device or system. |
Buildings | Points | Write points | WRITE | Send commands or perform manual overrides on writable points (e.g., temperature setpoints, mode changes). |
Buildings | Points | Manage point units | WRITE | Create, edit, or delete custom point units used across devices. |
Buildings | Systems | Get systems | READ | Access the Systems module and view the list of mechanical, electrical, or logical systems in a building. |
Buildings | Systems | Create systems | WRITE | Define and create new systems within a building. |
Buildings | Systems | Delete systems | WRITE | Remove systems and their relationships from a building. |
Buildings | Tags | Delete tags | WRITE | Delete tags from the Admin module. Tags help categorize and search for building elements like devices or points. |
Buildings | Tags | Create tags | WRITE | Create new tags within the Admin module for classifying assets, devices, and other elements. |
Buildings | Tags | Get tags | READ | View all existing tags in the Admin module. |
EnerG | Building_Dashboards | View Building Performance Tab | READ | Access and view energy performance metrics for a specific building (consumption, efficiency, trends). |
EnerG | Building_Dashboards | View Building Cost & Billing Tab | READ | View energy cost breakdowns and billing-related metrics for a building. |
EnerG | Building_Dashboards | View Building Demand & Load Tab | READ | View demand response metrics, peak load data, and load profiles for a building. |
EnerG | Building_Dashboards | View Building Data Quality Tab | READ | View data completeness and accuracy insights for meters and devices in the building. |
EnerG | Building_Dashboards | View Building Carbon Metrics Tab | READ | View carbon emissions and environmental impact metrics derived from energy use. |
EnerG | Building_Dashboards | View Building Interval Data Tab | READ | Access interval data (e.g., 15-min, hourly) for energy readings per building. |
EnerG | Building_Dashboards | View Building Data Table Tab | READ | View raw or summarized energy data in tabular format at the building level. |
EnerG | General | View Energy Hub | READ | Access the Energy Hub module where energy analytics across buildings are centralized. |
EnerG | General | Edit Energy Hub | WRITE | Configure, customize, or update data sources, settings, and KPIs in the Energy Hub. |
EnerG | Portfolio_Dashboards | View Portfolio Performance Tab | READ | View aggregated performance metrics across all buildings in the portfolio. |
EnerG | Portfolio_Dashboards | View Portfolio Cost & Billing Tab | READ | View total and comparative energy costs and billing summaries across the portfolio. |
EnerG | Portfolio_Dashboards | View Portfolio Data Table Tab | READ | View a table of energy data across the entire portfolio for analysis and export. |
Maintenance | Dashboard | Get Dashboard | READ | Access and view the Maintenance dashboard, including KPIs and overview metrics. |
Maintenance | General | Get Maintenance | READ | Access the Maintenance module and visibility of maintenance-related records. |
Maintenance | Notification_Policies | Get Notification Policies | READ | View rules and configurations for automated maintenance-related notifications. |
Maintenance | Notification_Policies | Update Notification Policy | WRITE | Create, edit, or deactivate maintenance notification rules and policies. |
Maintenance | Schedule_Logs | Get Schedule Logs | READ | View the execution history and logs of preventive maintenance schedules. |
Maintenance | Schedules | Get Schedules | READ | View the list of preventive maintenance schedules configured for devices or systems. |
Maintenance | Schedules | Create Schedule | WRITE | Define and create a new recurring or one-time maintenance schedule. |
Maintenance | Schedules | Run Schedule | WRITE | Manually trigger or execute a configured schedule. |
Maintenance | Schedules | Delete Schedule | WRITE | Delete existing maintenance schedules. |
Maintenance | Task_Templates | Get Task Templates | READ | View predefined maintenance task templates that standardize task creation. |
Maintenance | Task_Templates | Create Task Template | WRITE | Create new templates for recurring maintenance tasks. |
Maintenance | Task_Templates | Delete Task Template | WRITE | Delete existing task templates. |
Maintenance | Tasks | Get Tasks | READ | View all maintenance tasks, including statuses, assignees, and priorities. |
Maintenance | Tasks | Create Task | WRITE | Manually create new maintenance tasks, either ad-hoc or based on triggers. |
Maintenance | Tasks | Update Task Status | WRITE | Change the status of a task (e.g., from Open to In Progress or Completed). |
Maintenance | Tasks | Update Task Assignee | WRITE | Reassign maintenance tasks to different users or teams. |
Maintenance | Tasks | Delete Task | WRITE | Delete a maintenance task from the system. |
Maintenance | Tasks | Create Work Order | WRITE | Create a work order linked to a maintenance task for external vendor or internal fulfillment. |
Modules | Admin | Access admin panel | READ | Access the Admin panel from the portfolio view. |
Modules | Audit | Create audit templates | WRITE | Create new Audit tables in the Admin module of a building. |
Modules | Audit | Get audit templates | READ | Access the Audit module and see the created tables. |
Modules | Audit | Delete audit templates | WRITE | Delete Audit tables in the Admin module of a building. |
Modules | Connectivity | Create tunnel | WRITE | Create a tunnel in the Connectivity module. |
Modules | Connectivity | Delete tunnel | WRITE | Delete a tunnel in the Connectivity module. |
Modules | Connectivity | Get tunnels | READ | Access the Connectivity module and see the created tunnels. |
Modules | Dashboards | Get dashboards | READ | View the Dashboards module when they navigate to a building and see the list of dashboards of that building (Old dashboards tool). |
Modules | Dashboards | Create dashboards | WRITE | Create dashboards inside a building (Old dashboards tool). |
Modules | Dashboards | Delete dashboards | WRITE | Delete dashboards inside a building. |
Modules | Dashboards | Share widgets | WRITE | Create a shareable link for a widget in a dashboard. |
Modules | Deployment_Audit | Get deployment audit reports | READ | Access the Deployment Audit module. |
Modules | Deployment_Audit | Get deployment audit report details | READ | Access the Deployment Audit report for a certain building. |
Modules | Deployment_Audit | Create deployment audit report | WRITE | Create the Deployment Audit report for a certain building. |
Modules | Energy_Dashboard | Get energy dashboard | READ | Access the old Energy Dashboard from the top main bar. |
Modules | FDDV2 | Notify users through phone call | READ | Initiate phone calls to notify users about important events. This feature allows for direct communication, ensuring timely awareness. Use this to keep users informed when immediate action is needed. |
Modules | FDDV2 | Notify users through text message | READ | Enable users to receive event notifications via text message. This permission allows the system to send SMS alerts to designated recipients when specific events occur. It facilitates real-time communication of critical updates. |
Modules | FDDV2 | Get FDD events | READ | Track events and receive associated notifications. This permission allows users to stay informed about important occurrences within the system. It helps with proactively responding to changes and maintaining operational awareness. |
Modules | FDDV2 | Get FDD routines | READ | View the list of custom Routines used for equipment monitoring. It does not grant the ability to create or modify Routines. |
Modules | FDDV2 | Get FDD configs | READ | View the configurations of your Fault Detection and Diagnostics (FDD) system. See which routines are enabled for monitoring equipment. This access allows users to understand the system's monitoring setup. |
Modules | FDDV2 | Get FDD notification policy | READ | See a list of all notification policies. These policies define who receives notifications, the content of the message, and the delivery method (email, push, SMS, or phone call). |
Modules | FDDV2 | Acknowledge FDD events | WRITE | Mark an event as acknowledged to indicate that it has been seen. This action signals that the appropriate process will be followed to address the issue. |
Modules | FDDV2 | Create FDD notification policy | WRITE | Create and modify building-level notification policies. Define who receives notifications, the message content, and the delivery method, such as email, push, SMS, or phone call. This allows for tailored communication strategies within each building. |
Modules | FDDV2 | Delete FDD notification policy | WRITE | Delete notification policies at the building level. This action permanently removes the policy and prevents notifications from being sent based on its rules. |
Modules | FDDV2 | Create FDD Portfolio notification policy | WRITE | Create and modify notification policies at the portfolio level. These policies define who receives notifications, the message content, and the delivery method such as email, push, SMS, or phone call. Applying these policies at the portfolio level allows for reuse across multiple buildings. |
Modules | FDDV2 | Delete FDD Portfolio notification policy | WRITE | Delete notification policies that are applied at the portfolio level. This action removes the policy from all buildings where it's being used. |
Modules | FDDV2 | Create FDD routines | WRITE | Create custom routines using the logic block programming tool. This allows users to automate building operations based on specific conditions and schedules. |
Modules | FDDV2 | Create FDD configs | WRITE | Configure FDD settings to define which equipment is monitored and establish the thresholds for alerts. |
Modules | FDDV2 | Delete FDD routines | WRITE | Remove custom-created FDD routines. This action does not affect routines from the library. |
Modules | FDDV2 | Import Export FDD routines | WRITE | Import and export routines between portfolios. This allows partners to manage their custom libraries. |
Modules | FDDV2 | Update FDD Portfolio Dashboard Filter Preferences | WRITE | Set default filters on the portfolio-level FDD dashboard for all users. |
Modules | FDDV2 | Update FDD Building Dashboard Filter Preferences | WRITE | Set default filters for other users on the building-level FDD dashboard. |
Modules | FDDV2 | Update FDD Ack Event Preferences | WRITE | Set the portfolio-level service level agreement (SLA) response time for acknowledging events and comment requirements. |
Modules | FDDV2 | Send external-push | WRITE | Send manual push notifications to third-party systems, typically used to integrate FDD events with work order platforms. |
Modules | FDDV2 | Update/Hide priorities | WRITE | Customize the names and colors used to represent priorities within the portfolio. This allows for a tailored experience that better suits organizational needs. Visual customizations also help users to quickly distinguish between priorities. |
Modules | FTT | Get FTT workflows | READ | View a list of the custom workflows used to perform functional tests on equipment. This permission allows users to understand the testing procedures. |
Modules | FTT | Create FTT workflows | WRITE | Create custom functional testing workflows using the logic block programming tool. This allows users to design specific tests to validate building system performance. These workflows help maintain optimal building operations. |
Modules | FTT | Delete FTT workflow | WRITE | Remove custom functional testing workflows that were created by users. This action does not affect workflows available in the shared library. This permission helps maintain a clean and organized testing environment. |
Modules | FTT | Archive FTT tests | WRITE | Mark a result as archived. This action is commonly used during initial setup or when handling inconclusive results. Archiving helps maintain data organization. |
Modules | FTT | Run manual test | WRITE | Test the functionality of a specific device. This allows for targeted troubleshooting and verification of device performance. |
Modules | FTT | Import and Export FTT Workflows | WRITE | Import and export workflows to manage custom libraries across portfolios. This feature enables partners to efficiently share and utilize workflows. This helps maintain consistency and saves time when building out solutions. |
Modules | FTT | Update FTT concurrently running test limit | READ | Set the number of devices tested concurrently within a single task. This permission allows adjustment of this value between 1 and 5, overriding the default limit of 3. |
Modules | FTT | Get FTT projects | READ | View all FTT projects created for the building or portfolio. This permission allows users to see all projects associated with the selected building or portfolio. |
Modules | FTT | Run/Stop tasks manually | WRITE | Control the manual start or stop of testing after a scheduled project has been enabled. This allows for immediate adjustments to the testing schedule as needed. |
Modules | FTT | Create FTT Projects | WRITE | Schedule tests across multiple devices, encompassing various floors or an entire building. This allows for comprehensive testing coverage, ensuring thorough system evaluation. |
Modules | FTT | Update FTT Portfolio Dashboard Filter Preferences | WRITE | Set default filters on the portfolio level dashboard. This allows users to customize the dashboard view to display specific information. These filters are then applied to all users within the portfolio. |
Modules | FTT | Update FTT Building Dashboard Filter Preferences | WRITE | Set default filters for other users on the building level dashboard. This allows for a consistent view of building data. Users will see the specified filters applied when they access the dashboard. |
Modules | FTT | Get FTT history | READ | View test results. This permission allows users to access and see the data from tests performed within the system. It is a fundamental permission required for monitoring and analysis. |
Modules | GraphicsV1 | Get Old Graphics (V1) | READ | This permission controls the ability to see old graphics in system and device details. It should not be checked because the new tool is available. |
Modules | GraphicsV2 | Get Graphics | READ | This permission controls the ability to see new graphics in the system, and device details. |
Modules | GraphicsV2 | Edit Graphics | WRITE | Access the Graphics module (new Graphics tool) from the main left menu and the edit option on floorplans, system, and device graphics. Also, allows the user to modify graphics and everything related to graphics. |
Modules | Marker_Icons | Manage marker icons | WRITE | Modify marker icons in the old Graphics tool from the Admin panel. |
Modules | Marker_Icons | Manage categories | WRITE | Modify the categories of marker icons in the old Graphics tool from the Admin panel. |
Modules | Marker_Icons | Get marker icons | READ | View the categories of marker icons in the old Graphics tool from the Admin panel. |
Modules | Marker_Icons | Manage marker styles | WRITE | Manage the styles of markers inside the edit mode of the old Graphics tool. |
Modules | MassWrite | Initiate schedule mass write | WRITE | Initiate a job for mass modifying schedules on the buildings they have access to. Accessible from the portfolio view of KODE OS. |
Modules | MassWrite | Get schedules latest configs | READ | View the past jobs for modifying schedules. Accessible from the portfolio view of KODE OS. |
Modules | MassWrite | Get points latest configs | READ | View the past jobs for writing points. Accessible from the portfolio view of KODE OS. |
Modules | MassWrite | Initiate point mass write | WRITE | Initiate a job for mass writing points on the buildings they have access to. Accessible from the portfolio view of KODE OS. |
Modules | MultiTrend | Get Trends | READ | Access the Trends module. |
Modules | MultiTrend | Publish Configurations | WRITE | Create views on the Trends module. |
Modules | SchedulesV2 | Get schedules | READ | View the Schedules module and schedules list and details of a building. |
Modules | SchedulesV2 | Discover schedules | WRITE | Discover schedules from the data sources and import them to KODE OS. |
Modules | SchedulesV2 | Update schedules | WRITE | Update schedules. |
Modules | SchedulesV2 | Duplicate schedules | WRITE | Duplicate a schedule. |
Modules | SchedulesV2 | Create schedules | WRITE | Create new schedules. |
Modules | SchedulesV2 | Sync schedules | WRITE | Sync schedule updates from the data source. |
Modules | SchedulesV2 | Delete schedules | WRITE | Delete schedules. |
Modules | Users | Assign buildings to users | WRITE | Assign buildings to users in the Admin panel. |
Modules | Users | Get users | READ | View the list of users in the Admin panel. |
Modules | Users | Create users | WRITE | Create new users in the Admin panel. |
Modules | Users | Delete users | WRITE | Delete users in the Admin panel. |