Make an index searchable in CCMS Web

By default, users can only search for keywords in the Full Text, Title, and Filename indexes in IXIA CCMS Web. You can configure search.options.xml to make additional indexes searchable.

Indexes are defined Content Store in the Index Definition document. You can make any index defined in the Index Definition document searchable. You can also define new indexes in the Index Definition document if users need to search using different parameters.
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.

To make an existing index searchable:

  1. In the TEXTML Administration perspective, connect to your server.
  2. 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.2/.
  3. Check out the file and open it for editing.
  4. As a child element of <indexes>, add an <index> element and give it a name attribute and value.
    The value for the name attribute should be the name of an index defined in index-definition.xml, for example:
    
    <indexes>
    	<index name="audience">
    	</index>
    </indexes>
    

    You can use any index defined in index-definition.xml.

  5. For the <index>, add a <captions> element and one <caption> element for each language users use in CCMS Web.
    For example:
    
    <index name="audience"> 
    	<captions>
    		<caption lang="en"/>
    		<caption lang="de"/>
                    <caption lang="ja"/>
    	</captions>	
    </index>
    
  6. 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.
    For example:
    
    <index name="audience"> 
    	<captions>
    		<caption lang="en" prompt="Audience"/>
    		<caption lang="de" prompt="Zielgruppen"/>
                    <caption lang="ja" prompt="対象ユーザー"/>
    	</captions>	
    </index>
    
  7. For each <index> element, add a scope attribute.
    The scope can be either fuzzy or precise:
    • precise: the search results will include only results that exactly match the search terms entered.
    • fuzzy: the search results will include results that contain the search terms entered (for example, "note" matches "noted" and "notes" but not "notice").

    For example:

    
    <index name="audience" scope="precise"> 
    	<captions>
    		<caption lang="en" prompt="Audience"/>
    		<caption lang="de" prompt="Zielgruppen"/>
                    <caption lang="ja" prompt="対象ユーザー"/>
    	</captions>	
    </index>
    
  8. Save, close, and check in the file.
  9. Refresh CCMS Web.