Building BI tool is a feature within our platform that allows you to view data on a dashboard and chart form. This data can provide valuable insights into the performance of your building management solution, helping you make informed decisions about how to optimize and improve your operations. Building BI makes it easy to view and analyze your data.

Navigate to Building BI

To access Building BI, you'll first need to log into your account in KODE OS. Once you're logged in, look for the "Building BI'' module on the left main navigation bar. Click on this module to open the Building BI.

Once you are in Building BI module the view is separated in Collections & Dashboards:

Under “My Dashboards” view you will find all the BBI dashboards that you created or the ones where you are added as a collaborator. On the collections you will find the BBI dashboards organized within it and that later can be shared with all roles or the specific ones.

Create a new Dashboard

Adding a new dashboard to the Building BI tool is a great way to customize your view of the data and focus on specific metrics or data points. Here's how to add a new dashboard:

1. Click on the "Building BI" module located in the main left navigation bar to open the tool.

2. Click on the "+ New Dashboard" button located at the middle  right of the page.

3. Give your new dashboard a name and a description.

4. Click "Create" to save your new dashboard.

Add Widget/Charts to the Dashboard

Here's how to add charts to your dashboard:

1. From the dashboards list, select the dashboard you want to populate with charts.

2. Click on the "Edit Dashboard" button located at the top right of the dashboard.

3. Click on the side menuicon to open up the Chart Configuration menu.

4. Select the chart type you want to add to the dashboard (e.g. line, bar, pie) by dragging the chart to the dashboard or double clicking on it.

5. Select the data point you want to display on the chart by using the dropdown menu of the Data Source field.

6. Once selecting the data source a list of metrics and data points will be displayed.

7. Drag to the “Setup” section the data points you want to display on the chart.

8. Customize the chart by selecting different options, such as the chart title, chart colors, and chart size.

9. You can customize the position of the chart on the dashboard by clicking and dragging it to a different location.

10. Clicking on the 3 dots icon located at the top right of each chart you can duplicate or delete the chart. 

11. Repeat these steps to add additional charts to your dashboard.

12. Once you're satisfied with the charts and dashboard, click "Save" and you’re done.

Managing created BBI Dashboards

You can manage all the BBI Dashboards you created or are a collaborator of and these BBI Dashboards are listed in the section “My Dashboards”.

Here you can see the details like description, owners, data created, last updated and the collections where a specific dashboard is added to.

You can also click on the start icon to mark the dashboard as favorite and once you have at least one dashboard as a favorite the listing on the left side will be populated with “Favorites” section:

If you click on the three dots options of the dashboard to you will see the following options:

• Edit - In this option you can edit the Dashboard’s name, time zone and description:

• Duplicate - With this option you can duplicate the dashboard

• Permissions - In this option you can add “Collaborators”. The collaborators have the ability to change and edit the dashboard. Simply click on Add Users button select the users you want to add as collaborators and click save:

• Save as template - With this option you can create a template using the existing dashboard in order to use it in another site. After clicking on this option a dialog box will show up requesting to enter the template title and the description of.

• Delete - This option deletes the dashboard.

Note: A collaborator can be only a user and not a role. Also collaborators have full access to the dashboard but cannot remove the original owner/creator of the dashboard.

Shareable Link

You have the ability to build your desired dashboards and embed them in other platforms or share them with external users. 

Sharing a dashboard is easy and here's how you can do it:

1. Navigate to the “Building BI” module from the left main navigation bar.

2. Select the dashboard of your choice.

3. Click on the “Share” button at the top right of the dashboard.

4. In the “Sharing properties” pop-up page you can choose:

1. Pages to share,

2. Access expiration,

3. Refresh rate.

5. Click on the “Generate Link” button.

6. Copy the shareable link by clicking on the Linkicon to share with external users and open on the browser. 

7. You can get back to the list of the created links by clicking on the Share icon button at the top right of the dashboard.

1. The link is automatically enabled, which allows you to share the link immediately by copying it.

2. You can delete the link at any time to revoke access to the widget by clicking on the Delete button. 

1. Any internal users with no access to that widget or any external users you have shared the link with will no longer be able to view the widget.

If you wish to generate a shareable link for a specific widget, here's how you can do it:

1. Click on the 3 dots icon at the top right of the widget.

2. From the drop down menu click on “Share”.

3. In the “Sharing properties” pop-up page you can choose:

1. Choose pages to share

2. Access expiration,

3. Link title

4. Refresh rate.

5. Allowed IPs

4. Click on the “Generate Link” button.

5. Copy the shareable link by clicking on the Linkicon to share with external users and open on the browser. 

Collections

This feature allows you to easily organize and publish the BBI Dashboards for all users or to a specific role.

In order for a BBI Dashboard to be visible to other users than the collaborators one they must be organized in collections and published.

Creating a BBI Collection

Creating a BBI collection is super easy. Just go to the upper right corner and click “New Collection” button:

After you clicked the button a new window will appear:

In this window you need to put a name of the collection by clicking on the pencil icon, then deleting the default title and typing a one of your choice or matching the name according to the BBI Dashboards type that will be added in it.

On the right side you will have all BBI Dashboards that are available to be put in the collection. Simply drag and drop them in the left side section where it says “Drop Dashboards here”. 

After the list will be populated you can arrange them according to your preference by holding them clicked and moving them:

After you complete the steps you just hit the “Create” button.
When a collection is created it will stay “Unpublished”, this means that this collection is not viewable to other users or roles.

Publishing the collection

In order to publish it simply click on the three dots of the specific collection and go to the “Publish” option:

When you click on publish option  a dialog will appear asking if you want to publish to all or you want to publish to a specific role/s. 

