Understanding the Index Definition file

indexes

The indexes section contains all the individual indexes that the CCMS uses. Most indexes apply across the board, but a few apply only to Standard or DRM deployments.

Content indexes

Some indexes gather DITA attributes or other aspects of the content itself. Here is an example of an index for an attribute:

<index NAME="audience">
            <!-- Index referenced by the Advanced Search on attributes -->
            <stringindex KEEPEXTRACTEDVALUES="True">
                <elements>
                    <element DEPTH="INFINITE" XPATH="//@audience"/>
                </elements>
            </stringindex>
        </index>

Here is an example of an index that records the image type for each image:

<index NAME="imagetype">
            <stringindex KEEPEXTRACTEDVALUES="True">
                <elements>
                    <element DEPTH="INFINITE" XPATH="//imagetype"/>
                </elements>
            </stringindex>
        </index>

Customproperty indexes

Other indexes gather CCMS properties. This information is not part of the content itself but is recorded in each object's properties file or customproperties file.

Here is an example of a customproperty index that records who is assigned to an object:

<index CUSTOMPROPERTY="True" NAME="assigned_to" SYNC="True">
            <!-- System index required by the DITA CMS -->
            <stringindex KEEPEXTRACTEDVALUES="True">
                <elements>
                    <element DEPTH="INFINITE" XPATH="//assignedTo"/>
                </elements>
            </stringindex>
        </index>

Here is another customproperty index that records the original filename of objects that are imported from outside the CCMS:

<index CUSTOMPROPERTY="True" NAME="originalFilename">
            <stringindex KEEPEXTRACTEDVALUES="True">
                <elements>
                    <element DEPTH="0" XPATH="//userproperty[@type='originalFilename']"/>
                </elements>
            </stringindex>
        </index>

You can easily spot a customproperty index because it has the @CUSTOMPROPERTY="True" attribute.

Knowing whether an index is a content index or a customproperty index is important when you use the index for things like defining display columns or additional search options.

units

Units group together multiple DITA elements. You can search a unit as it if were a single element.

Here is the unit definition for the <p> element:

<unit NAME="p">
            <unitelements>
                <unitelement XPATH="//*[contains(@class,' topic/p ')]"/>
            </unitelements>
        </unit>

A <p> element can have any number of elements as children. By defining a unit for p, you enable the CCMS to more efficiently search for <p> elements and whatever children are present in one step.

Generally speaking, if you want to enable search on a DITA element that is not already enabled in the CCMS, you should add it to the units section.

summaries

The summaries section specifies which indexes should be cached to enable rapid display. For example, when you search for topics, you don't want the CCMS to have to recalculate the titles of each object before displaying the results. This would significantly slow things down. Instead, the CCMS caches the object titles so that it can quickly display them in search results.

To enable caching of the object titles, the title index is included in the summaries section:

<field NAME="title" TYPE="Index" VALUE="All"/>

Likewise, any index for which you want to create a display column must be included in the summaries section as well.

There are separate summaries sections for for CCMS Desktop (fullsummary) andCCMS Web (ixiasoftccmssummary).