List of DITA CMS Ant properties

The Output Generator Ant properties follow a consistent naming convention:
  • outgen.*: Global property
  • outgen.job.*: Global property that is specific to a job
  • job.*: Local property that is specific to a target
  • *.dir: Property that contains the absolute path of a folder
  • *.filename: Property that contains the absolute path and name of a file
  • *.name: Property that contains the file name only (without the path)
  • *.foldername: Property that contains the folder name only (without the parent path)
The following table lists the Ant properties in alphabetical order.
Table 1. DITA CMS system Ant properties
Property Description
env
Special property to access the environment variables of the OS. For more information, see the Ant documentation:

Set by:

Conductor file

env.AXF_DIR Location of the Antenna House Formatter engine.
Example:
C:\Program Files\Antenna House\AHFormatterV62
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or in your transformation target. See Use an Antenna House rendering engine for more information

env.AXF_OPT Location of the Antenna House Formatter settings file.
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\resources\client\AHFSettings.xml

Where [version] is replaced by the current release version number.

Set by:

default_dependency target, but can be overwritten in your outgen-init-client.xml or in your transformation target. See Use an Antenna House rendering engine for more information.

hostname Machine name (or fully qualified domain name) of the machine that hosts the Output Generator.
Example:
Continuix
Set by

gethostname target.

ot.catalog

RefID created by the conductor file to replace the <import file="${ot.dir}/catalog-dita.xml"/> statement. You can use this ID in any Ant task that needs the DTDs.

Example when defining the property:

<xmlcatalog id="ot.catalog">
   <catalogpath path="${outgen.ot.dir}/catalog-dita.xml"/>
</xmlcatalog> 

Example when using the property:

<xmltask source="${outgen.job.source.filename}">
   <xmlcatalog refid="ot.catalog"/>
   ...
</xmltask>

Set by:

Conductor file (outgen-init.xml). Should not be modified.

outgen.data.dir

The data folder of the Output Generator server.

Value:
%OutputGenDir%/data
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data 

Where [version] is replaced by the current release version number.

Set by:

Conductor file (outgen-init.xml). Should not be modified.

outgen.job.ant.home Location of the Ant home.

Value:

Default value is:
${outgen.ot.dir}${file.separator}tools${file.separator}ant
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\DITA-OT1.8.5\tools\ant

Where [version] is replaced by the current release version number.

Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.ant. java.home Location of the Java JRE.

Value:

Value of the JAVA_HOME environment variable.

Example:
C:\Program Files\Java\jre7
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.ant. java.memory Maximum memory assigned to the JVM created by the job.

Value:

Default value is 512m.
Example:
512m
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.ant.opts Additional JVM parameters set in the ant -f build.xml command.

Value:

Default value is:
-Xmx${outgen.job.ant.java.memory} 
-Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl
Example:
-Xmx512m -Djavax.xml.transform.TransformerFactory\=net.sf.saxon.TransformerFactoryImpl
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.ant.path Absolute path to the ant.bat file and its dependencies.

Value:

Default value is:
${outgen.ot.dir}${file.separator}tools${file.separator}ant${file.separator}bin ${path.separator}${env.Path}
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\DITA-OT1.8.5\tools\ant\bin; C:\Perl\site\bin;C:\Perl\bin;C:\Perl64\site\bin; ...etc. 

Where [version] is replaced by the current release version number.

Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.build. filename Absolute path and file name of the build.xml file for the DITA-OT transformation

Value:

Default value is:
${outgen.job.dir}/build.xml 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759\build.xml

Where [version] is replaced by the current release version number.

Set by

Transformation target, so that it can be different per transform

outgen.job.build. log.filename

(called build.log in 3.4)

Absolute path and name of the .build.html file that is returned in the %OutputGenDir%/temp directory after the execution of the transformation scenario. This file contains logs on the execution of the build scripts in HTML format.
Value:
%OutputGenDir%/temp/${outgen.job.foldername}/ ${outgen.job.source.name.noext}.build.html
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\Dita2Pdf.mtest.112.1418315370904\ mte1417101526619.build.html

Where [version] is replaced by the current release version number.

Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.build. otlog.filename Absolute path and name of the DITA OT .ot.log log file that is returned in the %OutputGenDir%/temp directory after the execution of the transformation scenario. This file contains the Open Toolkit logs.
Value:
${outgen.job.ot.log.dir}/${outgen.job.source.name.noext}.ot.log
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\Dita2Pdf.mtest.112.1418315370904\ out\mte1417101526619.ot.log

Where [version] is replaced by the current release version number.

Set by:

Transformation target, so that it can be different per transform

outgen.job.build. template.filename Absolute path and file name of the template used to create the build.xml file

Value:

Default value is:
${outgen.resources.dir}/job-build-template.xml
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\resources\job-build-template.xml

Where [version] is replaced by the current release version number.

Set by

Transformation target, so that it can be different per transform

outgen.job.clean. ot.temp Specifies whether to delete the files in the temporary DITA OT directory when the build is completed. Values are yes (delete) and no (keep).

Value:

