Skip to content

Backup and Restore

The MetaKarta Backup and Restore are not a substitute for the repository database backup and not a means for upgrading the system. I.e., never try to restore a backup from an older major release version to a newer one.

The UI based backup/restore use cases are typically:

  • For support to reproduce issues as explained in the Help: http://metaintegration.com/Products/MIMM/OEM/MITI/Help/MetadataManager/#!Documents/reportingissues.htm

  • To deliver demos/tutorial

  • To reproduce production in a demo/QA environment (e.g., with a backup without content and harvest in production)

  • To migrate to a new type of database such as PostgreSQL to Oracle.

The rules by which the backup and restore process works are as follows:

  • A repository backup may be performed at the repository root level, or at any repository sub levels. In all cases, the full path of the backup starting level is not recorded within the backup so that it can then be restored at any repository sub-levels later.

  • When restoring a repository backup, some repository objects may already exist and will be reused as is (rather than overwritten) by the content of the backup.

  • Any repository backup may contain repository objects having repository object dependencies, which is generally the case for a Directory, Configuration, Data Mapping, Semantic Mapping or Physical Data Model. Each dependent repository object is saved in the backup with its full path from the root. Therefore, when performing the backup, the start level name must not conflict with any root level object names.

Creating a Backup

The UI based backup/restore use cases are typically:

  • For support to reproduce issues as explained in the Help: http://metaintegration.com/Products/MIMM/OEM/MITI/Help/MetadataManager/#!Documents/reportingissues.htm

  • To deliver demos/tutorial

  • To reproduce production in a demo/QA environment (e.g., with a backup without content and harvest in production)

  • To migrate to a new type of database such as PostgreSQL to Oracle.

The rules by which the backup and restore process works are as follows:

  • A repository backup may be performed at the repository root level, or at any repository sub levels. In all cases, the full path of the backup starting level is not recorded within the backup so that it can then be restored at any repository sub-levels later.

  • When restoring a repository backup, some repository objects may already exist and will be reused as is (rather than overwritten) by the content of the backup.

  • Any repository backup may contain repository objects having repository object dependencies, which is generally the case for a Directory, Configuration, Data Mapping, Semantic Mapping or Physical Data Model. Each dependent repository object is saved in the backup with its full path from the root. Therefore, when performing the backup, the start level name must not conflict with any root level object names.

Steps

  1. Sign in as a user with at least the A and with Metadata Reader privileges to all the models and configurations contained with the backup scope.

  2. For a complete configuration backup, Go to MANAGE > Configuration and More Actions and select Backup

  3. For any other backup Go to MANAGE > Repository

  4. Select the root object in the Repository Panel which will be backed up. Remember, all contained models and configurations will also be backed up.

  5. Right-click and select More -> Backup.

  6. If the issue is related to users, groups, capability global role assignment or other system configuration settings, be sure to select YES for BACKUP SYSTEM MANAGED OBJECTS like Groups.

For security reasons, user passwords are reset to their user names.

  1. Be sure to select the check box for BACKUP CACHED MODELS of models.

  2. Click on the BACKUP button.

  3. Wait for the operation to finish and open the log for that operation.

  4. Click Download and save to a location.

Example

Sign in as Administrator and go to MANAGE > Configuration.

Click More Actions > Backup in the header of the list of models.

Click BACKUP.

A blue and white box with black text Description automatically
generated

Open the log for the finished operation.

Click Download Operation Files.

It produces a file like:

MM-Backup-Development-2021-05-28.zip
Explore Further
Backup system managed objects (users, groups, custom attributes, data classes)

You may include system objects like Users and groups Check this checkbox to ensure that this information is included in the backup.

For security reasons, user passwords are not backed up. On restore they are reset to their user names.

Backup all versions of models (as MIR XMI files)

You may include all versions of Models (as MIR XMI files). By default it will not be included.

If you do not include this option, then only the model definition will be included, and none of the versions imported.

Check this checkbox to ensure that the models themselves are included in the backup.

Remove business data and personal information

Removes:

  • all data profiling and sampling information (retaining only metadata names)

  • and removes all personal information including all information on users (names, emails, etc.)

  • and all bridge parameters (such as user names and passwords used to connect to databases)

Check this checkbox to ensure that this information is not included in the backup.

Save Logs for support (not Restore) purposes

If creating the backup to report an issue, please be sure to include the import and other log information. Please see details here where you may also produce a Troubleshooting package.

Restoring a Backup

One may restore a backup using either the Metadata Manager UI or the Metadata Explorer UI.

When restoring using the Metadata Explorer UI, which is restricted to a specific configuration, the structure of the backup must match the current configuration, including configuration name and folder path in the repository. If they do not match, you should create a new empty folder using the Metadata Manager UI and restore there.

Steps

  1. Sign in as a user with at least the A and the Metadata Management capability object role assignment on the (folder or parent folder of a configuration restore) where you plan to restore.

  2. For a configuration restore, Go to MANAGE > Configuration and More Actions and select Restore.

  3. For any other backup go to MANAGE > Repository and right-click the folder in the Repository Panel inside which the restored model will be placed and select Restore.

Be sure the selected folder is empty.

The restore menu item for a configuration is only visible when the user has Metadata Management capability object role assignment on the configuration and the configuration management and version management features are not enabled, i.e., only with single version and single configuration licenses.

Example

Sign in as Administrator. Go to MANAGE > Repository and right-click on the repository root and select New > Folder.

A screenshot of a computer Description automatically
generated

Give the folder a NAME and click OK. Then right-click on that new folder and select Restore.

A screenshot of a computer Description automatically
generated

Browse to the backup file (local on your machine) and click RESTORE.

If you cannot find the location using the Browse function you must configure (as part of the installation) the available paths to present to users. More details may be found in the deployment guide.

A white rectangular object with a white stripe Description
automatically generated

A blue and white box with black text Description automatically
generated