Add custom search options for CCMS Web

By default, users can search only for full text (that is, keywords), titles, or filenames in the Search for section of Advanced Search of IXIA CCMS Web. If they need to search using additional criteria, such as specific attributes or processing instructions, you can add these options.

Before you begin

Determine whether the index you want to use for the custom search already exists in Index Definitions. See Confirm an index definition already exists. If not, create it. See Edit an existing index definition or add a new one.

Note: You can make only indexes searchable for users. You cannot make any other elements defined in the Index Definition document searchable, such as units, reference lists, or summaries.

Procedure

In the TEXTML Administration perspective, connect to your server.
Expand the Content Store's Repository node, and locate the search.options.xml file in the /system/webplatform/configuration/ collection.

Note: If the file does not exist, you can get a template for it from the CCMS_ContentStoreConfiguration directory of the MadCap Software Downloads site: https://cms.ixiasoft.com/downloads/CCMS_7.5/.
Check out the file and open it for editing.
As a child element of <indexes>, add an <index> element and give it a @name attribute and value.
The value for the @name attribute must match the name of the corresponding index defined in Index Definitions.
```
<indexes>
    <index name="audience">
    </index> 
</indexes>
```

Within the <index> element, add a <captions> element and one <caption> element for each interface language used in CCMS Web.

<indexes>
    <index name="audience">
        <captions> 
            <caption lang="en"/> 
            <caption lang="de"/> 
            <caption lang="fr"/>
            <caption lang="ja"/> 
        </captions>
    </index> 
</indexes>

For each <caption> element, add a

@prompt

attribute, where the value is the UI string that users see and select in CCMS Web for that language.

<indexes>
    <index name="audience">
        <captions> 
            <caption lang="en" prompt="Audience"/> 
            <caption lang="de" prompt="Zielgruppen"/> 
            <caption lang="fr" prompt="Audience"/>
            <caption lang="ja" prompt="対象"/> 
        </captions>
    </index> 
</indexes>

For each <index> element, add afuzzy or precisescope attribute.

fuzzy includes search results that contain the entered search terms. For example, note matches noted and notes, but does not match notice.
precise includes only search results that exactly match the entered search terms.

<indexes>
    <index name="audience" scope="precise">
        <captions> 
            <caption lang="en" prompt="Audience"/> 
            <caption lang="de" prompt="Zielgruppen"/> 
            <caption lang="fr" prompt="Audience"/>
            <caption lang="ja" prompt="対象"/> 
        </captions>
    </index> 
</indexes>

Save, close, and check in the file.
Refresh the Web Server.
Refresh the browser cache if the new search option is not available after refreshing the Web Server.