Change how peer references are handled

You can specify how DITA references (links) with the scope attribute set to "peer" are handled.

References with the scope attribute set to "peer" are used when the resource is part of your source, but may not available when the output is generated. You can choose whether these references are handled as internal or external source types. The externaltypes.xml file, located within the Repository in the /system/conf/ collection, contains an attribute called peerasexternal, which determines how peer references are handled:

  • When the peerasexternal attribute is set to "true", then peer references are handled as external source types regardless of their type.
  • If the peerasexternal attribute is set to "false" and the link's type is declared in the list of external source types, then the reference is handled as an external source type.
  • If the peerasexternal attribute is set to "false" and the link's type is not declared in the list of external source types, then the reference is handled as an internal source type.
Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment. For dedicated SaaS deployments, test the changes and then ask IXIA CCMS Customer Support to copy the changes to your production environment.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the externaltypes.xml file in the repository's /system/conf/ collection.
  3. Check out the file and open it for editing.
  4. Change the peerasexternal attribute as desired:
    • True: references with the scope attribute set to "peer" are handled as external source types.
    • False: references with the scope attribute set to "peer" are evaluated to determine if they are internal or external source types.
  5. Save, close, and check in the file.
  6. 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.