Restoring UI configuration data (on-prem)

Agile Service Manager includes a backup facility, which lets you backup UI configuration settings such as user preferences, topology tools, custom icons, relationship types, rules and advanced topology settings. This topic describes how to import previously exported (backed up) settings in order to restore your previous configurations.

Before you begin

You can only import and restore configuration settings that have been previously exported, as described in the Backing up UI configuration data (on-prem) topic

The tool detects the host, port, and tenant id for the Topology Service from the following environment variables:

TOPOLOGY_SERVICE_HOST
TOPOLOGY_SERVICE_PORT
TENANT_ID

Important: If you have a standard installation of Agile Service Manager core, and none of the default settings have been changed, the tool will work without you having to reset any of these environment variables. However, if you do have a non-standard installation, you need to reset these before running the tool.

About this task

Import syntax

This command must be run from the ASM_HOME directory:

import_ui_config.sh

Example:

import_ui_config -file <input_file> [-overwrite] [-verbose]

Tip: For help:

import_ui_config.sh -help

Import parameters

file: The -file parameter is the name of the backup file from which to import definitions. It must be a file name only with no directory paths included, and it must exist in the tools data directory ($ASM_HOME/data/tools).
overwrite: By default, as the import tool reads the backup file it looks up each item in the topology service to see if it already exists. Any configuration definitions which already exist are not updated.; However, if you set the -overwrite flag, the existing definitions are overwritten with the values from the backup file.
verbose: The -verbose flag runs the tool in verbose mode, whereby extra log messages are printed to the shell during execution.; Useful if a problem occurs running the tool and you want to re-run it with extra information made available.

Restriction:

Jobs are not imported into systems where the observer has not been installed.
Jobs are not imported into systems where the observer job already exists (that is, where a job with the same name exists for the same observer).
Jobs are imported but cannot run if the encryption key on both source and target system don't match. See the following topic for more information on Changing encryption keys and passwords.

Procedure

Using the syntax information provided, enter the file name of the previously exported backup file.
Determine if any other <options> you need to set, such as the -overwrite flag.
Run the import_ui_config command from your ASM_HOME directory, as in the following example.
```
import_ui_config.sh <options>
```

Results

The Agile Service Manager UI configuration data is imported from the specified file in the ASM_HOME/data/tools directory. If the -overwrite flag has been set, existing configuration data will be overwritten.