Calls to DITA Open Toolkit

When CCMS Output Generator (OG) calls the DITA Open Toolkit (DITA-OT), it follows a prescribed process.

Note: In a dedicated SaaS deployment, your access to the Output Generator is limited. Some tasks require the use of the Output Generator Access Tool (OGAT).
Figure: Process for calls to the DITA-OT
Note: The format of a build file is specific to the operating system, such as Windows or Linux.
Note: All codeblocks are examples only. The following conventions pertain to codeblocks for clarity and ease of reading.
  • The ¶ symbol indicates a line break inserted in the code. In an actual build.bat file, all the information is on a single line.
  • The insertion of xxxx represents additional numerals for a filename or bundle.
  • The insertion of <username> occupies the place of your username.
To issue a call to the DITA-OT, the OG takes the following actions:
  1. CCMS Output Generator creates a build file, which is required to build a DITA-OT output.

    This file functions as a command line.

    Table 1. Sample output build file created by CCMS Output Generator

    Platform

    File name

    Example

    Windows

    build.bat

    		 
    @echo off
"C:\OutputGenerators\20200310_6.1.36\data\dita-ot-3.4\bin\dita" ¶
-i "C:\OutputGenerators\20200310_6.1.36\temp\AcmePDF.<username>.43.1585xxxx\content\authoring\pbn1584xxxx.ditamap" ¶
-f pdf -o "C:\OutputGenerators\20200310_6.1.36\temp\AcmePDF.<username>.43.1585xxx\out" ¶
-propertyfile "C:\OutputGenerators\20200310_6.1.36\temp\AcmePDF.<username>.43.1585xxx\build.properties" -v

    Linux

    build.sh

    		 
    #!/bin/bash
export JAVA_HOME=/opt/ixiasoft/jdk/jdk11_linux ¶
"/opt/ixiasoft/outgen/data/dita-ot-2.5.4/bin/dita" -i ¶ "/opt/ixiasoft/outgen/temp/bundle1737xxxx/content/authoring/bjg1726xxxx.ditamap" -f pdf2 -o ¶
"/opt/ixiasoft/outgen/data/catalogs/../../temp/bundle1737xxxx/out" ¶
 -propertyfile "/opt/ixiasoft/outgen/temp/bundle1737xxxx/build.properties" -v
  2. CCMS Output Generator also creates a build.properties file. 
    #Ant properties
#Thu Mar 26 10:20:20 CDT 2020
args.draft=yes
args.filter=C\:\\OutputGenerators\\20200310_6.1.36\\temp\\AcmePDF.<username>.43.1585xxxx\\pbn1584xxxx.ditaval
args.rellinks=none
clean.temp=yes
dita.dir=C\:\\OutputGenerators\\20200310_6.1.36\\data\\dita-ot-3.4
dita.temp.dir=C\:\\OutputGenerators\\20200310_6.1.36\\temp\\AcmePDF.<username>.43.1585xxxx\\temp
pdf.formatter=fop
retain.topic.fo=yes
transtype=pdf
  3. CCMS Output Generator then forks a shell environment that is equivalent to the DITA-OT dita command and runs the build file that it just created to build the output.