Configuration options

The XML Server has a number of configuration options used to specify how it should work. All the options are set in a configuration file written using XML notation.

. This file is picked up when the XML Server is started and as such the configuration cannot be changed without stopping and starting the server. There are a number of areas of the operation of the server that can be configured:

. All the configuration options are enclosed in an XML root element <XML_SERVER_CONFIG>. As with all XML documents, you must ensure that the characters,, <, >, and & used in the values of your options in the configuration file are replaced with their respective character entities: ', ", <, >, and &.

Table 1. Configuration Options
Option	Category	Description
`<SERVER_PORT>`	Network	The TCP/IP port number that the XML Server uses to listen for secure client connections.
`<SO_TIMEOUT>`	Network	A positive integer specifying the timeout (in milliseconds) on socket operations. If zero value is specified then it is interpreted as an infinite timeout. If this option is not specified a default value of 60000 milliseconds is used.
`<DEFAULT_PRINTER>`	Default Values	The name of the default printer. The format used should be that required by the server command.
`<DEFAULT_TRAY>`	Default Values	The name of the default printer tray. The format used should be that required by the server command.
`<DEFAULT_USERNAME>`	Default Values	The name of the default user. The format used should be that required by the server command.
`<DEFAULT_EMAIL>`	Default Values	The default e-mail address. The format used should be that required by the server command.
`<SERVER_COMMAND>`	Server Command	The command string to use to process the document. If the command string is empty, no processing will be attempted.
`<USE_PIPE>`	Server Command	Indicate that the output document from the XML Server should be piped to the standard input of the server command when it is executed. One of `USE_PIPE` or `USE_TMP_FILE` is required to betrue.
`<USE_TMP_FILE>`	Server Command	Indicate that the output document from the XML Server should be written to a temporary file before the server command is executed. One of `USE_PIPE` or `USE_TMP_FILE` is required to betrue.
`<USE_STDOUT_SINK>`	Server Command	Start a thread to read and discard any data written to standard output by the server command.
`<USE_STDERR_SINK>`	Server Command	Start a thread to read and discard any data written to standard error by the server command.
`<TMP_DIRECTORY>`	Server Command	Specifies the directory into which temporary files containing the document data should be written. Required only if `USE_TMP_FILE` wastrue.
`<TMP_FILE_ROOT>`	Server Command	Specifies the root part of the file name to use to create the temporary file. A sequence number and the appropriate extension will be appended to create the full file name. Required only if `USE_TMP_FILE` wastrue.
`<FOP_CONFIG_FILE>`	Server Command	The name and location of a FOP configuration file. This can be used to add additional fonts for use when processing PDF files. Consult the Apache FOP documentation for more information.
`<RENDERX_CONFIG_FILE>`	RenderX Configuration	The name and location of a RenderX configuration file. This is required to initiate the RenderX rendering engine. RenderX can be used as an alternative to Apache FOP. Consult the RenderX documentation for more information.
`<RENDERX_LOGGING>`	RenderX Configuration	Specifies how RenderX 's internal logging should be configured. Consult the RenderX documentation for more information.
`<USE_TEMPLATE_CACHE>`	Template Cache	Indicates that the template cache should be used to avoid having to read templates each time a job is submitted.
`<TEMPLATE_CACHE_DIR>`	Template Cache	The name of the directory in which to store the cached template files. Required only if `USE_TEMPLATE_CACHE` wastrue.
`<CLEAR_TEMPLATE_CACHE>`	Template Cache	When the server is started, this option will force all files in the template cache directory to be deleted.
`<TRACE_TRAFFIC>`	Debug	A debug option to echo all data received by the server to the servers standard output.
`<STATISTICS_FOLDER>`	Debug	This option will output statistics for the XML Server in the folder specified by the option.
`<THREAD_POOL_SIZE>`	Sizing	The amount of threads in the pool.
`<THREAD_POOL_QUEUE_SIZE>`	Sizing	This can be tuned if needed so that requests are held inside the XMLServer rather than out in the TCP backlog queue. The process memory space required for an accepted TCP/IP secure connection should be taken into consideration when setting this configuration parameter.
`<JOBS>`	Custom	The parent element of `<JOB>` children elements which specify a job type for the XML Server.
`<JOB>`	Custom	Specifies a job type for the XML Server. Multiple `<JOB>` elements can be defined, each detailing a new job type and the implementing class.