Import and Export of Instance Configurations

Overview

In CDCM some customization data of a certain space can be transfered from one instance to another.

Customizations include:

• Properties

• Complex Properties

• References

• Master Data Tables

• State Machines

• Concept Types

Export

Exported customizations are represented in the JSON format. To export customization data from one instance of CDCM, please use on of the following methods:

Via User Interface

1. Navigate to Admin Area: Access the admin area of Smartfacts CDCM. (Cogwheel icon at the bottom left in the side menu)

2. Select Export & Import

3. Click on the Export Metadata button

4. A file will be downloaded via the browser

Via Endpoint

1. Perform a GET on /{spaceKey}/api/v1/deployment/customizations/export

2. Save the response as a JSON file

Import

Exported data sets of customization data can be imported to another instance. Each set of data is recognized by its key. If the instance already has values in it and a key with the same name already exist in that instance, its values will be updated to match the data from the export. Otherwise a new set of data will be created. If there is a key thats not included in the exported data set, it remains unchanged.

In order to not cause any data integrity issues, we recommand to not import data from another version of CDCM. On import, there version will be checked and, in case its not matching the version from the data source, a warning will be issued. This warning needs to be confirmed in order to actually execute the import process.

To import customization data from one instance of CDCM, please use on of the following methods:

Via User Interface

1. Navigate to Admin Area: Access the admin area of Smartfacts CDCM. (Cogwheel icon at the bottom left in the side menu)

2. Select Export & Import

3. Click on the Import Metadata button

4. Choose the file which contains the exported content

   1. If Confirm possible version mismatch is checked, no additional confirmation of a possible version missmatch will be issued

5. Click on the button Import

Via Endpoint

1. Perform a POST on /{spaceKey}/api/v1/deployment/customizations/import

The following attribute can be set:

If set to true, the operation will be performed even if there is a version missmatch detected

Also, there is the option to just determine how the outcome of the import (how many data sets will be updated and how many will be created) would look like.

For this, perform POST on /{spaceKey}/api/v1/deployment/customizations/import/impact with the same parameter as above.