Chapter 3 of the VDPMill User Guide
VDPMill Configuration
2.1. VDPMill Configuration Files
VDPMill includes the following configuration files:
-
vdpmill.conf- Common configuration parameters. It includes common options and links to component configuration files. -
splitter.conf- Input XML file splitting rules. It contains information about splitting start point and split point settings. -
controlpanel.conf- VDPMill Control Panel configuration file.
2.2. vdpmill.conf Description
Table 2.1. vdpmill.conf file options
Name
Possible Values
Default Value
Description
log-level
error, warning, info, log, none
log
Sets the log-level. log means that all messages (there are four types of messages: log, information, error, and warning) are displayed or written to the log. info means everything except log messages. warning means errors and warnings. error means errors only.
preformat-threads-count
positive integer
1
The number of pre-formatting threads.
format-threads-count
positive integer
10
The number of formatting threads.
postformat-threads-count
positive integer
2
The number of threads which generate separated output files in final formats (PDF, PS, AFP, XEPOUT).
join-threads-count
positive integer
1
The number of threads which generated joined output files in final formats (PDF, PS, AFP, XEPOUT, etc).
data-buffer-size
positive integer
1048576
The buffer size for I/O operations on files and sockets.
tmpdir
existing folder name
no default value
A folder to store temporary files.[1]
toaster-attempts
positive integer
5
The number of attempts to reconnect to EnMasse.
[1] Relative URLs are resolved relative to the vdpmill.conf file location. For example, if the configuration file C:/VDPMill/conf/vdpmill.conf contains a ../../splitter.conf URL, the path to splitter.conf will be resolved relative to the vdpmill.conf URL. vdpmill.conf’s URL is file:/C:/VDPMill/conf/vdpmill.conf. After the resolving, the absolute URL of splitter.conf will be file:/C:/splitter.conf.
Table 2.2. vdpmill.conf elements
Element Name
Description
local-enmasse
Local EnMasse configuration.[1] The configuration attribute is the URL of the toaster.conf file. The directory is the URL of EnMasse installation directory[1].
remote-enmasse
Remote EnMasse configuration. The host attribute is the hostname EnMasse runs on. The port attribute is a TCP port EnMasse runs on. format is the EnMasse output format (the possible value is xep).
xep
IREn configuration. The configuration attribute is the URL of the xep.xml file. [1]
xml-generators
XML generators to be used in VDPMill Ticket and VDPMill Interactive applications. For more details, see the Chapter 6, How To Use XML Generators**. The nested xml-generator elements have the following attributes:
-
name(required): the name of the XML generator. The names should be unique; -
command(required): the URL of the executable file for the XML generator [1]; -
input-file-extensions(optional): slash-separated (/) list of input file extensions for the XML generator.
formatter
VDPMill formatter options. The type attribute is the formatter type, the possible values are xep[2] and enmasse.
generator
VDPMill generator options. The type attribute is the generator type. The possible value is xep.[3].
splitter
Splitter configuration. The rules attribute is an URL of the splitter.conf rules file.[1]
[1] For EnMasse configuration see EnMasse User Guide.
[2] xep options can be found in IREn Configuration.
[3] Options must be written as format:com.renderx.xep:OPTION_NAME_FROM_XEP, e.g. pdf:com.renderx.xep.DROP_UNUSED_DESTINATIONS. For IREn options, see IREn Output Formats.
2.3. splitter.conf Description
splitter.conf defines splitter type and input XML document splitting rules, split start type and split point type.
The splitter types can be the following:
-
splitter1g- Single pass splitter. For detailed description, see Section 3.2.2, “Splitting Basics”. -
splitter2g- Double pass splitter. For detailed description, see Section 3.2.4, “Splitter 2g - Double Pass Splitter”.
The split start types can be the following:
-
pi- Split start is set as PI. -
element- Split start is set as XML element definition.
The split point types can be the following:
-
pi- Split point is set as PI. -
element-count- Split point is set as element count.
The splitting rules are explained in the table below
Table 2.3. splitter.conf
| Element Name | Description | Example |
|---|---|---|
splitter | Defines the splitter type by the type attribute, the split start point type by the split-start-type attribute and the split point type by the split-point-type attribute. | <splitter xmlns="http://www.renderx.com/DF/splitter/config" type="splitter1g" split-start-type="pi" split-point-type="element-count"> |
start-point-pi | Start point PI should be specified by two attributes: target and data. | <start-point-pi target="xepx-df-split" data="start"/> |
start-point-element | Start point element should be specified by two attributes: name and namespace. | <start-point-element name="page" namespace="http://www.renderx.com/XEP/xep"/\> |
split-point-pi | Split point PI should be specified by two attributes: target and data. | <split-point-pi target="xepx-df-split" data="here"/> |
split-point-element-count | Split point element count should be specified by the element-count attribute. | <split-point-element-count element-count="10"/> |
2.4. controlpanel.conf Description
controlpanel.conf stores VDPMill Control Panel Configuration.
Table 2.4. Parameters
vdpmill | The configuration attribute is the URL of VDPMill configuration file used in VDPMill Control Panel [1]. |
jobmanager | The session-dir attribute is the URL to the session directory for VDPMill Control Panel[1]. This directory contains VDPMill job processing session information, intermediate files generated during processing. By default it contains serverlogs subdirectory for VDPMill XML-RPC Server log files. The jobmanager element may contain nested option element to define the limit of the list for finished jobs in VDPMill Job Manager. |
xml-rpc | The executable attribute is the URL[1] of vdpmill-xmlrpc-server-bot(.bat)[1] file. The log-dir attribute is the URL of the directory where VDPMill Control Panel stores XML-RPC Server log files. When VDPMill Control Panel runs the server it creates serverlog_YYYY_MM_DD.log log file in the log-dir directory. All the log messages go to that file until the server is restarted. If the log file exists it is appended.
The
|