Customize an existing IXIASOFT CCMS transformation scenario

If you need to change the behavior of a target that is located in a IXIASOFT CCMS conductor file, do not modify the target directly.

Instead, copy the target from the CCMS conductor file to your client conductor file, rename it, modify it in your client conductor file, and set your client preprocessor to point to your conductor file. This ensures that any updates to the IXIASOFT CCMS Output Generator software will not overwrite your customization.

The following procedure describes how to customize the Dita2PDF transformation scenario so that:
  • <draft-comment> elements are included in the output
  • Only reltable links are included in the output
  1. Open your client conductor file (for example, %OutputGenDir%/data/conductor-acme.xml).
  2. Open the conductor file that contains the target you want to modify (for example, for the Dita2PDF transformation scenario, open %OutputGenDir%/data/conductor-ot.xml).
  3. Copy the contents of the target to modify from the CCMS conductor file (for example, %OutputGenDir%/data/conductor-ot.xml) to your client conductor file (for example, %OutputGenDir%/data/conductor-acme.xml).
    For example, for the Dita2PDF transformation scenario, copy the dita2pdfwrapper target.
  4. Edit the target name to indicate that the target was customized for your company.
    IXIASOFT recommends that you add your company name before the target name. For example:
    <target name="acme.dita2pdfwrapper" depends="default_dependencies, flatten, resolve_container_keyref, extract_HiRes_images">
    
       ...
    Note: Be sure to change the values of echostart and echoend to reflect the new target name.
  5. Modify the target in your client conductor file.
    For example, to include <draft-comment> elements and reltable links only in the output, configure the args.rellinks and args.draft parameters as follows:
    <target name="acme.dita2pdfwrapper" depends="default_dependencies, flatten, resolve_container_keyref, extract_HiRes_images">
    	<echostart>acme.dita2pdfwrapper</echostart>
    
    	<ot_build_add_pdfrenderer/>
    	<ot_build_add_ditaval_ifpresent/>
    	<ot_build_clean_ot_temp/>
    	<ot_build_keep_topicfo/>
    
    	<ot_build_set_parameter name="transtype" value="pdf2"/>
    	<ot_build_set_parameter name="args.rellinks" value="nofamily"/>
    	<ot_build_set_parameter name="args.draft" value="yes"/>
    
    	<dita_startcmd_ot_build/>
    
    	<clean_ot_output/>
    
    	<!-- Set the property job.keep.temp to preserve the completed temp folder of the task -->
    	<!--<property name="job.keep.temp" value="yes"/>-->
    
    	<echoend>acme.dita2pdfwrapper</echoend>
    </target>
  6. Save and close your client conductor file.
  7. Open your client preprocessor file (for example, %OutputGenDir%/conf/client/preprocessors.xml).
  8. Open the %OutputGenDir%/conf/preprocessor.xml file.
  9. Copy the contents of the preprocessor to modify from the CCMS preprocessor file (i.e., %OutputGenDir%/conf/preprocessor.xml) to your client preprocessor file (i.e., %OutputGenDir%/conf/client/preprocessors.xml).
    For example, for the Dita2PDF transformation scenario, copy the dita2pdf preprocessor.
  10. Set the buildfile and target parameters to point to the new target.
    For example:
    <preprocessor name="dita2pdf" class="com.ixiasoft.outputgenerator.preprocessor.AntProcessor" >
       <parameters>
          <system>
             <parameter name="buildfile" value="/conductor-acme.xml"/>
             <parameter name="target" value="acme.dita2pdfwrapper"/>
             <parameter name="clean" value="job_postprocess"/>
             <parameter name="keep.log.files" value="true"/>
          </system>
       </parameters>
    </preprocessor>

    You need to make any changes to either %OutputGenDir%/conf/outputtypes.xml or %OutputGenDir%/conf/client/outputtypes.xml. By copying the dita2pdf preprocessor in steps 7-10, you have redirected the default Dita2Pdf output type to your own dita2pdf preprocessor and therefore to your new acme.dita2pdfwrapper target.

  11. To test the transformation scenario, restart the CCMS Output Generator service.