If we want to publish to a specific role after clicking the button a new pop up windows will appear where you can click on “Add Role” button:

Here you can choose the roles that you want and click Add to go to the list page back:

On this view we can see the roles that we just selected or if we published this collection earlier we can manage the roles here if we want to remove or add a role.

Hit the save button for the changes to take effect.

A collection can be only published to a role/s and not to a specific user!

Note: If you want to unpublish the collection simply select the unpublish option from the three dots menu of the collection!

Editing Collection

If you want to edit the saved collection just select the Edit Collection option from the three dots menu of the desired collection. The view and the logic of the working in this dialog is the same as we firstly created a dashboard where we can remove a dashboard from the collection or change the name of the collection:

Manage Viewers

If you select the Manage viewers option here you will see a window where you can delete or add a role that this collection is published/visible to:

Deleting a collection

You can delete a collection simply by clicking the delete option from the collections three dotted menu  and confirming on the dialog.

Organizing favorite dashboards and collections

Favorite dashboards and collections can be arranged in a specific order by simply going on the three dotted menu on the right side on top of the page:

Clicking on the Arrange Collections or Favorites dashboards will bring to you a window where you can move the dashboards or collection to your desired order. The arrangement you make here will be reflected in the left side pane of the BBI Module:

The left pane on the BBI Module will list the favorites dashboards collections and dashboards in a tree list view.

We can also audit viewers by selecting the Audit Viewers option on the three doted menu on top right side of the page:

You will see a new window after you click on that option listing all the roles showing the number of the collections that the role has access to. The collections names can be viewed by clicking on the drop arrow to expand the list:

Using BBI Templates in KODE OS

BBI Templates in KODE OS allow you to save and reuse dashboards, collections, and individual charts, helping you streamline your workflow and avoid building everything from scratch.

With this template system, templates follow a clean hierarchy:

• KODE Templates (Global): Created and maintained by KODE Labs. Only KODE Admins can edit these.

• Organization Templates: Created by organization channel partners. Can be edited by organization admins or users with the Manage Templates permission.

Navigating to BBI Templates

1. Log in to KODE OS.

2. Click on the Building BI module from the main menu on the left.

3. Scroll to the bottom left of the side menu and click Templates.

Template Types

There are three types of templates you can use:

1. Collection Templates

2. Dashboard Templates

3. Chart Templates

1. Collection Templates

Collection Templates help standardize and share groups of dashboards (also called Collections) across your organization.

How to Create a Collection Template

1. Go to Collections & Dashboards.

2. If a collection doesn’t exist yet, click + New Collection to create one.

3. Click the three-dot menu next to your collection > Save as Template.

4. Add a name and optional description, then click Save.

How to Use a Collection Template

1. Go to Templates from the BBI left sidebar.

2. Click Collection Templates.

3. Browse or search for a template.

4. Click the three-dot menu > Use Template.

• A draft copy will be created under My Collections.

5. Go to Collections & Dashboards to Publish the collection to specific roles or all users.

Note: To use a Global Template created by KODE Admins, go to the Global Templates tab in the Collections section.

Edit a Collection Template

1. Go to BBI Templates > Collection Templates.

2. Click the three-dot menu > Edit Template.

3. Update the name or description > click Save.

Delete a Collection Template

1. Go to BBI Templates > Collection Templates.

2. Click the three-dot menu > Delete Template.

3. Confirm by clicking Yes on the pop-up.

2. Dashboard Templates

How to Create a Dashboard Template

1. Go to BBI Collections & Dashboards.

2. Under My Dashboards, click the three-dot menu next to a dashboard.

3. Select Save as Template.

4. Add a name and description > click Save.

The template will be saved under Organization Templates in the Dashboards section.

How to Use a Dashboard Template

1. Go to BBI Templates > Dashboards (top right).

2. Choose from:

• Organization Templates (created by your organization)

• Global Templates (from the KODE library)

3. Click the three-dot menu > Use Template.

4. Review the dashboard on the new page.

5. Click Save to add it to My Dashboards.

Edit a Dashboard Template

1. Go to BBI Templates > Dashboard Templates.

2. Click the three-dot menu > Edit Template.

3. Update the name or description > click Save.

Delete a Dashboard Template

1. Go to BBI Templates > Dashboard Templates.

2. Click the three-dot menu > Delete Template.

3. Confirm by clicking Yes on the pop-up.

Note: Your ability to edit, export, or delete templates may vary based on your role and permissions.

1. Go to BBI Collections & Dashboards.
   

2. Select a dashboard and click Edit Dashboard (top right).

3. Click the three-dot menu on any chart > Save as Template.

4. Add a name and description > click Save.

The template will be saved under Charts - Organization Templates.

How to Use a Chart Template

1. Go to BBI Collections & Dashboards.

2. Select a dashboard and click Edit Dashboard (top right).

3. Click on Chart Library from the right bar. 

4. Drag and drop from the templates. Choose from:

• Organization Templates

• Global Templates

5. Click Save to add the chart to the dashboard and save the dashboard.

Edit a Chart Template

1. Go to BBI Templates > Chart Templates.

2. Click the three-dot menu > Edit Template.

3. Update the name or description > click Save.

Delete a Chart Template

1. Go to BBI Templates > Chart Templates.

2. Click the three-dot menu > Delete Template.

3. Confirm by clicking Yes on the pop-up.

Sharing Templates Across Organizations

Export a Template

1. Go to BBI Templates.

2. Click the three-dot menu next to a template > Export.

3. A secure URL will be generated and copied to your clipboard.

• The URL expires after 24 hours.

Import a Shared Template

1. Go to BBI Templates.

2. Click the Import Template button (top right).

3. In the pop-up:

• Paste the shared link.

• Adjust the title and add a description.

4. Click Save Template.