Create a map template

You can create topic templates using the CCMS or an external XML editor and then add them to the CCMS system configuration to make them available to users of both CCMS Weband CCMS Desktop.

About this task

In IXIA CCMS Web and IXIA CCMS Desktop, the templates are available when a user creates a new map. This allows users to create new maps with that template's structure.

You can also incorporate variables into the map template which can be replaced by actual values when a map is created. The variables act as placeholders for content entered or selected by users as they create a map.

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

Procedure

  1. Create a map with the required topicmeta or bookmeta metadata elements (and values where appropriate), plus any other structure that will be common to all maps based on this template.

    You don't have to create the map within the CCMS, but doing so ensures that it already has the correct DOCTYPE. These steps assuming you are using the CCMS.

    Tip: If using an existing map as your starting point, clone the map and rename it, then make the necessary changes.
    CAUTION: Avoid references to objects that can vary from document to document, because if these or their dependent objects are deleted or otherwise unavailable, maps created with the template will have errors.
  2. Export the map from IXIA CCMS using Generate Output and selecting the Export output type.
  3. After saving or downloading the map, rename the file so the template can be easily recognized by users.

    You might see other files in the export such as a customproperties file or an indexedcontent file. Disregard these files. You only need the map itself.

  4. Open the template map in a text editor.
  5. If necessary, remove all ixia_locid attributes and their values.

    If you are using an editor that can match regular expressions, you can use the following expression to find all instances: \b(ixia_locid)( |=)=? ?"\d+\b". This matches all occurrences of the ixia_locid attribute, along with values that have any number of digits.

  6. If you are using DRM, and you created the template in the CCMS, edit the existing <containerref> element to remove the @href attribute.
    For example, edit
    <containerref href="lrg1737488589254.ditamap"/>

    to be simply

    <containerref/>

    If you created the template in an external XML editor, there is likely no <containerref>element present. Add it in the correct position. For a map, this position is immediately after <topicmeta>. For a bookmap, this position is immediately after <frontmatter>.

  7. Add template variables.
    Important: The map template must include the ID, language, and title as variables, or any maps created from the template will be invalid. See Required template variables for details.

    For more information on using additional template variables, see Add custom variables to a map template.

  8. Save the template.