Configuration guide

Core module

JCopist's core module is configured through the jcopist.xml file provided with the distribution. This file is described in the rest of this section (the elements are referenced using the XPath notation).

To fully understand the parameters in this file, you should read the architecture overview first.

/server/workDir
the base directory to store server data. Note that variable interpolation is supported, i.e this value is referenced for other paths using the $workDir notation.
/server/hsqldb[@enabled]
the boolean property to tell if another database is used instead of hsqldb embedded database (see database section below). Don't use for generate thousand documents per hour. if true, the database section below is ignored. default : true
/server/hsqldb/host
the host where hsqldb database is localized, default : 127.0.0.1
/server/hsqldb/port
the hsqldb database connection port, default : 9010
/server/hsqldb/dbname
the used hsqldb database name, default : jdbc_1
/server/hsqldb/username
the connection hsqldb database username, default : sa
/server/hsqldb/password
the connection hsqldb database password, default : empty
/server/hsqldb/silent
the boolean property to tell if the hsqldb database logs should be appears
/server/database/host
the host where database is localized, default : 127.0.0.1
/server/database/port
the database connection port, default : 9010
/server/database/dbname
the used database name, default : jdbc_1
/server/database/username
the connection database username, default : sa
/server/database/password
the connection database password, default : empty
/server/templateManager[@type]
the template manager to use. The currently supported values are:
  • filesystem : this type requires three nested property tags:
    • baseDir : the directory where the filesystem template manager will store templates.
    • deployDir : the directory where the filesystem template manager will look for new templates at server startup.
    • templateFiles : the model files that should be consider as template files []
/server/builderManager/workDir
the temporary directory for builders.
/server/builderManager/buildersPool[@maxActive]
the maximum number of active builder instances in the pool, per template .
/server/builderManager/buildersPool[@maxIdle]
the maximum number of idle builder instances in the pool, per template .
/server/builderManager/buildersPool[@maxWait]
the maximum wait time (milliseconds) for the builders pool's clients. After this delay, an internal error will be thrown.
/server/converterManager/workDir
the temporary directory for converters.
/server/converterManager/filters/filter
the list of OpenOffice.org filters used by the converters. Each tag has 3 attributes :
  • src : the source format.
  • dest : the destination format.
  • filterName : the name of the filter.

If a client requests source and destination formats that do not correspond to a <filter> tag, an internal error will be thrown.

/server/ooInstanceManager/startCmd
the system command to launch the soffice.bin process. For windows paths that contain spaces, enclose in double quotes.
/server/ooInstanceManager/workDir
the directory used to create temporary user profiles for OpenOffice.org processes. This directory must contain a reference directory, created according to the procedure described in the installation guide .
/server/ooInstanceManager/startDelay
the minimum delay (milliseconds) that will be allowed between the lauch of two OpenOffice.org instances. This parameter was added in order to avoid overloading the server if the worlkload suddendly increases and multiple instances must be started. If you're not interested in this feature, set the parameter to zero.
/server/ooInstanceManager/xDisplay
the X display used by OpenOffice.org (Linux only). If you don't want to run an X server on the machine hosting JCopist, we suggest using XVfb (virtual frame buffer).
/server/realtimeService[@enabled]
specifies if realtime processing should be enabled.
/server/realtimeService/convertersPool[@maxActive]
the maximum number of active converters in the realtime pool.
/server/realtimeService/convertersPool[@minIdle]
the minimum number of idle converter in the realtime pool. This allows to have ready instances even if the service is not currently working.
/server/realtimeService/convertersPool[@maxIdleTime]
the maximum time (milliseconds) before an idle converter is destroyed, except if the number of idle converters equals minIdle .
/server/realtimeService/convertersPool[@checkInterval]
the interval to check for idle converters.
/server/realtimeService/convertersPool[@maxChecks]
the maximum number of converters to check for idleness.
/server/realtimeService/convertersPool[@maxWait]
the maximum wait time (milliseconds) for the converters pool's clients. After this delay, an internal error will be thrown.
/server/batchService[@enabled]
specifies if batch processing should be enabled.
/server/batchService/convertersPool[@maxActive]
the maximum number of active converters in the batch pool.
/server/batchService/convertersPool[@minIdle]
the minimum number of idle converter in the batch pool. This allows to have ready instances even if the service is not currently working.
/server/batchService/convertersPool[@maxIdleTime]
the maximum time (milliseconds) before an idle converter is destroyed, except if the number of idle converters equals minIdle .
/server/batchService/convertersPool[@checkInterval]
the interval to check for idle converters.
/server/batchService/convertersPool[@maxChecks]
the maximum number of converters to check for idleness.
/server/batchService/convertersPool[@maxWait]
the maximum wait time (milliseconds) for the converters pool's clients. After this delay, an internal error will be thrown.
/server/batchService/workDir
the directory used by database for pending jobs.
/server/batchService/sortDir
the directory where jobs are sorted
/server/batchService/queueSize
the size of the batch job queue.
/server/batchService/poolSize
the size of the thread pool consuming batch jobs.
/server/batchService/initDatabaseOnStart
clear database when the server start
/server/batchService/launchFailedOnStart
retry failed jobs on server start
/server/templateService[@enabled]
specifies if the template service should be enabled.
/server/transports/transport
the mapping between transports and senders. Each tag has 2 attributes:
  • class : the transport class.
  • senderClass : the sender class.
/server/senderConfig/smtp/server
the SMTP server for e-mail senders.
/server/senderConfig/smtp/port
the SMTP port for e-mail senders.
/server/senderConfig/smtp/user
the SMTP user for e-mail senders.
/server/senderConfig/smtp/password
the SMTP password for e-mail senders.

RMI ports

If you are using the RMI version, the ports used by the server are defined in a separate file: jcopist-rmi.properties .