> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Collections

> Organize, publish, and manage Building BI dashboard collections to share curated dashboard sets with specific roles.

Collections organize and publish Building BI dashboards for users and roles. A dashboard must belong to a collection and be published before it is visible beyond its collaborators.

<Note>
  For how collections control visibility, support multiple audiences, and relate to permissions, see [How Building BI permissions work](/products/building-bi/concepts/how-permissions-work).
</Note>

<Frame caption="The Collections and Dashboards page showing collection cards, left navigation, and the My Dashboards table">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-collections-dashboards-page.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=2b839cf8c817d4ad68e202e5e2f2991e" alt="Collections and Dashboards page showing Favorites and Dashboard Collection sections in the left navigation, three collection cards with Published and Unpublished badges in the main area, and the My Dashboards table listing dashboards with Name, Description, Owners, Date Created, and Last Updated columns" width="1024" height="636" data-path="images/kode-os/building-bi/bbi-collections-dashboards-page.png" />
</Frame>

## Default landing behavior

The first dashboard in the first collection a user has access to automatically becomes their default landing page when they open Building BI. Arrange your most critical information at the top of the first collection for each user group.

<Tip>
  Users can override the default landing page by marking a dashboard as a favorite. Favorited dashboards appear in a pinned section at the top of the left navigation panel.
</Tip>

## Create a collection

<Steps>
  <Step title="Open the new collection form">
    Click `New Collection` in the upper-right corner of the Building BI view.
  </Step>

  <Step title="Name the collection">
    Click the pencil icon next to the default name and enter a descriptive title.
  </Step>

  <Step title="Add dashboards">
    Drag dashboards from the right panel and drop them into the left panel labeled `Drop dashboards here`.

    <Frame caption="The New Collection dialog with dashboards added on the left and available dashboards on the right">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-new-collection-dialog.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=0edd3064f622a744f0b897ae4da22ac3" alt="New Collection dialog showing Engineering Dashboards as the collection name with an Unpublished badge, Overrides and Operations dashboards added on the left, a Drop dashboards here zone, and a searchable list of available dashboards on the right including Lighting, Parking Occupancy, Site Summary, and others" width="975" height="779" data-path="images/kode-os/building-bi/bbi-new-collection-dialog.png" />
    </Frame>
  </Step>

  <Step title="Arrange the order">
    Drag dashboards within the left panel to set the display order.
  </Step>

  <Step title="Save the collection">
    Click `Create` to save. The new collection remains in an `Unpublished` state until you publish it.
  </Step>
</Steps>

## Publish a collection

Publishing makes a collection visible to users beyond its collaborators.

<Steps>
  <Step title="Open the publish menu">
    Click the three-dot menu on the collection and select `Publish`.
  </Step>

  <Step title="Choose your audience">
    Select `Publish to All` to make the collection available to every user, or select `Publish to Specific Roles` to restrict access.

    <Frame caption="The Publish Collection dialog with options to publish to all users or specific roles">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-publish-collection-dialog.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=53dbee01574b3a27c769bbf22fc1ed74" alt="Publish Collection dialog stating All Roles have access on a published collection with Cancel, Publish to Specific Roles, and Publish to All buttons" width="619" height="194" data-path="images/kode-os/building-bi/bbi-publish-collection-dialog.png" />
    </Frame>
  </Step>

  <Step title="Save">
    Click `Save` to apply the publishing configuration.
  </Step>
</Steps>

<Note>
  Collections publish to roles only, not to individual users. Assign users to the appropriate roles in Launchpad to control access.
</Note>

To remove a collection from publication, click the three-dot menu and select `Unpublish`.

## Shared dashboards across collections

A single dashboard can appear in multiple collections to serve different audiences. This does not duplicate the dashboard. Any edits made to a dashboard automatically propagate across all collections where it appears.

## Manage a collection

Select the three-dot menu on a collection card to access all management actions.

<Frame caption="Collection three-dot menu showing Publish, Edit, Manage Viewers, Save As Template, and Delete options">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-collection-menu.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=0dc0946cdbebe27f32cd937fd266dec9" alt="Collection card three-dot menu showing Publish, Edit Collection, Manage Viewers, Save As Template, and Delete options for the Engineering Dashboards collection" width="501" height="258" data-path="images/kode-os/building-bi/bbi-collection-menu.png" />
</Frame>

| Action             | Description                                                                       |
| ------------------ | --------------------------------------------------------------------------------- |
| `Publish`          | Make the collection visible to all users or specific roles                        |
| `Edit Collection`  | Rename the collection, add dashboards, or remove existing ones                    |
| `Manage Viewers`   | Add or remove roles to control which teams can access the collection              |
| `Save As Template` | Save the collection as a reusable template with dependencies and ontology mapping |
| `Delete`           | Permanently remove the collection                                                 |

### Manage viewers

