Create a new Publishing tag for CCMS Desktop

You can create customized tags that users can apply to a map and its topics during the Publish process in CCMS Desktop.

About this task

When you Publish content in CCMS Desktop, the CCMS displays the Publishing Tags dialog, where users can enter the Version of the Published content.

Publishing tag values are written into each document's Custom Properties file. For example:

<version>4.0</version>

You might want users to record additional information about the Published content, such as the ISBN or other properties. You can create additional tags for this information. You must also create a custom index for the information in Index Definitions to store the new information. You can also use that index to create a display column or an advanced search option.

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

1. In the TEXTML Administration perspective, connect to your server.
2. Locate the publishtags.xml file in the repository's /system/conf collection.
3. Check out the file and open it for editing.
4. Create a new <tag> element.
   For example:

   <tag cascade="false" historicalUniquenessIndex="isbn" label="ISBN" mandatory="true" metaname="isbn">
   </tag>

   Table 1. Tag element attributes

   Attribute	Description	Value
   @cascade	Determines whether the user-entered value is written only to the map or to the map's children elements as well.	true – User-entered value is written to all children elements, not just the map false (default) – User-entered value is written to just the map
   @label	Determines the tag label displayed in the Publishing Tags dialog box	Any sequence of characters
   @mandatory	Determines whether the user must enter a tag value.	true – Publishes after user enters a value false (default) – Publishes without user input
   @metaname	Defines the element where the user input will be written in the Custom Properties file	Must be the same as the NAME attribute of the corresponding Index Definition. If a corresponding Index Definition does not exist, you must create one.
   @historical Uniqueness Index	Not required, but if present, TEXTML Server verifies that the publishing tag value is unique within the index. This means that the user cannot reuse a value when Publishing content. historicalUniquenessIndex="isbn" If not present, the user can reuse values for the tag.	Must be the same as the name of the corresponding index definition. If a corresponding Index Definition does not exist, you must create one.

5. Create one or more <classbehavior> elements to determine how the publishing tag values will be written into the Custom Properties file of each type of object, as follows:

   For example, the following specifies that the ISBN tag value will be written into the Custom Properties files of maps only:

   <tag cascade="false" historicalUniquenessIndex="ISBN" label="ISBN" mandatory="true" metaname="ISBN">
       <classbehavior ditaclass="- map/map" name="override" value="false"/>
   </tag>

   Attribute	Description	Value
   @ditaclass	The class of document object. Note: In this file, an image is treated as a topic by the CCMS. Publication information is written into its Custom Properties file.	For maps, enter: - map/map For topics and images, enter: - topic/topic If you have added specialized map or topic types, you must configure them in ditaclasses.xml.
   @name	Determines the action taken with respect to existing information in an object's Custom Properties file. Note: Implementation depends on the value attribute.	Only override is supported
   @value	Determines whether the override action is actually carried out.	true – Overwrites existing publishing tags with the same metaname false – Adds another publishing tag with the same metaname to the object's Custom Properties file

6. Save, close, and check in the file.
7. 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.