To access the Points Module, go to your site and then select the "Points" module from the left menu.

   Within this module, you’ll find three options:

• Point Statuses

• Point List

• Batch Update Points

Point Statuses Section

The Points Status section provides a detailed overview of the performance and state of various points within your system. These points represent sensors or components that form the backbone of your smart building operations.

Status Overview:

At the top of the Points Status interface, you’ll find a quick summary of the system's current health, represented by categories such as:

• OK: Indicates the number of fully operational points.

• Down: Lists points that are currently not communicating or are inactive.

• Fault: Highlights points that are active but reporting an error.

• Disabled: Shows points that have been manually or automatically turned off.

• No Value: Includes points that currently are not reporting any values.

• Overridden: Tracks points that have overrides applied.

• FDD: (Fault Detection and Diagnostics) Points flagged for further investigation based on KODE OS-specific rules/routines.

This overview allows you to quickly assess the general state of your system at a glance.

Search and Filter Capabilities:

The search bar on the page makes it easy to locate specific points by name. This is especially useful when working with large devices containing thousands of points. You can narrow down the results to focus on a specific area, device, or type of point.

Each of these status categories is interactive and can be used as a filter. Clicking on any status, such as OK, Stale, Fault, etc, will reorder the table below to display only the points within that category. 

Point Details Table:

The table provides detailed information about each point, including:

• Name: The identifier for each point, often tied to specific devices or locations.

• Value: The current status or reading of the point, such as "Inactive," "0%," or specific data values.

• Field: Indicates additional information about the point’s field or category.

• Device: Links to the associated device for quick access and further investigation.

This structured view helps you see specific points for troubleshooting or performance reviews.

Points List Section

The Points List section offers a view of all points for your building, providing detailed insights into each point's characteristics, values, and associated devices. This helps monitor system performance and ensure proper functionality of your building’s smart components.

Search for Points

At the top-right corner, you'll find a search bar that allows you to quickly locate specific points by name, path, ontology field, and device name.

Filter Options:

Above the table, dropdown filters are available for fields like:

• Field: Narrow down points based on their type or sensor field, such as voltage, current, or occupancy.

• Kind: Categorize points based on their function or data type.

• Device Type: This shows device types.

• Ontology Type: Use this to group points according to your building’s defined ontology.

• Area: Filter by the location or zone where the point is located.

• Data Source: Filters the points associated with a particular data source or integration.

These filters allow precise control over the displayed points, helping you focus on relevant data for troubleshooting or analysis.

The Clear Filter button is available to reset all applied filters instantly. This feature simplifies navigation by removing filter settings without having to deselect each one manually, enabling users to start fresh with new filtering criteria.

Point Details Table:

The main point list table presents a structured view of all points, with columns including:

• Name: Displays the point’s identifier, such as voltage, current, or occupancy sensors, etc.

• Value: Shows the real-time data or current state of the point (e.g., inactive, a numerical value, or overridden).

• Field: Indicates the point's category, such as "run_voltage_sensor" or "connection_status".

• Device: Links to the device associated with the point, enabling deeper investigation into any issues.

• Tags: Displays quick identifiers (e.g., "cur," "sensor," or "point") to classify and filter points.

• Description: Includes optional notes or labels for further clarity on each point's purpose.

• Metadata: Displays advanced data attributes for deeper insights into a point’s configuration.

This table simplifies point management and provides quick access to detailed information about each sensor or component.

Introducing Mass Write Points

The new "Mass Write Points" feature enhances building management by allowing users to write multiple points simultaneously across a building or an entire portfolio. This capability is particularly useful for various tasks, such as:

• Peak Demand management i.e decreasing temperatures by 0.5 degree

• Release the overrides so the devices will follow the schedule and turn off during the night to  save energy.

• Adjusting temperature setpoints seasonally to maintain optimal climate control.

• Conducting scheduled maintenance by temporarily disabling specific devices or systems.

• Responding quickly to emergency situations by simultaneously altering the operational state of multiple devices.

• Optimizing building performance by making bulk adjustments based on occupancy patterns and usage data.

Comparison to Single Point Control

Without the Mass Write Points feature, users would have to individually select and adjust each point, which can be extremely time-consuming and inefficient, especially in large buildings with numerous devices. This manual process increases the risk of errors and inconsistencies, and operational delays. The Mass Write Points feature simplifies this process by allowing bulk modifications, which:

• Reduces the time required to implement changes.

• Minimizes the risk of manual errors.

• Ensures consistent application of settings across multiple points.

• Improves operational efficiency and response times.

Detailed Instructions

How to enable access

Mass Write Points will be disabled by default for every role in an organization(e.g zenestate.kodelabs.com), to enable it:

Go to Launchpad -> Apps -> KODE OS -> Roles -> Pick your role or any role that you want to enable it to -> Edit

-> Check these two permissions shown on the screenshot above

• Get points latest configs (this will enable the module)

• Initiate points mass write (this will allow the users to initiate a mass points write)

-> Click Save

The Mass Write Module will show up in the Portfolio view for that organization to the users that have that role.

Accessing Mass Write Points

The Mass Write Points feature is accessible from the portfolio level view of the KODE OS app.

Navigating to Mass Write Points

On the portfolio view page, you will see Jobs split into Schedules and Points (Schedules is another mass write 

• feature which is explained in another document)

