Configure which processing instructions to remove

You can configure the CCMS to remove unneeded processing instructions from topics when they move to a specified status.

About this task

Processing instructions (PI) can be added to topics in a number of ways. One common way is by adding Oxygen comments to a topic. An Oxygen comment added to a paragraph appears similar to this example:

<p>This new feature is not yet documented.<?oxy_comment_start author="whitel" timestamp="20140730T123424-0500" comment="Please check the specification for more information on this feature."?><?oxy_comment_end?></p>

As Oxygen comment PIs usually represent SME comments made during a review cycle, you might want to delete them after they have been resolved, so that there is no confusion between "old" comments and "new" comments.

The configurable triggers com.ixiasoft.cms.triggers.RemoveProcIns (CCMS Desktop) and com.ixiasoft.application.command.triggers.RemoveProcInsTrigger (CCMS Web) automatically delete all specified PIs when a topic moves to Authoring:done (or your equivalent).

You use the RemoveProcInsTriggers.xml file to specify which PIs to delete.

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

Procedure

  1. In the TEXTML Administration perspective, connect to your server.
  2. Check out and open the /system/conf/RemoveProcInsTriggers.xml file.
  3. Add a new <procins> element that includes the name of the PI you want the trigger to delete. 
    <procins>oxy-placeholder</procins>
    Tip: The opening and closing tags for PIs always include question marks, which makes them easy to identify as such. The text immediately after the question mark is the name of the PI.
  4. Delete any <procins> elements that correspond to PIs you do not want the trigger to delete.
  5. Save, close, and check in the file.
  6. 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.