Edit on Github

Export and Import

With Optimize 3.3.0, a new exporting/importing feature has been added to Optimize. Currently, this feature is limited to Reports and Dashboards, but in the future users will be able to export and import Collections as well. Please note that for now, only superusers are authorized to export and import Optimize entities.
This section describes importing and exporting via UI, for exporting and importing via API please refer to the respective REST API documentation.

Exporting Entities

Users can export entities by accessing the Export option in the entity menu. This downloads a JSON file which includes all relevant information that defines the selected entity. This file can later be used to import the exported entity into a different Optimize installation.

Importing Entities

Prerequisites

Exported entities can be imported both as private entities as well as into a selected Collection, provided the following prerequisites are met:

  • All definitions the entity requires exist in the target Optimize.
  • When importing into a Collection, the Collection Data Sources must include all relevant definitions for the entity.
  • The importing user is authorized to access the relevant definitions.
  • The entity data structures match. To ensure matching data structures, please confirm that the Optimize version of the source is the same as the version of the target Optimize.

If any of the above conditions are not met, the import will fail. Optimize will display an error message explaining why the import was not successful to enable you to fix the issue and retry.

Importing Private Entities

To import an entity as a private entity, use the Import JSON option from the Create New menu on the welcome page. The entity will appear in the entity list once the import is finished and can be interacted with as usual.

Importing Entities into a Collection

If you wish to add the entity to an existing Collection, use the same Import JSON option from the Create New menu from within the selected Collection. This will import the entity into the Collection. Any user that has access to this Collection can now also access the imported entity. Please note that the Collection must have all data sources required by the imported entity, otherwise the import will fail.