Configure the Referable-Content view

You can configure the Referable-Content view to display reusable elements from other topic types.

IXIA CCMS provides a topic specialization—the referable-content topic type—that you can use to store the text you plan to use in multiple topics. By default, the Referable-Content view only displays elements that have the id attribute set and are contained in a referable-content topic. If you want to reuse elements from other topic types and make them searchable in the Referable-Content view, you need to change two indexes and a unit in the Index Definition document.

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.
Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment.

To configure the Referable-Content view:

  1. In the TEXTML Administration perspective, connect to your server.
  2. Expand the Content Store node and locate the Index Definition document.
  3. Check out the file and open it for editing.
  4. Locate the reusable_element_id index.
    For example:
    <index NAME="reusable_element_id">
    	<stringindex KEEPEXTRACTEDVALUES="True">
    		<elements>
    			<element DEPTH="INFINITE" XPATH="//rcbody/*[@id]/@id"/>
    		</elements>
    	</stringindex>
    </index>
  5. Replace the XPath code in <element DEPTH="INFINITE" XPATH="//rcbody/*[@id]/@id"/> with the expression which will capture the ids that you want to index.
    For example, if you want to display all elements with the id attribute set contained in any topic type, you would replace the code with:
    <element DEPTH="INFINITE" XPATH="//*[contains(@class, ' topic/body ')]/*[@id]/@id"/>
    Note: Since IXIA CCMS is specialization-aware, using topic/body also indexes content from specializations based on the <topic> element such as <task> (task/taskbody), <concept> (concept/conbody), and <reference> (reference/refbody).
  6. Locate the reusable_element_name index.
    For example:
    <index NAME="reusable_element_name">
    	<stringindex KEEPEXTRACTEDVALUES="True">
    		<elements>
    			<element DEPTH="INFINITE" XPATH="for $e in (//rcbody/*[@id]) return local-name($e)"/>
    		</elements>
    	</stringindex>
    </index>
  7. Replace the XPath code in <element DEPTH="INFINITE" XPATH="for $e in (//rcbody/*[@id]) return local-name($e)"/> with the expression which defines the elements that you want to index.
    To continue the previous example, you would need to replace the code with the following:
    <element DEPTH="INFINITE" XPATH="for $e in (//*[contains(@class, ' topic/body ')]/*[@id]) return local-name($e)"/>
  8. Locate the reusable_units unit.
    For example:
    <unit NAME="reusable_units">
    	<unitelements>
    		<unitelement XPATH="//rcbody/*[@id]"/>
    	</unitelements>
    </unit>
  9. Replace the XPath code in <unitelement XPATH="//rcbody/*[@id]"/> with the expression which defines the elements searched as a self-contained block of content to be indexed.
    To continue the example, you would need to replace the code with the following:
    <unitelement XPATH="//*[contains(@class, ' topic/body ')]/*[@id]"/>
  10. Save, close, and check in the file.
  11. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their IXIA CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIA CCMS > Synchronize Configuration.
The Referable-Content view is configured and ready for use.