Customized index upgrades

If you have customized any of the indexes in Index Definitions, it's important to understand what will happen to them during an upgrade.

It's occasionally necessary for MadCap Software to update an index to optimize the performance of CCMS Web. You might have customized some of these same indexes for your own purposes.

There are many index types in Index Definitions and various possible customizations. For this reason, there is a risk that when you try to merge default upgrade modifications with your own index modifications, it can corrupt the index and cease work properly. In some cases, this could cause the IXIA CCMS to not function as expected or malfunction altogether.

To avoid this risk, the upgrade script overwrites the following indexes and unites with the default versions:

  • assigned_roles
  • snapshot_source
  • taxonomy-metadata-id
  • taxonomy-metadata-value
  • description
  • title
  • reusable_element_id
  • reusable_element_name
  • reusable_fulltext
  • reusable_units

The existing versions with your customizations of these indexes are preserved within XML comments below the updated versions so that they are inactive, but still easily visible to you. You can then re-merge your customizations back into the updated indexes.

Important: If you have customized any of these indexes, you must re-merge your customizations after each upgrade.

The changes are recorded in the upgrade log but are also easily visible within the Index Definitions file itself. In addition to the previous index being commented out, it is preceded by this comment:

The following index [indexName]
 has been updated by the installer, the older version of the index follows below:

Changes to the SYNC attribute

The upgrade script makes one other change. If the new version of an index has the attribute SYNC="True" and your version has either SYNC="False" or does not have the SYNC attribute at all, the script adds SYNC="True". It does not make any changes to the body of the index.

When set to "True," the SYNC attribute indicates that the CCMS should rebuild the index regularly to ensure optimal performance.