Default value is "yes".

Example:
yes
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.clean. outputdir Specifies whether to delete the files in the temporary DITA OT output directory (as defined by the DITA OT outputdir Ant property) when the build is completed. Values are yes (delete) and no (keep).

Note that you also need to call the clean_ot_output target.

Value:

Default value is "yes".

Example:
yes
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.custom. xep.config Location of the RenderX XEP settings file.
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\resources\client\xep.xml

Where [version] is replaced by the current release version number.

Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or the transformation target. See Using the RenderX XEP engine for more information.

outgen.job.custom. xep.memory

Maximum memory available for the JVM that runs the RenderX XEP engine to generate the PDF. By default, if you do not configure this parameter, 500 Mb is available for the transformation.

Example:
1024Mb
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or the transformation target. See Using the RenderX XEP engine for more information.

outgen.job.default. pdf.formatter Default PDF formatter.

Value:

Default value is fop

Example:
xep
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml. See Use another PDF rendering engine for more information.

outgen.job.dir Absolute path and name of the folder that contains the Output Generator job.
Value:
${outgen.temp.dir}/${outgen.job.foldername}
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759

Where [version] is replaced by the current release version number.

Set by

default_dependency target. Do not modify this property.

outgen.job.ditaval. filename

(called ditaval in 3.4)

Absolute path and name of the Ditaval file used for filtering.

This property is created only if a ditaval file was specified.

Value:
%OutputGenDir%/temp/${outgen.job.foldername}/ ${outgen.job.source.name.noext}.ditaval
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.112.1418315370904\lar1366654832956.ditaval

Where [version] is replaced by the current release version number.

Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.docbase. name

(called textml.docbase in 3.4)

Name of the Content Store that stores the document to generate.
Example:
d4dox
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. foldername

(called path in 3.4)

ID of the output generation job; this ID is used to uniquely identify the job in the %OutputGenDir%/temp directory.

Value:

This is constructed by using the following:
OutputType.username.threadID.timestamp
Example:
Dita2Pdf.mtest.112.1418315370904
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.hhc.dir Location of the HTML Help Workshop program.
Example:
C:\Program Files (x86)\HTML Help Workshop 
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or in your transformation target.

outgen.job.keep. temp
Determines whether to run the clean target specified in the clean parameter of the preprocessor after the transformation process is completed and the zip file is returned to the user:
  • If set to "no", the target specified in the clean parameter is executed.
  • If set to "yes", the target specified in the clean parameter is not executed.

Value:

Default value is no.

Example:
no
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job.keep. topicfo When set to "yes", returns the topic.fo file and the images in the zip file for troubleshooting. Note that you also need to call the ot_build_keep_topicfo target.

See Keep the topic.fo file for more information.

Value:

Default value is no.

Example:
no
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or outgen-init-debug.xml.

outgen.job. lastmodifier.email

(called writer.email in 3.4)

Email address of the person who last modified the document to generate.
Example:
dita-support@ixiasoft.com
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. lastmodifier.name

(called writer.name in 3.4)

User name of the person who last modified the document to generate.
Example:
mtest
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.ot. log.dir Absolute path and name of the directory where the DITA OT logs will be created. The actual location depends on the keep.log.files parameter set in the preprocessor:
  • If keep.log.files=true, the logs are copied to the directory specified with the outgen.job.output.dir property.
  • Otherwise, the logs are copied to the directory specified with the outgen.job.dir property.
Value:
${outgen.job.output.dir}
or
${outgen.job.dir}
(depending on the value of keep.log.files)
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759\out

Where [version] is replaced by the current release version number.

Set by

default_dependency target. Do not modify this property.

outgen.job.ot. temp.dir Absolute path and directory of the DITA OT temp directory.
Value:
${outgen.job.dir}/temp  
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759\temp

Where [version] is replaced by the current release version number.

Set by

default_dependency target. Do not modify this property.

outgen.job. output.dir

(called outputdir in 3.4)

Absolute path of the directory where the Output Generator stores the output of the transformation.

Your transformation scenario must put the files to return to the user in this directory. By default, this value is used for the "output.dir" parameter when calling the DITA-OT.

Value:
%OutputGenDir%/temp/${outgen.job.foldername}/out
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.112.1418315370904\out

Where [version] is replaced by the current release version number.

Set by

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. requester.email

(called publisher.email in 3.4)

Email address of the person who requested the output generation.
Example:
dita-support@ixiasoft.com
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. requester.name

(called publisher.name in 3.4)

User name of the person who requested the output generation.
Example:
mtest
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. source.collection

(called collection in 3.4)

TEXTML collection of the source document to output. This value is used to create the path structure of the input file.
Example:
/content/authoring/
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. source.dir Absolute path and name of the directory (collection) that contains the documents sent for output generation.
Value:
${outgen.job.dir}${outgen.job.source.collection} 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759\content\authoring

Where [version] is replaced by the current release version number.

Set by

default_dependency target. Do not modify this property.

outgen.job. source.filename Absolute path and name of the source file to be transformed.
Value:
${outgen.job.source.dir}/${outgen.job.source.name} 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.21.1418740847759\content\authoring\ mte1417101526619.ditamap

