Import a Dashboard

The ability to import dashboard definitions was deprecated in Composer 6.9 and will be removed in a future release.

To import a dashboard configuration:

  1. Log into Composer as an administrator or as a user with the Can Create new Data Sources, Can Create Visuals (or Can Administer Visuals), and Can Create Dashboards group privilege.

    If you are logged into Composer as a user who can maintain data source configurations but cannot maintain connection definitions (your group privileges include Can Create new Data Sources, but notCan Manage Connections), the following dashboard import behavior occurs:

    • If the data store connections used by the data sources in the dashboard visuals have already been defined to the Composer instance, the dashboard is successfully imported.

    • If the data store connections used by the data sources in the dashboard visuals have not previously been to defined to the Composer instance, the dashboard is not imported and an error message displays because your user account does not have authorization to create data store connections.

  2. Select Library on the top-level navigation banner or the UI menu, or select the Dashboards box on the Home page. The dashboard library displays.

  3. At the top of the page, select .

  4. Browse to and select the json file for the dashboard, then selectOpen. The dashboard is imported.

When you import a dashboard, the visuals, data store connections and data source configurations used by the dashboard visuals are also imported.

By default, if a dashboard with the same name already exists, the imported dashboard is imported with the same name, but with the date and time appended. If the two dashboards contain any visuals with the same name, the import will fail. However, if you use the API to perform the import, you can request that an imported dashboard and its visuals and data sources overwrite the existing ones. See Overwrite Policy Behavior

Overwrite Policy Behavior

The overwrite policy can be used only for dashboard imports requested using the API. Specify the query parameter, strategy with the POST /api/dashboards/import endpoint. Valid values for strategy are OVERWRITE or USE_EXISTING_OR_CREATE.

  • Specify OVERWRITE to implement the new overwrite policy.

  • Specify USE_EXISTING_OR_CREATE to continue to use the existing import policy (importing the dashboard with a slightly altered name). This is the default value and will be used if strategy is not specified.

To use the overwrite policy, your Composer user account must meet all of the authorization criteria described below.

  • Your Composer user account must be an Administrator account or be assigned to a group with the Can Administer Visuals, Can Administer Dashboards, and Can Administer Sources group privileges. (Your Composer must also be assigned to a group with the Can Create Visual, Can Create Dashboards, and Can Create new Data Sources group privileges, but these privileges are automatically assigned with the Can Administer Visuals, Can Administer Dashboards, and Can Administer Sources group privileges.)

  • Your user account must have both Read and Write permissions for the data source, dashboard, and visuals included in the dashboard import attempt.

Assuming the authorization criteria are met, importing a dashboard using the overwrite policy will overwrite any dashboards with the same name using the following workflow:

Imported Item Condition What Happens
Dashboard Imported dashboard name matches an existing dashboard

The existing dashboard is updated with the settings and specifications from the imported dashboard.

Imported dashboard name does not match an existing dashboard A new dashboard is created.
Visuals Imported With the Dashboard Imported visual name matches an existing visual The existing visual is updated with the settings and specifications from the imported visual.
Imported visual name does not match an existing visual A new visual is created.
Imported dashboard does not include a visual that is in the existing dashboard The existing dashboard is updated with the settings and specifications from the imported dashboard. The existing dashboard is no longer associated with the missing visual, but the visual remains in the system.
Sources Imported With the Dashboard Imported data source name matches an existing data source The existing data source definition is updated with the settings and specifications from the imported data source.
Imported data source name does not match an existing data source A new data source is created.
Connections Connections validate with the data source. Import behavior for connection definitions is not affected by the import policy.