When exporting and importing Reports and Schedules, please consider the following points:
...
Similar to Exporting/ Importing Data Connections, the dependencies rely on the identifier of an element not the content itself. For example, if a Report uses a chart and the target system also contains such a chart , it doesn't matter what the content is , the dependency is automatically fulfilled
Reports depend on Data Connections, Charts , and Categories whereas Schedules depend on everything else e.g. Charts, Reports , Usersand Users
Order of import
Importing into your Dashboard will be done in the following order:
Data Connections - which may also contain Charts and Categories that are used by Reports
Reports - which may be used by Schedules
Schedules
Working with old export files and new version of the dashboard
The dashboard doesn’t accept old versions of the exported files, but it handles upgrading data itself, so if you need to use an old version of the exported files, the best approach is to use the dashboard to upgrade these files. This approach is suitable for Data Connections, Reports, or Schedule imports.
For example, if you have a file exported using the 2022.7 version of the dashboard, you won’t be able to import it directly into the latest version of the Dashboard without following the steps listed below:
| Info |
|---|
The following steps refer to a 2022.7 version of the Dashboard as an example, please change the instructions to the version of the Dashboard you are using |
Install a clean version of 2022.7 dashboard
Import the 2022.7 files into the dashboard
Upgrade this dashboard to the latest version - this internally migrates/ upgrades everything to the latest structure
Export the files from the latest version of the Dashboard
By taking these steps, the files will be compatible with the latest version of the Dashboard.
| Info |
|---|
You can teardown this Dashboard afterwards because it’s only used for the migration. |
The implementation covers:
Reports
exporting reports via the UI (allow ticking to select what to export)
exporting reports via the API (exports every item)
importing reports via the UI (allow ticking to select what to import)
importing reports via the API (imports every item and override)
API getting all reports' meta data -- (similar to charts, it doesn't include the details)
API getting one report's meta data
API deleting reports
API documentation for export import reports, GET and DELETE reports
Schedules
exporting schedules via the UI (allow ticking to select what to export)
exporting schedules via the API (exports every item)
importing schedules via the UI (allow ticking to select what to import)
importing schedules via the API (imports every item and override)
API getting all schedules' meta data
API getting one schedule's meta data
API deleting schedules
API documentation for export import schedules, GET and DELETE schedules
Order to import:
...
Step 1: Data Connection - which may also have Charts and Categories used by Reports
...
...
Step 3: Schedules
Additional Notes:
...
...
Similar to Data Connections, the exported files can only be used by the same version of the dashboard
...
Similar to Charts, due to the complexity and the strict internal logic, we don’t have APIs for creating or editing Reports and Schedules. Users can only use the UI to create or edit Reports and Schedules with visual feedback.
Typical Use Cases:
Transitioning implementation from Dev to Live
Data Connections, Categories, Charts, Reports and Schedules are developed in the Dev environment
Files are exported and imported into the Test/UAT environments for UAT, manually or using the API
Afterwards they are imported to LIVE
Back ups and version controlling dashboard config
Working with old export files and new version of the dashboard:
The dashboard doesn’t accept old versions of the exported files, but it handles upgrading data itself, so if you need to use an old version of the exported files, the best approach is to use the dashboard to upgrade these files. This approach is suitable for Data Connections, Reports, or Schedule imports.
For example, if you have a file exported using the 2022.7 version of the dashboard, you won’t be able to import it into 2023.1. (This is a hypothetical example, we haven’t got a 2023.1 version) You can take the following steps:
Install a clean version of 2022.7 dashboard
Import the 2022.7 files into the dashboard
Upgrade this dashboard to 2023.1 - this internally migrate/upgrade everything to the latest structure
Export the files from the 2023.1 dashboard
You can teardown this dashboard afterwards because it’s just to be used for the migration
By taking these steps, the files are compatible with a 2023.1 dashboard.