Select `Manage Viewers` from the three-dot menu to control which roles can access the collection. By default, all roles have access. Adding specific roles restricts access to only those roles. See [How Building BI permissions work](/products/building-bi/concepts/how-permissions-work) for how view and edit access relate.

<Frame caption="The Manage Viewers dialog showing assigned roles with search and Add Role options">
  <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-manage-viewers.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=0a2b01a9693e22172078da67301bf46c" alt="Manage Viewers dialog showing All roles have access to the dashboard by default message, a search bar, Add Role button, and a table with the Engineering role listed with its description and a delete icon" width="787" height="640" data-path="images/kode-os/building-bi/bbi-manage-viewers.png" />
</Frame>

## Delete a collection

Select the three-dot menu on a collection and select `Delete`. Confirm the deletion when prompted.

<Warning>
  Deleting a collection removes it permanently. Dashboards within the collection are not deleted and remain in your `My Dashboards` table, but they lose their published visibility until added to another collection.
</Warning>

## Organize collections and favorites

You can reorder how collections and favorites appear in the Building BI left pane. The order you set here directly controls the left navigation order for all users with access to those collections.

Select the three-dot menu in the upper-right corner of Building BI to access arrangement and audit options.

<Frame caption="The top-right three-dot menu with Arrange Favorite Dashboards, Arrange Collections, and Audit Viewers options">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-collections-top-menu.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=0ed5e329ca7a5fae9705ed26f51502fa" alt="Three-dot menu in the upper-right corner showing Arrange Favorite Dashboards, Arrange Collections, and Audit Viewers options next to the New Collection button" width="459" height="323" data-path="images/kode-os/building-bi/bbi-collections-top-menu.png" />
</Frame>

### Arrange collections

Select `Arrange Collections` to reorder how collections appear in the left navigation. Drag collections to set the display order, then select `Save`.

<Frame caption="The Arrange Collections dialog with a list of collections you can drag to reorder">
  <img src="https://mintcdn.com/kodelabs/euAGYgyin2AxlZ4b/images/kode-os/building-bi/bbi-arrange-collections.png?fit=max&auto=format&n=euAGYgyin2AxlZ4b&q=85&s=f93bd93d264ccb5157b896e969baaf0d" alt="Arrange Collections dialog showing Dashboard Collection and Engineering Dashboards in a list you can drag to reorder, with Close and Save buttons" width="387" height="458" data-path="images/kode-os/building-bi/bbi-arrange-collections.png" />
</Frame>

### Arrange favorites

Select `Arrange Favorite Dashboards` to reorder your favorited dashboards in the left navigation panel. Drag dashboards to set the display order, then select `Save`.

<Frame caption="The Arrange Favorite Dashboards dialog with a list of favorited dashboards you can drag to reorder">
  <img src="https://mintcdn.com/kodelabs/euAGYgyin2AxlZ4b/images/kode-os/building-bi/bbi-arrange-favorites.png?fit=max&auto=format&n=euAGYgyin2AxlZ4b&q=85&s=bf036434d39a51432b16e8618a443b3a" alt="Arrange Favorite Dashboards dialog showing Operations Dashboard and Lighting Occupancy in a list you can drag to reorder, with Close and Save buttons" width="392" height="437" data-path="images/kode-os/building-bi/bbi-arrange-favorites.png" />
</Frame>

### Audit viewers

Select `Audit Viewers` to review role assignments across your organization. Expand a role to see which collections it has access to.

<Frame caption="The Audit Viewers dialog showing roles and their collection access">
  <img src="https://mintcdn.com/kodelabs/euAGYgyin2AxlZ4b/images/kode-os/building-bi/bbi-audit-viewers.png?fit=max&auto=format&n=euAGYgyin2AxlZ4b&q=85&s=88a81f62debcf3a52bf280f1c80a5ad4" alt="Audit Viewers dialog showing a table with Role and Access To columns, SuperAdmin expanded to show access to Dashboard Collection and Engineering Dashboards, and other roles like EnerG DEMO USER, COPT EnerG Demo, Engineering, FDD Admin each showing 1 Collection" width="579" height="574" data-path="images/kode-os/building-bi/bbi-audit-viewers.png" />
</Frame>

## Collaborator access

When you add a user as a collaborator on a dashboard, they receive full edit access. Collaborators can modify the dashboard content and manage other users, including adding or removing additional collaborators.

<Warning>
  Collaborators have the same level of access as dashboard owners. If you need to share an editable version with external users, duplicate the dashboard first and share the copy to avoid unintended changes to the original.
</Warning>

## My Dashboards

The `My Dashboards` section lists all dashboards you have collaborator (edit) access to. This table is sorted by `Last Updated` by default, which matches the order displayed in your left navigation panel.

## Save a collection as a template

Save a collection as a reusable template to deploy across multiple buildings. Select the three-dot menu on a collection and choose `Save As Template`.

