# Genesys Quality Management Suite 8.1.520 : Configuration Migration Tool

## Description

This script backs up the existing Call Recording configuration of the old server. It allows this configuration to be used on the new server. This saves the time that manual configuration of the new server takes.

## Obtain the Script

From the portal to the old server, download the ISO for the target version of Call Recording. The backup script is part of the installation ISO from versions 8.1.504, 8.1.511, and 8.1.520 onwards. It backs up version 8.1.485 till 8.1.494 and onwards.

In previous versions of Call Recording, the script is in the `/opt/callrec/bin` directory:

`configuration_backup.sh`

## Run the Script to Back up the Configuration Manually

The backup script has no mandatory parameters. Optionally, specify a [filename] parameter. Do not use spaces in the filename.

If you don't specify a name parameter, the output name will automatically be in this form:

backup-timestamp-.tar.gz.

The timestamp is in the YYYY-MM-DD format.

Enter this:

    /media/cdrom/upgrade/configuration/configuration_backup.sh [filename]

If any of the keymanager/filter factories files are present, the script asks you to enter a password twice. If the passwords do not match, the script asks you to enter them until they match. The minimum password length is six characters.

Icon

Write the password in a safe place. You will provide it when the backup is restored to the new server.

The script produces a tar.gz file that includes the configuration files. These files have an absolute path inside the tar. When the script finishes, it displays the [path] and <filename> of the resultant backup file.

For example:

    The backup file /tmp/backup.tar.gz has been created

Icon

Copy the backup file and keep it in a safe place on a local machine. It is required when the backup is restored to the new server. Note the filename and path. Specify the filename and path when you restore the backup.

## List of Backed Up Files

The list of backed up files is:

- /opt/callrec/speechrec/speechrec.cfg (callrec.cfg on versions 5.0.X and 5.1.0)
- /opt/callrec/data/psql/pg_hba.conf
- /opt/callrec/data/psql/postgresql.conf
- /opt/callrec/etc/config_manager.xml
- /opt/callrec/etc/core.xml
- /opt/callrec/etc/decoders.xml
- /opt/callrec/etc/deployment.xml
- /opt/callrec/etc/drivers.xml
- /opt/callrec/etc/extras.xml
- /opt/callrec/etc/integration.xml
- /opt/callrec/etc/migration.xml
- /opt/callrec/etc/pci_compliance.xml
- /opt/callrec/etc/recorders.xml
- /opt/callrec/etc/scorecard_business.xml
- /opt/callrec/etc/screenrec.xml
- /opt/callrec/etc/sniffers.xml
- /opt/callrec/etc/tools.xml
- /opt/callrec/etc/webadmin.xml
- /opt/callrec/etc/callrec.conf
- /opt/callrec/etc/callrec.derived
- /opt/callrec/web/webapps/*/WEB-INF/web.xml
- All log4j.xml in /opt/callredc. Command find: find /opt/callrec -name log4j.xml
- /opt/callrec/web/conf/web.xml
- /opt/callrec/web/conf/server.xml
- /tmp/callrec_setup.cache if exists
- created dummy cache file in /home/admin

If the keymanager is installed, these files will be added. Their actual paths are defined in the file pci_compliance.xml:

- /opt/callrec/keys/pwds.properties
- /opt/callrec/keys/.keystore
- /opt/callrec/keys/.auth_keystore
- /opt/callrec/keys/.trust_keystore
- /opt/callrec/keys/enc/pwds.properties
- /opt/callrec/keys/enc/.auth_keystore
- /opt/callrec/keys/enc/.trust_keystore
- /opt/callrec/keys/dec/pwds.properties
- /opt/callrec/keys/dec/.auth_keystore
- /opt/callrec/keys/dec/.trust_keystore

If they exist, the filter factories files which are defined for the decoders in decoders.xml, are included in the backup file.

The list of files is one file per line in the script. Groups of files can be declared. For example, wildcards, like "`/opt/callrec/web/webapps/*/WEB-INF/web.xml`". This includes all web.xml in webapps/callrec, webapps/scorecard-webui, etc. (what can we put other) Commands that return a list of paths can be used as well, like 'ls' or 'find'.

## Restore the Configuration When Upgrading to New Hardware

The script requires a parameter on the invocation, <config_backup_file.tar>. This is the full path to the file obtained when you run the script:

    /opt/callrec/bin/configuration_restore <config_backup_file.tar>

In this version, these steps are required. For most, there is a default answer:

- Stop the Call Recording service. Default is 'y'. We recommend that you stop the Call Recording service before you start the configuration upgrade.
- Working directory. Default is '/opt/callrec/data/configbackup'. This specifies which directory is used to unpack the tar file and store the results. The directories 'unpacked' and 'result' are created in this directory.
- Password. If present, decrypts the keymanager files.
- Replace IP addresses. If the current IP address differs from the one stored in the backup callrec.conf file, in the RMIHOST value, replace all the IP addresses in the unpacked configuration files.
- IP address to replace. Do this if it differs from the current one. The default value is obtained from the RMIHOST property in the callrec.conf file.
- IP address to be replaced with. Default is the current IP address. This defines which IP address is a replacement.
- Detected source version. Default is 'y'. Confirm the backup file version. If you type 'n', provide a version of GQM or 8.0/1. in the digit.digit.digit format or "digit"."digit"."digit" for GQM.
- Detected target version. Same as above, with the current version.
- Commands directory. Default is '/opt/callrec/common/commands'. Specifies the directory with the configuration command files.
- Overwrite production files. Default is 'y'. If affirmative, at the end of the process, the files from the 'result' directory move to the production directories. The according file owners are set.

  The script displays this message:

      Merge finished. The result is in /opt/callrec/data/configbackup/result

  If the Overwrite production files are enabled with y, the script displays this message:

      overwriting files

- Start the Call Recording service. Default is 'y'. Restart the Call Recording service.

### Restore Tool Standalone Parameters

These parameters are available for the configuration restore tool:

- -file: Path to the file with the configuration changes. For more information about this file's appearance, consult the configuration files actions section. Do not use -file and -commandsdir together.
- -commandsdir: Path to a directory of files with configuration changes. Files are in alphabetical order. Do not use -commandsdir and -file together.
- -source: Path to the directory with the original configuration files. This directory should contain the same structure as the originals(for example, archivedir/etc/callrec). Do not use -source and -archive together.
- -result: Path to the directory where the result of the merge is saved. It replicates the structure of the configuration files (for example, resultdir/etc/callrec).
- -current: Optional path to the directory with the configuration files with replaced values. If you do not specify anything, the current configuration files (/etc/callrec) are taken to the restore tool.
- -archive: Path to the tar.gz file with the archived configuration files. Do not use with -source.
- -unpackto: If you use -archive, specify unpackto. This parameter defines where to unpack the configuration archive. Do not use this parameter with -source.
- -overwrite: If you use -overwrite, at the end of the process, the files from the result directory move to the production directories (/opt/callrec). This parameter is optional. If you don't use it, by default value 'n' is taken by the restore tool.

## Attachments:

site.xml (application/x-upload-data)
?xml version="1.0" encoding="UTF-8" ?> project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
body
- menu name="CallREC Configuration">
item name="Backup configuration scripts" href="configbackuptool/configbackuptool.html" /
item name="Configuration files operations" href="configbackuptool/configurationfilesactions.html" /
item name="Restore configuration scripts" href="configbackuptool/configrestoretool.html" /
/menu
menu ref="parent" /
menu ref="modules" /
menu ref="reports" /
/body
/project