Where [version] is replaced by the current release version number.

Set by

default_dependency target. Do not modify this property.

outgen.job. source.objtype Type of the source object.
Example:
map

Set by

getobjecttype target.

outgen.job. source.name

(called id in 3.4)

Filename of the document sent to the Output Generator.
Example:
mte1417101526619.ditamap

Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.source. name.noext

(called id.noextension in 3.4)

Filename of the document sent to the Output Generator, without the extension.
Example:
mte1417101526619

Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job. textmlserver.name

(called textml.address in 3.4)

Name of the TEXTML Server that stores the document to generate.
Example:
dita-textml:2500
Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.userparam.*

(for example, outgen.job.userparam. watermark)

Value of any additional system parameter that you have defined in a preprocessor. See Add a new preprocessor for more information.

Set by:

Output Generator process, from the preprocessor file

outgen.job. userparam.filename

(called build.properties in 3.4)

Absolute path and name of the file that contains the user parameters; see Access user parameters in your Ant conductor file for more information.

This property is only created if there are user parameters.

Value:
%OutputGenDir%/temp/${outgen.job.foldername}/ ${outgen.job.source.name.noext}.properties
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp\ Dita2Pdf.mtest.112.1418315370904\mte1417101526619.properties

Where [version] is replaced by the current release version number.

Set by:

Output Generator process, from object selected. Cannot be overwritten.

outgen.job.xep.dir Location of the RenderX XEP engine.
Example:
C:\Program Files\RenderX\XEP
Set by

default_dependency target, but can be overwritten in your outgen-init-client.xml or your transformation target. See Using the RenderX XEP engine for more information.

outgen.os.family

Dynamic property that contains the value of the OS ("windows" or "linux").

Example:

windows 
Set by:

Conductor file (outgen-init.xml). Should not be modified.

outgen.ot.dir

(called ot.dir in 3.4)

Directory where the DITA-OT is located.

Value:
${outgen.data.dir}/DITA-OT${outgen.ot.version}
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\DITA-OT1.8.5 

Where [version] is replaced by the current release version number.

Set by:

Client conductor file (e.g., conductor-acme.xml). See Using another version of the Open Toolkit for more information.

outgen.ot.version

(called ot.version in 3.4)

Version of the DITA-OT to use for the targets in the conductor file.

Example:

1.8.5 
Set by:

Client conductor file (e.g., conductor-acme.xml). See Using another version of the Open Toolkit for more information.

outgen.ot.release. family (deprecated)
Family of the DITA-OT to use for the targets in the conductor file. Valid values are:
  • DITA-OT 1.x family: 1.x
  • DITA-OT 2.x family: 2.x

Example:

1.x
Set by:

Client conductor file (e.g., conductor-acme.xml). See Using another version of the Open Toolkit for more information.

outgen.preprocessor. buildfile

Value of the parameter name="buildfile" set in the preprocessor file, which specifies the name of the conductor file that contains the target to execute for this preprocessor.

Example:

/conductor-ot.xml
Set by:

Output Generator process, from the preprocessor file

outgen.preprocessor. clean

Value of the parameter name="clean" set in the preprocessor file, which specifies the name of the target that will be executed once the transformation is completed and the zip file is returned to the user. By default, its value is "job_postprocess".

cleans up the %OutputGenDir%/temp directory after the job is executed.

Example:

job_postprocess
Set by:

Output Generator process, from the preprocessor file

outgen.preprocessor. keep.log.files

Value of the parameter name="keep.log.files" set in the preprocessor file, which specifies whether to return the transformation logs to the output .zip.

Example:

true
Set by:

Output Generator process, from the preprocessor file

outgen.preprocessor. support.ditaval (if set by the preprocessor)

Value of the parameter name="support.ditaval" set in the preprocessor file, which specifies whether to display the Ditaval selection option in the Generate Output dialog.

Example:

true
Set by:

Output Generator process, from the preprocessor file

outgen.preprocessor. target

Value of the parameter name="target" set in the preprocessor file, which specifies the name of the target to execute.

Example:

dita2pdfwrapper
Set by:

Output Generator process, from the preprocessor file

outgen.resources.dir

The resources directory of the Output Generator server.

Value:
${outgen.data.dir}/resources 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\resources 

Where [version] is replaced by the current release version number.

Set by:

Conductor file (outgen-init.xml). Should not be modified.

outgen.resources.dir. client

The resources\client directory of the Output Generator server.

Value:
${outgen.resources.dir}/client 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\data\resources\client 

Where [version] is replaced by the current release version number.

Set by:

Conductor file (outgen-init.xml). Should not be modified.

outgen.temp.dir

(called temp in 3.4)

Absolute path and name of the temp folder of the Output Generator server.

Value:
%OutputGenDir%/temp 
Example:
C:\ixiasoft\OutputGenerators\Prod_[version]\temp 

Where [version] is replaced by the current release version number.

Set by:

Conductor file (outgen-init.xml). Should not be modified.