Identity Manager - Migration Settings tool for exporting and importing client settings

[#1]

IDM 4.6 Dashboard introduces a new feature to customize UI settings, behavior, branding, and access to the application through client settings. There can be multiple such client settings on a single identity manager instance and different sets of users can map to different clients. The client settings include the branding settings, custom CSS, access settings, and custom behaviors.

The migration tool helps you migrate the client settings from one Identity Manager instance to another.

Where else is this tool useful?

Usecase 1: Primary usecase for this tool is to transfer settings from one Identity Manager instance to another. E.g. from your staging Identity Manager server to your production server.

Usecase 2: To take backup of all client settings and restore at a later point.

Usecase 3: To change storage option from file to database (Make sure to take the backup of settings before switching from file to database or vice versa).

 

Solution:

This is the tool to either export or import client settings from a server. The attached zip file contains one jar file and the silent properties file. You can set source and destination server details in the silent properties file for export and import client settings. The jar file you can run from a terminal with the following options:

Usage: java -jar MigrationSettings.jar [-option1] [value1]....[-optionN] [valueN]

Example 1: java -jar MigrationSettings.jar -e settings.json -f silent.properties

• By running this it will export all the client settings from source server which you have provided in the silent properties file.

Example 2: java -jar MigrationSettings.jar -i settings.json -f silent.properties

• By running this it will import all the client settings to destination server which you have provided in the silent properties file.

Example 3: java -jar MigrationSettings.jar -e settings.json -sp http -ss localhost -spo 8180 -srctx IDMProv -su cn= admin,ou=sa,o=data -spwd password

• By running this it will export all client settings from the server which you have given through command line

Example 4: java -jar MigrationSettings.jar -i settings.json -dp http -ds localhost -dpo 8180 -drctx IDMProv -du cn=admin,ou=sa,o=data -dpwd password

• By running this it will import all client settings to the server which you have given through command line

Where options include:

-e                   Export to file name (Example: clients.json)

-i                   Import settings from file name (Example: clients.json)

-sp                  Source Server protocol (http/https default: http)

-ss                  Source Server IP adrress(default: localhost)

-spo                 Source Server port (default: 8180)

-srctx               Source Server RBPM Context (default: IDMProv)

-su                  Source Username (Example: cn=uaadmin,ou=sa,o=data)

-spwd                Source Password

-dp                  Destination Server protocol (http/https default: http)

-ds                  Destination Server IP adrress(default: localhost)

-dpo                 Destination Server port (default: 8180)

-drctx               Destination Server RBPM Context (default: IDMProv)

-du                  Destination Username (Example: cn=uaadmin,ou=sa,o=data)

-dpwd                Destination Password

-f <filename>       Use this option for silent mode, load values from property file. This will override other options passed to this utility

 

Silent properties File:

source.protocol=http

source.ip=127.0.0.2

source.port=8180

source.rbpm.web.context=IDMProv

source.username=cn=uaadmin,ou=sa,o=data

source.password=password

destination.protocol=http

destination.ip=127.0.0.1

destination.port=8180

destination.rbpm.web.context=IDMProv

destination.username=cn=uaadmin,ou=sa,o=data

destination.password=password

Note: Source server properties are mandatory for exporting client settings and similarly destination server properties are mandatory for importing. If you do not give password property in the silent properties file, it will ask you in the command line.

Download:
Find from attachment.

[tschroeder13]

Hey all,

good to know, that there is a solution to the staging issue.

But I get following error message when runnung 

>> java -jar MigrationSettings.jar -e settings.json -sp https -ss localhost -spo 8543 -srctx IDMProv -su cn=uaadmin,ou=sa,ou=data,o=acme

>> Failed to get server settings. Reason: Connection refused (Connection refused)

Is there a switch for debugging? Any ideas?

Thx in advance and kind regrads

Tobias 

[tschroeder13]

Hey all.

please ignore my last comment. 

Problem was infront of the monitor.

KR

Tobias