Importing and Exporting Dashboards
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.
ImportantAccess permissions are NOT exported with dashboards. When importing, you can set the access level.
- 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.
- To import a dashboard to Shared access, import to Public or Private first and then edit the dashboard and set the access to Shared.
- 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:
- Click
on the left navigation panel to open the Dashboard page. - From the three-dot menu next to the Dashboard name in the Dashboard List or above the upper right corner of the Dashboard, point to Export and select JSON. When JSON is the only format that the menu offers, select Export to JSON. The Dashboard is downloaded to your local computer as a JSON file.
To export several dashboards, go to Manage Dashboards > Dashboard Manager, select the dashboards, and click Export. Alternatively, in the folder tree of the Dashboard Manager, open the menu of a folder and select Export.
The export file saves the folder path of each dashboard, which is the names of the folders below the Public, Shared, or Private root. The export writes only the folders that you can see.
Importing Dashboards
Notes
- When importing multiple dashboards at the same time, the selected access settings are applied to them all. Dashboards cannot be assigned Shared access during the import.
- Only users in the Global data scope can assign Shared access. To do this, import the dashboard to Public or Private and then edit the dashboard to have Shared access.
To import dashboards:
- Click
on the left navigation panel to open the Dashboard page. - Click the arrow of Create Dashboard and select Import.
- Navigate to the location of the dashboard JSON file and select it.
- Click Upload.
- In Dashboard name, enter a descriptive name for the Dashboard.
- Under Who has access, select specific roles you want to have access to the Dashboard. See Who Has Access for more information.
- Select Admin Access Only to give access only to users with the Admin role.
- 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.
- Click Save. The Dashboards are imported and added to the Dashboard List according to the access permissions you selected.
Importing Several Dashboard Files
Use Import to import dashboards from several JSON files at once. Before the import starts, you review the dashboards of each file and decide what to do when a dashboard name is already in use. After the import, you see the result for each dashboard.
Permissions: To import dashboards, you need the Dashboards > Dashboards > Import and Add and edit permissions. The saved query permissions that apply to a one-file import also apply to each file.
To import several dashboard files:
- Click
on the left navigation panel to open the Dashboard page. - Click the arrow of Create Dashboard and select Import.
- Select two or more dashboard JSON files. The Import Dashboards dialog opens. When you select one file, the import works as described in Importing Dashboards.
- Review the list of files. Each file shows its dashboards and the number of charts in each dashboard.
- (Optional) To skip a dashboard, clear its selection. To remove a file from the import, click the close icon of the file.
- (Optional) To add more files, drop them in the drop zone, or click the drop zone and select the files.
- If a dashboard name is already in use, select an action for each name. To use the same action for all names, select Apply to all. The actions are:
- Skip - Keep the existing dashboard.
- Replace - Replace the existing dashboard with the imported dashboard.
- Import as a copy - Import the dashboard and keep the existing dashboard. Axonius adds the date and time to the name of the copy.
- In When a saved query with the same name exists:, select Import a copy or Replace the query.
- Click Next.
- In the second Import Dashboards dialog, select the access and the Folder. Then click Import.
- Read the results, and then click Close. To open an imported dashboard, click Open next to it.
Limits and behavior:
- You can import up to 20 files at a time. Axonius adds the same file (same name and size) only one time.
- Next is disabled until you select an action for each name that is already in use. There is no default action.
- A dashboard name that more than one selected file has is listed one time.
- With Skip, Axonius imports the dashboard of the first file and skips the others.
- With Replace, the dashboard of the last file replaces the existing dashboard. Axonius skips the dashboards with that name in earlier files.
- With Import as a copy, Axonius imports every dashboard.
- The saved query default is Import a copy.
- Axonius applies the access and the folder that you select to every dashboard that the import sends. You can rename the dashboards after the import.
- Only a public dashboard can be replaced, and not with a private one. In other cases, Axonius imports a copy and says so in the results.
- Axonius imports the files one at a time. A file that fails doesn't stop the other files. A file that Axonius can't read, for example a file with no dashboards, isn't imported, and the dialog shows the reason.
- The results show each dashboard as imported, replaced, imported as a copy, skipped, or failed, with the reason. The summary shows the number of dashboards imported, skipped, and failed.
Example: You import it-ops.json and security.json. Both files have a dashboard named Weekly Overview, and a dashboard with this name exists in Axonius. You select Replace. The Weekly Overview dashboard from security.json replaces the existing dashboard. Axonius skips the Weekly Overview dashboard from it-ops.json.
Importing Dashboards into Their Folders
Use the folder paths in the export file to import each dashboard into the same folders that it had on the source system. There is no setting for this. An import always keeps the folders of a file that has them.
Permissions:
- To import dashboards, you need the Dashboards > Dashboards > Import and Add and edit permissions.
- To create a missing folder below Public, you need the Manage dashboard folders permission.
- To create a missing folder below Shared, you need the Manage dashboard folders and Add and edit for all data scopes permissions.
- To create a missing folder below Private, you need only the permission to import. The import uses only your own Private folders.
- If you can't create a folder, you can still import. The dashboard goes into the deepest folder of its path that exists.
To import dashboards into their folders:
- On the source system, export the dashboards as JSON. See Exporting Dashboards.
- On the target system, go to Dashboards.
- Click the arrow of Create Dashboard and select Import.
- Select one or more JSON files.
- If you select two or more files, the Import Dashboards dialog opens. Each dashboard row shows its folder path at the end of the row, after a folder icon, for example Operations / Weekly. Select the dashboards and click Next.
- In the access step, select the access. When a file has folder paths, the Folder field starts at the root of the tree: Public, Shared, or Private.
- Read the help line under the Folder field:
- For several dashboards: "Dashboards go into their folders from the files, in this folder".
- For one dashboard: "The dashboard goes into "
- To create the same folders at the top of the tree, keep the root. To create the folders below another folder, select that folder.
- Click Import (two or more files) or Save (one file).
The import finds each folder of the path by its name, or creates it. Then it puts each dashboard into the last folder of its path.
- An existing folder with the same name in the same parent folder is used. Uppercase and lowercase letters don't matter, and the import doesn't create a second folder.
- A dashboard at a root, not in a folder, has no folder path. It goes into the folder that you select.
- A dashboard in Managed by Axonius has no folder path.
- The dashboard of an asset type, from the Dashboards tab of an asset page, has no folder. Its import creates no folder.
- A file that an earlier version exported has no folder paths. Its dashboards go into the folder that you select. When a file has no folder paths, the Folder field starts in the folder that you used last.
- A dashboard that you don't import, because you cleared its selection or selected Skip for a name that is already in use, creates no folder.
- With Replace, the imported dashboard replaces the existing one and moves into the folders of its file.
- Folder rules apply: a folder name has at most 100 characters, and the folder tree has a depth limit. A folder that the import can't create ends the path at its parent folder.
- Each folder that the import creates gets an entry in the Activity Log.
- When the import can't create or use a folder, it tells you where the dashboard is. For several files, the row in the results dialog says it, for example "Imported. Could not put it in the folder "Weekly", so it is in "Operations"". For one file, the success message says it, for example "The selected dashboard was imported successfully. Could not put "Patch Status" in the folder "Weekly", so it is in "Operations"."
Example: On system A, the dashboard Patch Status is in Public > Operations > Weekly. An Admin exports it as JSON. On system B, the Admin imports the file and keeps the Folder field at Public. The import creates the folders Operations and Weekly below Public and puts Patch Status into Weekly. If system B already has a folder named Operations below Public, the import uses that folder.
Updated 10 days ago
