Make a comment mandatory

As a default for IXIA CCMS Desktop, users can check in an object without comments. You can require users to enter at least one comment during check in of an object.

In some production environments, it is important for users to log at lease one comment for each object update.

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

For example, the following diagram requires at least one comment before a user checks in an object:

Figure: Preset comments window


To make a comment mandatory:

  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the comments.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. To make comments mandatory when checking in, find the <requiredComments> element and change the @onRelease attribute to true.
    For example:
    <requiredComments onRelease="true" onStatusChange="false"/>
  5. Optional: To make comments mandatory when changing status, change the @onStatusChange attribute to true.
  6. Save, close, and check in the file.
  7. 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.
Users must enter at least one comment to check in an object.