• Navigate to the Points tab

Viewing Previous Mass Write Actions

When you visit this 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. This will be covered later in the document.

Using Mass Write Points

To start the process of writing multiple points, -> click on the “Write Points” button and you will be navigated to this page:

Selecting sites (buildings)

To see the points, you should use the filters on the left panel first to pick a site or multiple sites:

1. You can filter sites by:

1. Country

2. State

3. City

4. Building

2. Once you pick the site(s) click Apply

There is no limit to how many sites you can pick.

Selecting points

Only writable points (setpoints and commands) are shown on the list.

1. Use the Filters button at the top right to filter points based on:

1. Point type

2. Canonical Type (Device Ontology type)

3. Area

4. Point Ontology field

5. Data source type

2. Selecting points

1. Filtered points appear in a table where you can select/deselect them.

2. All points are selected by default. Deselect points you don’t want to write.

3. Deselect all works only for the points shown on the current page (100 points by default).

4. You can select multiple point types and kinds simultaneously.

3. Once you confirm that the desired points are selected, -> click Continue to Set Values

Please note that the points can’t be removed from the list on later steps of the process. Ensure that only desired points are selected.

Grouped Points

To allow a faster workflow, we will show points as grouped based on: the ontology field, unit, and the values or facets they accept.  We will either show one group or multiple depending on the list of points you have selected. You will set values for the group not for individual points.

Click the blue counts to see individual points within a group.

Setting Values

Configuring the Job

1. Provide a Job name, reason, and description.

• This information is needed because here we will create a “Job” for tracking progress and reviewing it later.

2. Click on the group name or expand icon to set the values for the group

3. Set the following for each point group:

• Priority: Override, Auto, Set, Release

• Value

• Duration

Saving and Executing

1. The Save button is required for each group before execution.

1. Color highlights indicate any missing information.

2. After saving all groups, click "Execute" to start writing the points.

After clicking Execute, we will start the process of writing all those points. 

You will be navigated to the “Job” details page where you can see the progress.

Job Tracking and Details

Job Details Page

On this page, you will see the progress of the mass write process. 

Job details shown on the left panel include:

1. Creator and creation time

2. Number of points processed

3. Success and failure counts

The right section shows you the same groups and their success and failure rates.

Click on the blue counts to see the actual points part of the groups.

1. Viewpoint groups and click on the count to see details of successes and failures.

2. Jobs are listed on the main Mass Write page for future reference.

This “Job” will be part of the main list of the Mass Write page for you to see it later if needed.

Batch Update Points Section

On the left-hand menu of the Points module, locate and select the "Batch Update Points" option. This section is designed for performing single or bulk operations on multiple points within the KODE OS platform.

Filter Points

At the top of the interface, you’ll find several dropdown menus and filters to narrow down the list of points:

• Field: Select the specific field to filter by. This allows you to focus on particular attributes or categories of points.

• Kind: Choose between Boolean, String, or Number types. This helps separate binary alarms (e.g., True/False) from numerical data (e.g., temperature setpoints).

• Device Type: Filter the selection by device type to target specific Devices.

• Ontology Type: Filter the points further by selecting ontology levels, 

• Data Source: This filter allows selecting points from a specific data source

Also here, the Clear Filter button allows users to reset all applied filters. This button makes navigation easier by clearing all filter settings at once, so users can start with new filtering criteria without manually deselecting each one.

Points Details Table

The list of points is displayed in a tabular format. Key columns include:

• Name: The point's name, such as "Occ Heating Temp Setpt" or "UnOcc Cooling Temp Setpt."

• Value: The current reading or setpoint value of the point (e.g., 15.5°C or 21°C).

• Field: The underlying device field linked to the point (e.g., occupied_heating_zone_air_temperature_setpoint).

• Device: The associated device identifier (e.g., FC_P2_2).

• Tags: Tags are used for organizing points. Common tags like "sensor, cur" are visible.

• Description: Includes optional notes or labels for further clarity on each point's purpose.

• Metadata: Displays advanced data attributes for deeper insights into a point’s configuration.

Batch Multiple Points

Select a group of devices that was just installed and click the Batch Update Points button that will appear after selecting the points

Tip: Selecting multiple VAVs, AHUs, and Electrical Meters at a time speeds up tagging since they typically have the same or similar components.

Use the checkboxes on the left side of the table to select specific points for batch updates. Then click on the Batch Update Points button, at the end of the page, and the popup page will open on the right side.

On the Properties panel to the right, users can define updates:

• Display Name: Assign a custom display name for the selected points.

• Unit: Set the unit for the point (e.g., °C or °F).

• Add Tags or Remove Tags: Organize or modify metadata tags for the selected points.

• Min/Max Value: Specify acceptable value ranges for the points.

• COV Tolerance: Define the Change of Value (COV) tolerance.

• Precision: Set the level of decimal precision for numerical points.

• Metadata: Add custom metadata if necessary.

• Writability: Toggle this option to allow or restrict the ability to write values to the point.

• Graph Visibility: Enable or disable the visibility of the point on system graphs.

Once all configurations are set, click the "Apply" button to implement the changes.

If any points are no longer needed, you can select them and click the "Delete Points" button at the bottom right. This action permanently removes the points from the KODE OS.