Decide on the feature level for schema repositories and databases

Determine whether to use feature level 5, 6, 7, 8, 9 or 10 for HCL Compass user databases and schema repositories. The feature level determines the Compass features available after deployment. Changes to the feature level might require upgrading the Compass databases and schema repositories. You must also ensure that all Compass clients are running a Compass version that supports the selected feature level.

The feature level and metaschema version define the structure of the data that is stored in HCL Compass schema repositories and user databases. For information about features available at the different feature levels, see Features in the feature levels.

Changing the feature level when you upgrade HCL Compass

Feature levels are associated with specific metaschema versions. The following table lists the supported feature levels and metaschema versions for every release of HCL Compass.
Table 1. Supported feature levels and metaschema versions
Version Metaschema version Feature level
HCL 1.0/1.0.1 22 5
HCL 1.0/1.0.1 22 5 and 6
HCL 1.0/1.0.1 22 5, 6, and 7
HCL 1.0/1.0.1 22 5, 6, and 7
HCL 1.0/1.0.1 23 5, 6, 7, and 8
HCL 1.0/1.0.1 24 5, 6, 7, 8, 9, and 10
New feature levels and metaschema versions typically add new columns to tables and new tables to databases to support new features. As a result, changes to the feature level require upgrading the HCL Compass databases and schema repositories. You must also ensure that the Compass client version supports the selected feature level.

When you raise the feature level, you can simplify the upgrade process for user databases by using the HCL Compass Maintenance Tool to complete an in-place upgrade. An in-place upgrade supports upgrading a user database to a higher feature level without having to create a database and copy data to it.

The process for upgrading feature levels depends on the upgrade strategy you choose:
Upgrading everything at one time

For information about when to upgrade your feature levels when you upgrade the entire environment at one time, see Upgrade the environment at one time.

Upgrading in phases
If you are upgrading your environment in phases, review the following information to determine when to raise the feature level during the upgrade process.
  • Before you upgrade the feature level for a user database and schema repository, upgrade all Compass clients to a product version supported by that feature level. This upgrade process ensures that the client can access the user database after you change the feature level.
  • Before you upgrade, all servers and databases must be at a version that is supported by the feature level's corresponding release. See Hardware, software, and database requirements.
  • Because user databases and schema repositories can be at different feature levels, you can upgrade your user databases and HCL Compass clients to higher feature levels in phases. For example, you can upgrade an existing schema repository to feature level 6 and leave the associated user databases on feature level 5. Or, you can upgrade an existing schema repository to feature level 7 and leave the associated user databases on feature level 5 or 6. However, all Compass clients must be upgraded to a software version that supports the feature level of the user database.
  • In HCL Compass MultiSite deployments, you can upgrade MultiSite synchronization servers and shipping servers in phases only if you can accept unidirectional replication. Unidirectional replication means that packets sent from a user database with a lower feature level are accepted by user databases with a higher feature level. However, packets from a user database with a higher feature level are not accepted by a user database with a lower feature level.
    • Because user databases are not required to have the same feature level as their associated schema repositories, you can raise the feature level of schema repositories first. Then, raise the feature level of the associated user databases later.
    • Schema repositories must be at compatible feature levels to support unidirectional replication. For example, if a feature level 5 user database has a feature level 7 schema repository, the packets that are sent from client are not accepted by a feature level 6 user database that has a feature level 6 schema repository.
      Packet versions associated with schema repository and user database feature levels shows the packet versions that a site can create and accept based on the schema repository and user database feature level.
      Table 2. Packet versions associated with schema repository and user database feature levels
      Schema Repository feature level User database feature level Created Packet Version Accepted Packet Version
      9 9 13 6, 7, 8, 9, 10, 11, 12, 13
      8 8 12 6, 7, 8, 9, 10, 11, 12
      7 7 11 6, 7, 8, 9, 10, 11
      7 6 10 6, 7, 8, 9, 10
      7 5 9 6, 7, 8, 9
      6 6 8 6, 7, 8
      6 5 7 6, 7
      5 5 6 6