<Steps>
  <Step title="Set template details">
    Enter a `Template Name` and optional `Description` for the template. Select `Save Now` to save immediately, or select `Next` to configure dependencies.

    <Frame caption="Step 1: Template Details with name and description fields">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-save-template-details.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=e2978f58ffacfbc58aabd6200e3295db" alt="Save as Template dialog Step 1 Template Details showing Template Name set to Engineering Dashboards, a Description field, and Cancel, Save Now, and Next buttons" width="809" height="667" data-path="images/kode-os/building-bi/bbi-save-template-details.png" />
    </Frame>
  </Step>

  <Step title="Set dependencies">
    Select which data source dependencies to validate against target buildings. Each dashboard in the collection lists its pipelines, graphs, and other dependencies. Select the dependencies that must exist at the target site for the template to work correctly.

    <Frame caption="Step 2: Set Dependencies showing data source dependencies per dashboard">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-save-template-dependencies.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=9db90a48f20f15aacd693a56bc3dea09" alt="Save as Template dialog Step 2 Set Dependencies showing Operations and Overrides dashboard tabs with expandable dependency items including Timeseries Last Values Pivoted with 1 Pipeline, Point Metrics with 1 Pipeline and 1 Graph, and Running Minutes Metrics with graph items" width="788" height="650" data-path="images/kode-os/building-bi/bbi-save-template-dependencies.png" />
    </Frame>
  </Step>

  <Step title="Configure canonicals and fields">
    Select the `Canonical Types` and `Ontology Fields` that the template requires. These determine which buildings are compatible when deploying the template.

    When you deploy the template, Building BI checks these requirements against the target building or portfolio. It flags missing canonical types or ontology fields so you can catch gaps before the collection goes live. Use this step as a QA check for site readiness.

    <Frame caption="Step 3: Canonicals and Fields with type and field selectors">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-save-template-canonicals.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=c4bae705c91f36984a9456fc80b4f67e" alt="Save as Template dialog Step 3 Canonicals and Fields showing Canonical Types dropdown with 11 items selected and Ontology Fields dropdown with All selected" width="786" height="633" data-path="images/kode-os/building-bi/bbi-save-template-canonicals.png" />
    </Frame>
  </Step>

  <Step title="Review and confirm">
    Review the template name, description, and dependencies. Add any additional notes in the text area. Select `Save Template` to create the template, or select `Back` to modify previous steps.

    <Frame caption="Step 4: Review and Confirm showing the template summary and dependencies">
      <img src="https://mintcdn.com/kodelabs/qpy9KTqZYAZmFRi5/images/kode-os/building-bi/bbi-save-template-review.png?fit=max&auto=format&n=qpy9KTqZYAZmFRi5&q=85&s=a55c81516c4c12114d9866ae3694a741" alt="Save as Template dialog Step 4 Review and Confirm showing Template Name Engineering Dashboards, Description No description added, Dependencies 3 including Point Time Series Last Values, Running Minutes Metrics, and Updated Version, with a notes text area and Cancel and Save Template buttons" width="797" height="647" data-path="images/kode-os/building-bi/bbi-save-template-review.png" />
    </Frame>
  </Step>
</Steps>

## Navigation widget

The navigation widget links a dashboard to another page within the same dashboard or to a different Building BI dashboard.

<Steps>
  <Step title="Add the widget">
    Open a dashboard in edit mode and drag the `Navigation` widget onto the canvas.
  </Step>

  <Step title="Configure the destination">
    Set the `Navigate to` field to one of:

    * **Page** -- Select a page within the current dashboard.
    * **Dashboard** -- Select another Building BI dashboard.
  </Step>

  <Step title="Save the dashboard">
    Save the dashboard to apply the navigation widget configuration.
  </Step>
</Steps>

## Related reading

<CardGroup cols={2}>
  <Card title="Collections" icon="folder-open" href="/products/building-bi/collections" arrow={true}>
    Control visibility and organize dashboards by audience.
  </Card>

  <Card title="Templating vs deployment" icon="git-compare" href="/products/building-bi/concepts/templating-vs-deployment" arrow={true}>
    Choose independent copies or governed portfolio parity.
  </Card>

  <Card title="Template types" icon="layers" href="/products/building-bi/reference/template-types" arrow={true}>
    Compare collection, dashboard, page, and chart templates.
  </Card>

  <Card title="Deployment manager" icon="rocket" href="/products/building-bi/deployment-manager" arrow={true}>
    Deploy dashboards and manage predefined versus custom views.
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Dashboards" icon="layout-dashboard" href="/products/building-bi/dashboards" arrow={true}>
    Create and configure interactive dashboards with charts, tables, and widgets.
  </Card>

  <Card title="Deployment manager" icon="rocket" href="/products/building-bi/deployment-manager" arrow={true}>
    Deploy dashboard configurations across multiple sites in your portfolio.
  </Card>
</CardGroup>
