This section provides information about how to install and configure CCW, and how to use it to migrate your Configuration Database schema or locale.
Install Configuration Conversion Wizard only if you want or need to upgrade the Configuration Database (see the table here to help you decide). Use the following procedure:
Prerequisite
- DB Server is installed and connected to the existing Configuration Database.
- No previous version of CCW is installed on this machine; if so, uninstall it before beginning this procedure.
Procedure
- Locate the installation package on the Management Framework product DVD in the configuration_layer/convers_wizard/window directory.
- Locate and double-click Setup.exe to start installation.
- Specify the program folder to which you want to add CCW. By default, it is added to the Genesys Solutions/Framework folder.
- When the CCW icons appear, click Finish to complete the installation.
When the setup program is finished, CCW is ready to start; however, to operate, it requires that you specify connection parameters, as specified in the following section, Specifying the Database Connection.
Specifying the Database Connection
To connect to your existing Configuration Database, CCW requires information about that database and the DB Server through which the database is to be accessed. You provide this information in one of two ways:
Configuring the Local Configuration File
To create a file listing database connection parameters, do the following:
- Open the local configuration file (convers.cfg) in the directory where CCW is installed.
- Within this file, specify the values for the configuration options described in this section. For configuration option values, use information about DB Server, the existing Configuration Database, and the DBMS user account through which the database is currently accessed. See “Sample Configuration File” for an example of a database connection configuration file.
Warning
Do not use the
Tab key for entries in the configuration file.
- Save the configuration file.
Entering Connection Parameters Dynamically
If you do not configure a configuration file with the connection parameters, CCW prompts you to enter the parameters during startup.
To provide CCW with information about the Configuration Database and about the DB Server through which CCW must access this database, the following parameters are required:
- The host name of the computer running DB Server that provides access to the Configuration Database.
- The TCP/IP port that clients should use to connect to the DB Server through which the Configuration Database is to be accessed.
- The type of DBMS (engine) that handles the Configuration Database.
- The name or alias identifying the DBMS that handles the Configuration Database.
- The name of the Configuration Database to be accessed as specified in the DBMS that handles this database.
- The user name established in the DBMS to access the Configuration Database.
- The password established in the DBMS to access the Configuration Database.
CCW Configuration Options
Specify values for the following options to provide CCW with information about the Configuration Database, and about the DB Server through which CCW must access this database.
Important
If you are changing the connection parameters after initial installation, you must save the configuration file and re-specify it in the
Connection to the Configuration Layer Database screen of CCW.
host
Default Value: No default value
Valid Value: Any valid host name
Changes Take Effect: After configuration file is specified in CCW
Specifies the host name of the computer running DB Server through which the Configuration Database is to be accessed.
port
Default Value: No default value
Valid Value: Any valid TCP/IP port
Changes Take Effect: After configuration file is specified in CCW
Specifies the TCP/IP port that clients should use to connect to the DB Server through which the Configuration Database is to be accessed.
dbengine
Default Value: No default value
Valid Values: oracle, mssql, db2, postgresql
Changes Take Effect: After configuration file is specified in CCW
Specifies the type of DBMS that handles the Configuration Database.
dbname
Default Value: No default value
Valid Value: Any database name
Changes Take Effect: After configuration file is specified in CCW
Specifies the name of the Configuration Database to be accessed as specified in the DBMS that handles this database. A value for this option must be specified unless dbengine=oracle.
dbserver
Default Value: No default value
Valid Value: Any valid entry name
Changes Take Effect: After configuration file is specified in CCW
Specifies the name or alias identifying the DBMS that handles the Configuration Database.
dbtimeout
Default Value: No default value
Valid Value: Any positive integer
Changes Take Effect: After configuration file is specified in CCW
Specifies the maximum time, in seconds, before which CCW should cease attempting to make its initial connection to DB Server.
dbrequest-timeout
Default Value: 30
Valid Value: 1 – 3000
Changes Take Effect: After configuration file is specified in CCW
Specifies the maximum time, in seconds, in which the database request should be completed. If the request does not complete in this time, the request is cancelled, the import procedure is aborted, and a corresponding message is displayed to the user.
username
Default Value: No default value
Valid Value: Any character string
Changes Take Effect: After configuration file is specified in CCW
Specifies the user name established in the DBMS to access the Configuration
Database.
password
Default Value: No default value
Valid Value: Any character string
Changes Take Effect: After configuration file is specified in CCW
Specifies the password established in the DBMS to access the Configuration Database.
If required, you can encrypt this password in the database, so it does not appear
in plain text in logs or other reports. For more information, refer to the
Genesys Security Deployment Guide.
delete-in-size
Default Value: 200
Valid Value: 1 – 32767
Changes Take Effect: After configuration file is specified in CCW
Specified only when migrating from release 6.5; specifies the number of fields in an SQL query that uses the IN statement, such as:
DELETE... FROM ... WHERE ... IN (X1, ..., An)
where n = value of delete-in-size.
Use this option to limit the length of SQL queries that use the IN statement.
Sample Configuration File
host = db-host
port = 4040
dbengine = mssql
dbserver = server_name
dbname = config
username = DBMS_user
password = DBMS_user_password
Using CCW to Migrate Your Configuration Database or Locale
You do not always have to migrate your Configuration Database to the current format—see the table here to determine if you need to upgrade to the 8.5 format, or just upgrade the locale. But if you do need or want to upgrade, use CCW.
Migrate the Database
Use the Genesys Configuration Conversion Wizard (CCW) to convert existing data structures to the current format. CCW performs automatic migration from any release to the current release of Management Framework. When migrating the Configuration Database, CCW uses a copy of the original database, and migrates that copy. This enables you to keep the original Configuration Database and Configuration Server in service while you are performing the migration.
CCW only converts the database structures originally created with the Genesys initialization scripts. CCW does not convert any custom tables or columns that you might have added to the Configuration Database.
After the conversion, CCW generates a detailed report of conversion statistics, including database changes, for your review. The same information is stored in a log file that CCW creates for each working session.
Upgrade the Locale
If your current Configuration Database is using the 8.1.1 or later schema, you do not have to migrate your database to get new data types and enumerators that have been added in the new Configuration Database schema. If you want to use the new types and enumerators, you can use CCW to update only the localization information stored in the database. Otherwise, you do not need to do anything - the new version of Configuration Server 8.5 will run against your current Configuration Database. Future versions of Configuration Server will include extensions to the list of application types you can utilize without migrating your system.
To upgrade your locale, use the instructions in the Using CCW tab in Upgrading Configuration Definitions.
Important
To update the locale, you must use the version of CCW that is the same as your current database. For example, you must use CCW 8.1 for 8.1 databases, and CCW 8.5 for 8.5 databases. You can only upgrade your locale if the database has already been migrated. That is, CCW will not offer the option to upgrade the locale if the database is older than CCW itself.