> ## 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.

# Deployment manager

> Deploy Building BI dashboards across multiple buildings, manage predefined and custom views, and maintain portfolio-wide consistency.

The Deployment Manager enables you to deploy dashboards across multiple buildings from the [portfolio view](/products/building-bi/overview#portfolio-and-building-scope). See [How Building BI permissions work](/products/building-bi/concepts/how-permissions-work) and [templating versus deployment](/products/building-bi/concepts/templating-vs-deployment) to choose the right distribution approach. Only users with the `Sync/Bulk Deploy` permission can access it.

## Access the Deployment Manager

Navigate to the portfolio view of Building BI and select `Deployment Manager` from the left navigation bar.

You can also access deployment options directly from a dashboard by opening the three-dot menu on the dashboard and selecting `Deploy`.

<Frame caption="Building BI left navigation showing Deployment Manager at the bottom, with collections and dashboards listed above">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-dashboard-access.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=485721f72b580ee621e4ffb36c62c1c9" alt="Building BI interface showing a published FDD events dashboard with the left navigation bar displaying Dashboard Collection with FDD events and Air Quality, Energy Usage with Energy Report and Spaces, My Dashboards with multiple dashboards, and Deployment Manager, Settings, Data Sources, and Templates at the bottom" width="1024" height="713" data-path="images/kode-os/building-bi/bbi-deploy-dashboard-access.png" />
</Frame>

## Deployment list

The deployment list displays all current and past deployments with the following columns:

| Column                 | Description                                      |
| ---------------------- | ------------------------------------------------ |
| Deployment Name        | Name assigned to the deployment                  |
| Dashboard              | Dashboard being deployed                         |
| Deployment Description | Purpose or context for the deployment            |
| Status                 | Current state: Completed, Failed, or In progress |
| Building               | Source building for the deployment               |
| Deployed to            | Number of target buildings                       |

<Frame caption="Deployment Manager list view showing the deployment table with a search bar, building filter, and New Deployment button">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-list.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=d5b4c96871dbe14ed4879a9d9edbae19" alt="Deployment Manager page showing a search bar, Building dropdown filter, New Deployment button, and an empty deployment table with Deployment Name, Dashboard, Deployment Description, Status, Building, and Deployed To columns displaying No deployments yet" width="1024" height="828" data-path="images/kode-os/building-bi/bbi-deploy-list.png" />
</Frame>

### Row actions

Each deployment row has a three-dot menu with the following options:

* `View Details` -- View the full list of target buildings and deployment status
* `Edit` -- Modify deployment configuration
* `Delete` -- Remove the deployment

## Deploy a new dashboard

<Warning>
  **Deployment risk:** Deployed dashboards retain the data filters, chart configurations, and settings defined on the host building's dashboard. If the target buildings do not contain the same data, equipment, naming conventions, or configuration, some charts may return errors or no data. Before deploying, confirm that all selected buildings support the dashboard's requirements.
</Warning>

<Steps>
  <Step title="Start a new deployment">
    Select `New Deployment` from the deployment list view.
  </Step>

  <Step title="Configure the deployment source">
    Enter a `Deployment name` and an optional `Deployment description`. Select the source `Building` and the `Dashboard` you want to deploy, then select `Next`.

    <Frame caption="Deployment Source step showing name, description, building, and dashboard fields">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-source.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=9e67854624dee93575445f09646df692" alt="New Deployment wizard step 1 Deployment Source showing Deployment name field, Deployment description field, Building dropdown, and Dashboard dropdown with Close and Next buttons" width="707" height="622" data-path="images/kode-os/building-bi/bbi-deploy-source.png" />
    </Frame>
  </Step>

  <Step title="Set dependencies">
    Select which dependencies to validate against the target buildings. The system checks that each target building has the required data sources and ontology points. If the dashboard has no dependencies, the step displays "No dependencies available." Select `Next` to continue.

    <Frame caption="Set Dependencies step showing a search field and the dependencies validation area">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-dependencies.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=2be8f144ef9b0633e3e588f6b141eb02" alt="New Deployment wizard step 2 Set Dependencies showing Select which dependencies to validate against selected buildings message, a search field, and No dependencies available text with Back, Close, and Next buttons" width="708" height="627" data-path="images/kode-os/building-bi/bbi-deploy-dependencies.png" />
    </Frame>
  </Step>

  <Step title="Configure canonicals and fields">
    Select a `Canonical Type` and `Ontology Fields` to verify which types and fields are compatible with your target buildings. Use the searchable dropdown to filter canonical types such as `cav`, `vav`, `ahu`, `fcu`, `boiler`, `chiller`, `heatPump`, `pump`, and others. This step is optional. Select `Next` to continue.

    <Frame caption="Canonicals and Fields step showing the Canonical Types dropdown with device types">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-canonicals.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=c1110c1e7688b40fd135c1409e435f29" alt="New Deployment wizard step 3 Canonicals and Fields showing Canonical Types dropdown expanded with cav, vav, ahu, fcu, uh, boiler, chiller, heatPump, pump, boosterPump, and fan options, and an Ontology Fields dropdown" width="704" height="620" data-path="images/kode-os/building-bi/bbi-deploy-canonicals.png" />
    </Frame>
  </Step>

  <Step title="Select deployment targets">
    Choose the buildings where the dashboard should be deployed. Use the `Deploy To` dropdown to search and select specific buildings, or select all buildings in your portfolio. Select `Next` to continue.

    <Frame caption="Deployment Target step showing the Deploy To dropdown for selecting target buildings">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-target.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=7d65ded3c6195eb596a598fcdc3e96ea" alt="New Deployment wizard step 4 Deployment Target showing Deploy To with a Select targets dropdown and a Please select deployment targets to configure dependencies message with Back, Close, and Next buttons" width="704" height="625" data-path="images/kode-os/building-bi/bbi-deploy-target.png" />
    </Frame>
  </Step>

  <Step title="Add collaborators">
    Add collaborators who can view and edit this deployment. Search for users and select `+ Add Users` to add them. The table shows each collaborator's name and role. This step is optional. Select `Next` to continue, or select `Deploy Now` to skip the remaining steps and deploy immediately.

    <Frame caption="Collaborators step showing the user search field and collaborators table">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-collaborators.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=a212d0bc2257717afbefd1f3d1d30899" alt="New Deployment wizard step 5 Collaborators showing a Search for User field, Add Users button, a table with Name and Role columns displaying No collaborators found, and Back, Close, Deploy Now, and Next buttons" width="707" height="624" data-path="images/kode-os/building-bi/bbi-deploy-collaborators.png" />
    </Frame>
  </Step>

  <Step title="Add to a collection">
    Choose a collection to organize the deployed dashboard. Use the `Collections` dropdown to select an existing collection. This step is optional. Select `Next` to continue, or select `Deploy Now` to deploy immediately.

    <Frame caption="Add to Collection step showing the Collections dropdown">
      <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-collection.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=8d5bf59ef321f2523154a5db0def4638" alt="New Deployment wizard step 6 Add to Collection showing a Collections dropdown set to Choose a Collection with Back, Close, Deploy Now, and Next buttons" width="709" height="622" data-path="images/kode-os/building-bi/bbi-deploy-collection.png" />
    </Frame>
  </Step>

  <Step title="Review and deploy">
    Review the deployment summary. Confirm all settings are correct, then select `Deploy`.
  </Step>
</Steps>

## Manage existing deployments

### View details

Open the three-dot menu on a deployment row and select `View Details`. The Deployment Details panel opens on the right, showing the deployment name, source building, source dashboard, collection, and collaborators. Below the summary, the `Manage Deployments` section lists all target buildings with the deployer name, deployment timestamp, and icons to open or remove each building.

<Frame caption="Deployment Details panel showing deployment summary and the list of target buildings">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-details.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=29b685ba4c0c241cf4837cc4085f55fc" alt="Deployment Details panel showing Deployment Name Override Report, Source Building KODE 1420 Office, Source Dashboard Overrides, Added to Collection Not added to any collection, Collaborators No collaborators, and Manage Deployments section showing Deployed in 14 of 15 with a searchable list of buildings including Headquarters, Redford Branch, Grand Rapids Branch, Tech Center, Retail Demo, One Financial Plaza, Harbor View Tower, and Meridian Business Center each with open and remove icons" width="897" height="870" data-path="images/kode-os/building-bi/bbi-deploy-details.png" />
</Frame>

### Edit a deployment

Open the three-dot menu on a deployment row and select `Edit`. The Edit Deployment dialog has two tabs: `Deployment Details` and `Deployment Target`. Update the deployment name, description, source building, or dashboard on the Details tab. Switch to the Target tab to modify target buildings. Select `Update` to save your changes.

<Frame caption="Edit Deployment dialog showing the Deployment Details tab with name, description, building, and dashboard fields">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-edit.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=224c390b1b87dc27fd7dced30ecaa463" alt="Edit Deployment dialog showing Deployment Details and Deployment Target tabs, Deployment name set to Deployment Test, Deployment description field, Building set to Scodra Nexus, Dashboard set to RWS, and Close and Update buttons" width="532" height="418" data-path="images/kode-os/building-bi/bbi-deploy-edit.png" />
</Frame>

The `Deployment Target` tab lets you update where the dashboard is deployed and verify target dependencies. Set the `Deploy To` field to select buildings, then review `Target Dependencies` under the `Datasources & Metrics` and `Canonicals & Fields` tabs. Buildings are categorized as `All Buildings`, `Compatible`, `Incompatible`, or `Partial` based on whether they meet the dashboard requirements.

<Frame caption="Edit Deployment dialog showing the Deployment Target tab with Deploy To field and Target Dependencies">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-edit-target.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=5bbf24116df977d3384d19d6663f6d31" alt="Edit Deployment dialog showing the Deployment Target tab with Deploy To set to All, Target Dependencies section with Datasources and Metrics and Canonicals and Fields tabs, filter buttons for All Buildings 0, Compatible 0, Incompatible 0, and Partial 0, and a table with Building, Status, and Fields columns" width="530" height="470" data-path="images/kode-os/building-bi/bbi-deploy-edit-target.png" />
</Frame>

### Delete a deployment

Open the three-dot menu on a deployment row and select `Delete`. Confirm the deletion when prompted.

<Warning>
  Deleting a deployment does not remove dashboards already deployed to target buildings. It only removes the deployment record.
</Warning>

## Predefined and custom views

### Predefined view

A predefined view is the portfolio-controlled version of a deployed dashboard. When you publish a new version of the source dashboard, all buildings with the predefined view receive the update automatically.

Predefined dashboards display a `Predefined` chip next to the dashboard name. The status dropdown shows `Predefined` with a checkmark and provides access to `Version History`.

Filter-only changes on a predefined dashboard do not break sync. Edits beyond filter values unlink that site from the source. Building BI warns before you enter edit mode. Once unlinked into a custom view, that site no longer receives predefined updates until you delete the custom view and revert.

<Frame caption="Predefined dashboard showing the Predefined chip and status dropdown with Version History option">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-predefined-view.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=4a30e40e023c4cb4ed59b941867fd50f" alt="Overrides dashboard at KODE 1420 Office showing a Predefined chip with a dropdown displaying Predefined with a checkmark and Version History with an external link icon, Customize Dashboard and Edit Dashboard buttons, and dashboard widgets including Overridden Points By Device Type donut chart, Overridden Points By Point Type bar chart, and Devices Overridden Points table" width="1024" height="605" data-path="images/kode-os/building-bi/bbi-deploy-predefined-view.png" />
</Frame>

### Custom view

A custom view is a locally editable version of a deployed dashboard for a specific site. Custom views are independent of predefined updates -- changes to the source dashboard do not affect them.

To create a custom view:

1. Open the predefined dashboard at the target site.
2. Select `Customize Dashboard`.
3. A confirmation dialog appears. Select `Yes, publish` to publish your custom version. Other dashboards are not affected.

<Frame caption="Publish dashboard confirmation dialog when customizing a predefined dashboard">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-publish-custom.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=b2c897b1c2d2a1d16484dbd51782979b" alt="Publish dashboard dialog stating This will publish your custom version of the dashboard and Other dashboards will not be affected with Cancel and Yes publish buttons" width="892" height="555" data-path="images/kode-os/building-bi/bbi-deploy-publish-custom.png" />
</Frame>

The dashboard displays a `Custom` chip after customization. You can edit the custom view like any other dashboard, with the full Chart List, edit toolbar, and all styling options available. Use `Delete Custom` to revert to the predefined version, `Save as Draft` to save privately, or `Publish` to push your custom changes live.

<Frame caption="Custom view in edit mode showing the Custom chip, Delete Custom button, and Chart List panel">
  <img src="https://mintcdn.com/kodelabs/B4MTivRlYKOrn2ok/images/kode-os/building-bi/bbi-deploy-custom-view.png?fit=max&auto=format&n=B4MTivRlYKOrn2ok&q=85&s=744d67baf0bbee13d58a79a3ae12328f" alt="Overrides dashboard in Custom Draft edit mode showing the Custom chip, timezone selector, Auto Refresh, Mobile Layout, Delete Custom, Cancel, Save as Draft, and Publish buttons at the top, the dashboard widgets on the canvas, and the Chart List panel on the right with Bar, Horizontal Bar, Stacked Bar, Stacked Horizontal Bar, Combo, Line, Line Area, Stacked Line, Pie, Sunburst, Multi-Row Card, and Card chart types" width="1024" height="678" data-path="images/kode-os/building-bi/bbi-deploy-custom-view.png" />
</Frame>

<Tip>
  Use custom views only when a specific site requires a layout or data configuration that differs from the portfolio standard. This keeps maintenance overhead low.
</Tip>

## Enable the Deployment Manager

To grant access to the Deployment Manager:

1. Navigate to Launchpad > `Apps` > `Cloud BMS` > `Roles`.
2. Enable `Deployment Manager Read/Write` under the Building BI module.

<Note>
  Only users with the appropriate role permission can create, edit, or delete deployments. Read-only access allows viewing deployment details without modification.
</Note>

## Best practices

* Test dashboards thoroughly at a single site before deploying across the portfolio.
* Use collections to group related deployments for easier management.
* Limit custom views to sites that genuinely need different configurations.
* Audit deployments periodically to remove outdated or failed entries.

## 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="Collections" icon="folder-open" href="/products/building-bi/collections" arrow={true}>
    Organize dashboards into shared groups with role-based access control.
  </Card>
</CardGroup>
