Apply a console export file
This section explains how to apply an export file created in the same Collibra version as your current version. You can use export files to recover from data corruption or transfer data between environments.
- Applying a console export file that includes data overwrites any data created or imported after the export file was created. This data is irrevocably lost.
- You cannot apply a console export file created in a newer Collibra version on an older Collibra environment. You can, however, apply an older version in a newer environment.
- Console export files from versions older than 5.5.x do not include certificates. You need to reinstall any necessary certificates, such as those for secure communication with the Jobserver.
- If you apply an export file from a 5.7.x version or older without history, the data quality metrics do not work correctly. To resolve this issue, apply the file in your latest environment, upgrade the data, create a new export file, and apply the new file in the same environment.
- If the Collibra environment you want to restore has one or more Edge sites, you need to reinstall all of them. To reinstall one or more Edge sites, go to Reinstall an Edge site.
Steps
You can apply an export file from the Console Export Files page or the environment overview page:
- Open Collibra Console with a user profile that has at least the ADMIN role.
Collibra Console opens with the Infrastructure page.
- In the main menu, click Console Export Files.
The Console Export Files page appears.
- Click
Apply Restore in the row of the export file you want to restore.
- Click the name of an environment to show its details.
- Click More → Apply console export file.
- In the Applying console export file dialog box, enter the required information:
Option Description Environment Select the environment where you want to apply the export file. Backup Select the export file you want to apply. Include You can apply an export file fully or partially. Note If the file is a partial export, you cannot select the excluded options.
Data The core database data of the Collibra environment. This encompasses all data related to communities, domains, assets, users, operating model, and similar objects. History Data activity and snapshot-related information. Configuration The configuration of the Collibra environment. Warning Do not select this option if you restore a console export file from another environment, as it will overwrite the configuration of your current environment. This can prevent your environment from starting up again.
Customizations The customizations such as custom modules, styling, page-definitions and email template files.
This includes files that are located in the Collibra user home directory and files that are used to customize the Collibra environment (/opt/collibra_data/console/config), such as the ones in:
- email-templates
- groovy-lib
- images
- page-definitions
- security
- styling
- translations
- modules (if available)
- Click Apply console export file.
The console export file is applied to the selected environment. The time to apply an export file depends on the amount of data it contains. During this time, your environment is unavailable. The process is complete when all services in your environment have the running status again.
When you include the configuration option, the database connection information in the console export file is ignored. The restore process ensures that the entire exported configuration is applied to the current configuration without modifying the current database connection. This means the existing database connection is used to restore the data. After the restore, the Collibra environment continues to use the same database connection.
- You cannot apply a console export file from a Collibra environment that uses a database with a case-sensitive collation sequence to an environment that uses a database with a collation sequence that is not case-sensitive. If you want to use console export files to migrate Collibra content, ask your database administrator to determine whether the collation sequences of the databases used by your source and target environments are compatible.
- If you apply an export file without the history, Collibra does not restore the activity stream as it was. Instead, it creates the entries in the activity stream as if they were performed by the System User on the restore date.