Migrating Compass Web configuration settings

After upgrading HCL Compass, you might want to apply the same configuration settings to HCL Compass Web Server that existed in your previous configuration of Compass Web. Some settings are automatically propagated during the upgrade, while others must be set manually.

In Compass Web, HCL Compass Web Server configuration settings are set mostly in the Site Configuration dialog box of the Web client. The properties from the Application Server and Recycle Manager version of the common.properties file are set in common.properties file.

By default, when you uninstall Compass, the properties files listed in the following tables are preserved, and you can manually migrate the settings after you reinstall. However, you should also consider making additional backup copies of the files before removing the product. For more information about the uninstall tool, see Uninstall Compass. For more information about preserving properties files, see Preserve Compass Web configuration files.

To migrate previous configuration files:
  • The properties from the DCT.properties file must be converted to a new format for use with Compass latest version. For instructions on how to convert the file, see Migrating the DCT.properties file.
  • The Application Server and Recycle Manager versions of the common.properties file from earlier releases have been consolidated into a single common.properties file. The properties and their values have not changed. To maintain the earlier settings, migrate them to the latest version of the common.properties file. In the latest version, the location of the file common.properties is:
    Windows™
    /install dir\HCL\CCM\Compass\cqweb\cqwebprofile\installedApps\dfltCell\TeamEAR.ear\cqweb.war\WEB-INF\classes\common.properties
    Linux™ or UNIX™
    install dir/opt/hcl/ccm/compass/cqweb/cqwebprofile/installedApps/dfltCell/TeamEAR.ear/cqweb.war/WEB-INF/classes/common.properties
  • The properties from the files listed in the following tables are not automatically migrated during the upgrade process even if the user data preserved uninstall option was used. However, each properties file has corresponding configuration options in the Site Configuration window. See the tables below for these mappings.
The properties from rmmanager.properties can be set in the HCL Compass Web Server Options tab of the Site Configuration window.
Table 1. rmmanager.properties migration
rmmanager.properties HCL Compass Web Server Options
TIME_CRITERIA=DAILY|1:00 AM Recycle Server Lifetime Limit (seconds)
NUMBER_OF_REQUESTS_CRITERIA Recycle Server ONC RPC Call Limit (number)
The properties from csm.properties can be set in the HCL Compass Web Server Options tab of the Site Configuration window.
Table 2. csm.properties migration
csm.properties HCL Compass Web Server Options
NUMBER_OF_REQUEST_MANAGERS Maximum Active Servers
The properties from logging.xml can be set in the Application Options tab of the Site Configuration window.
Table 3.
logging.xml Application Options
Enable Flagging Enable Diagnostics