Configure the Document Types panel

You can configure the contents of the Document Types panel in the Search View.

In the default configuration, the Document Types panel lists objects identified in the equivalence.xml file, which determines how DITA and custom objects are handled by the IXIA CCMS interface. Objects that are designated as equivalent to topics, for example, display the same right-click menu options and use searches in a similar manner.

The following code shows the default configuration in the equivalence.xml file for the Maps document type:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE equivalences PUBLIC "-//ixiasoft.com//cms//config//equivalence" "equivalence.dtd">

<equivalences>
   <equivalence type="map" standardSearch="true" groupName="Maps">
      <object type="map"/>
      <object type="bookmap" icon="/system/conf/icons/bookmap-icon.png"/>
      <object type="subjectScheme"/>
   </equivalence>
	
...
</equivalences>

The following table describes the elements and attributes used to configure the Document Type panel:

Table 1. Equivalence.xml file elements and attributes to configure the Document Type panel

Element	Description
<equivalence>	Defines a top-level document type in the Document Type panel (for example, Maps, Topics, etc.) It has the following attributes:
	Attribute	Description
	type	Type of the object. This must be a valid type (for example, map, topic, resource, etc.). Mandatory.
	standardSearch	Indicates if this type is displayed in the Document Type panel. Valid values are true (type is displayed) and false (type is not displayed). This attribute is optional; if not specified, it defaults to true.
	groupName	Label displayed in the Document Type panel. This attribute is optional; if not specified, it defaults to the value of the type attribute. All the <equivalence> objects with the same group name will be organized in the same dropdown list. For example, consider the following configuration: <equivalence type="project" standardSearch="true" groupName="Others"> <object type="project"/> </equivalence> <equivalence type="snapshot" standardSearch="true" groupName="Others"> <object type="snapshot"/> </equivalence> Both project and snapshot will appear in the Others dropdown list.
<object>	Defines the items in the document type's dropdown list. Note: The order of objects listed in the equivalence.xml file dictates the order in which the user sees them in the user interface (UI). If you change the order in the file, that change is reflected in the UI after a refresh. It has the following attributes:
	Attribute	Description
	type	Type of the object. This must be a valid type (for example, map, topic, resource, etc.). Mandatory.
	icon	Specifies a link to the icon that should be used for this object in the view. The image must be stored in the Content Store. For example: <object type="bookmap" icon="/system/conf/icons/bookmap-icon.png"/>

Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment.

To configure the Document Types panel:

1. In the TEXTML Administration perspective, connect to your server.
2. Locate the equivalence.xml file in the repository's /system/conf collection.
3. Check out the file and open it for editing.
4. Make the necessary changes in the file.
5. Save, close, and check in the file.
6. Inform users of the changes.
   The changes are automatically applied 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.