Configure a preset list of keys

Defining a preset list of keys is useful when you want to enforce consistency for the keywords or external links used in a documentation set.

Rather than each user creating their own keys, you can define a list of the commonly-used or company-approved keys that users can access in the DITA Map view and insert into their maps. Once inserted into a map, the keys can be used within topics attached to the map. This method is useful for keeping a single set of approved keys for use across your publications.

The list is defined in the keydefnames.xml configuration file in system/conf. The file contains two types of keys:
  • Keywords, which are listed in the following section:
    <type label="Keyword" name="keyword">
  • External links, which are listed in the following section:
    <type label="External links" name="xref">

Each key is defined as a <keydefname> element in the appropriate section. Each <keydefname> element contains attributes defining the name of the key and its default value. For example:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE keydefnames PUBLIC "-//ixiasoft.com//cms//config//keydefnames" "keydefnames.dtd">
<keydefnames>
	<type label="Keyword" name="keyword">
		<keydefname name="company" default-value="IXIASOFT"/>						
	</type>
	<type label="External links" name="xref">
	<keydefname name="companyweb" default-value="www.ixiasoft.com"/>						
	</type>
</keydefnames>
Note: You should make these configuration changes in the Test environment and test them before copying them to the Production environment. In a dedicated SaaS deployment, after testing the changes, ask IXIASOFT Customer Support to copy the changes to the Production environment.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the keydefnames.xml file in the repository's /system/conf/ collection.
  3. Check out the file and open it for editing.
  4. For each new keyword or external link that you want to specify, insert a new line in the appropriate section using the format <keydefname name="[key name]" default-value="[key value]"/>.
    For example, if you wanted to create a key for the company's name, you would add the following in the section labeled keyword:
    <keydefname name="company" default-value="IXIASOFT"/>
  5. Save, close, and check in the file.
  6. Inform users of the changes and request that they close and reopen their CCMS Desktop to apply the changes.