Importing and Exporting Dashboards
  • 26 Nov 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Importing and Exporting Dashboards

  • Dark
    Light
  • PDF

Article summary

You can import and export Dashboards to and from Axonius. Dashboards are exported from Axonius in JSON file format. An exported Dashboard can be imported. This makes it easy to move Dashboards from one Axonius environment to another.

All charts and their settings, including queries, are exported. Access permissions are NOT exported with dashboards. When importing, you can set the access level of the dashboards.

  • A Dashboard can only be imported to the same major version (first two numbers of the version number) of Axonius as it was exported. For example, a dashboard exported from version 6.0.x cannot be imported to version 6.1.x.
  • Dashboards with all access permissions, including custom or Private, can be imported and exported.
  • System dashboards, including My Dashboard, cannot be exported.

For more information about Data Scopes, see Data Scope Management.

Required Permissions

The user's role must have the following permissions to import or export dashboards.

  • To export dashboards, roles must be unrestricted and have the following permissions:
    • Export dashboard
  • To import dashboards, roles must have the following permissions:
    • Import Dashboard
    • View Dashboards
    • Add Dashboards
    • Add charts
    • Delete charts
    • View entity - Must have this permission for all the entity types included in the imported dashboards.
    • Add saved queries - Must have this permission for all the entity types included in the imported dashboards.
    • Edit saved queries - Must have this permission for all the entity types included in the imported dashboards.

Exporting Dashboards

To export dashboards:

  1. Click image.png on the left navigation panel to open the Dashboard page.
  2. From the three-dot menu next to the Dashboard name in the Dashboard List or above the upper right corner of the Dashboard, select Export Dashboard. The Dashboard is downloaded to your local computer as a JSON file.

Importing Dashboards

To import dashboards:

  1. Click image.png on the left navigation panel to open the Dashboard page.

  2. From the Add Dashboard dropdown, select Import Dashboard.

  3. Navigate to the location of the dashboard JSON file and select it.

  4. Click Upload.

  5. In Dashboard name, enter a descriptive name for the Dashboard.

  6. Under Access, select specific roles you want to have access to the Dashboard. The Dashboard creator always has Editor access.
    NewDashboardWithDS-New-RolesSelection.png

    Note:

    When importing multiple dashboards at the same time, the selected access settings are applied to them all.

    Then, select the permission the selected roles are granted:
    NewDashboardWithDS-New-Permission.png

    • No Access - The selected roles will not have access to the Dashboard. This is useful if you want to grant access to all roles except a few.
    • System Access - The selected roles are granted access according to the permissions configured for each role.
    • Viewers - The selected roles only have permission to view the Dashboard, regardless of the permissions configured for each role.
    • Editors - The selected roles have permission to view and edit the Dashboard, regardless of the permissions configured for each role.
    NOTE
    See Managing Roles for more information about assigning permissions to roles at the system level.
  7. For All roles, select the permission level for all roles not specifically selected above.
    NewDashboardWithDS-New-AllOtherRoles.png

    A description of the access settings is displayed in the blue message area.

Note:

Share with selected roles within all Data Scopes is not available for imported dashboards.

  1. Select Admin Access Only to give access only to users with the Admin role.
  2. In the Import Dashboard dialog, select what to do if a dashboard or one of the underlying queries with the same name as that being imported already exists.
    • Click Overwrite to import the dashboards and overwrite the previously existing dashboards with the same name.
    • Click Create a Copy to import the dashboards using the same name as the existing ones. The existing dashboards are still available.
  3. Click Save. The Dashboards are imported and added to the Dashboard List according to the access permissions you selected.

Was this article helpful?