Working with Index Definitions

Index Definitions in the CCMS manage display, search, and editing capabilities. They categorize specific types of data for use within the system, influencing both backend processes and user-facing features.

In many ways, the Index Definitions are the heart of the CCMS. They determine what information is available for display, search, and editing. Simply put, each index "gathers" a particular type of data so that data can be used within the CCMS as needed.

Every object in the CCMS must be indexed. The CCMS uses an object's title to index it. Some object types do not inherently have a title, such as an image or a ditaval file. To overcome this limitation, the CCMS "wraps" these objects in a file which includes an indexable title.

Some indexes are used only by CCMS processes, while others are more visible to users, displaying information in Eclipse views or datagrids.

While the CCMS includes a large number of indexes for various elements, attributes, and properties, you might find that you need to change them or add new ones.

The most common reasons to edit the Index Definitions are to:

create a new display column
enable users to search based on additional elements, attributes, or properties
determine which topic types are included in the search for conrefs to insert
change which elements are included in the title display for objects

CAUTION: Be careful when editing the Index Definition document. Changes can significantly affect the indexing process, and any errors in the document can lead to data corruption or other errors. Consult with IXIA CCMS Customer Support before making changes if you are unsure.