› KCM Installation Guide › Export functionality and initialization of new components › Export KCM instance configuration

Export KCM instance configuration

ExportInstanceConfiguration.exe is a command-line tool designed to export a single KCM instance configuration into a .zip file. This configuration can be later imported to another KCM instance.

This tool does not support KCM

5.2, 5.3, and 5.4.

The tool can perform configuration export with or without infrastructure.

  • If exported without infrastructure, configuration contains the following items:
    • The dp.ini, dm.ini and itp.cfg configuration files of KCM Core.
    • The itprep.ini and pwdblacklist.txt configuration files of KCM Repository.
    • The itpmdkapi.ini configuration file of KCM RestAPI.
    • The log configuration of the KCM Designer.
    • The log configuration of the KCM Composer.
    • The custom KCM Core scripts.
    • The contents of the Did, Watermarks and Resources subfolders of the KCM Core work folder.
  • If exported with infrastructure, configuration contains the items above and also the registration information (partner, customer, an so on) of the source KCM instance.
Internal settings (such as internal addresses) will not be transferred by the import/export mechanism. These settings will be removed either by the export, or later by the import.

Before you start

  1. Make sure the account used to run ExportInstanceConfiguration.exe is included in the local Administrators group on the target server.
  2. Check your KCM version. ExportInstanceConfiguration tool supports the KCM product starting from version 5.2.0.

Parameters

To view the list of parameters for ExportInstanceConfiguration.exe, run it without any parameters.

Parameter

Required / Optional Description

KCM!Version

Required if KCM installation is not active

The KCM version to export from.

Enter version number in the format Major.Minor

Example: KCM!Version=5.5

If omitted, defaults to the currently active KCM installation.

Instance!Number

Required for on-premise installation

The number of the KCM instance to export from.

On Docker, this defaults to 1.

Instance!ExportConfigurationFile

Required The file to write the configuration export to.

Instance!ExportInfrastructure

Required

Boolean flag that specifies whether the configuration is exported with or without infrastructure settings.

  • If set to True, configuration export will include infrastructure settings.
  • If set to False, configuration export will not include infrastructure settings.
When exporting from KCM versions earlier than 5.5, it is not possible to add infrastructure to the export. In these cases, the Instance!ExportInfrastructure parameter will not be available.

Notes on usage

To create an export from an older KCM version, use the following procedure:

  1. Open the Software\KCMTools folder of the KCM 5.8.0 installation package and locate the following files:
    • ExportInstanceConfiguration.exe
    • ExportIsntanceConfiguration.exe.config
    • Nlog.config
    • All .dll files.
  2. Copy these files to the server on which the old KCM version is installed. All files must be placed in the same folder.
  3. From that folder, run ExportInstanceConfiguration.exe. If creating an export from an older KCM version, some configuration items may not be compatible with newer versions. Such items will be removed from the export. The result is a partial export, which can still be imported, although missing these items.
Check your KCM version. The import tool works only on KCM 5.5.0 version and higher, supporting only configuration export files created with the ExportInstanceConfiguration tool from the version to which you need to import.