6. Parameters¶
6.1. Engine parameters¶
These parameters gouvern the behaviour of the JQM engines.
There are three sets of engine parameters:
- node parameters, for parameters that are specific to a single engine (for example, the TCP ports to use). These are stored inside the database.
- global parameters, for parameters concerning all engines (for example, a list of Nexus repositories). These are stored inside the database.
- bootstrap parameters: as all the previous elements are stored inside the database, an engine needs a minimal set of parameters to access the database and start.
Note
also of interest in regard to engine configuration is the queues configuration.
6.1.1. Bootstrap¶
This is a file named JQM_ROOT/conf/resource.xml. It contains the definition of the connection pool that is used by JQM to access its own database. See Administrating resources for more details on the different parameters - it is exactly the same as a resource defined inside the JQM database, save it is inside a file read before trying to connect to the JQM database.
Actually, resources.xml can contain any resource, not just the connection to the JQM database. However, it is not recommended - the resource would only be available to the local node, while resources defined in the database are available to any node.
A second file exists, named JQM_ROOT/conf/jqm.properties. It is not currently used, except if you are using the (not production grade) database HSQLDB, in which case the line it contains must be uncommented. It can be safely deleted otherwise.
Changes to bootstrap files require an engine restart.
6.1.2. Node parameters¶
These parameters are set inside the JQM database table named NODE. There is no GUI or CLI to modify these, therefore they have to be altered directly inside the database with your tool of choice.
| Name | Description | Default | Nullable | Restart |
|---|---|---|---|---|
| DNS | The interface name on which JQM will listen for its network-related functions | first hostname | No | Yes |
| PORT | Port for the basic servlet API | Random free | No | Yes |
| dlRepo | Storage directory for files created by payloads | JQM_ROOT\outputfiles | No | Yes |
| REPO | Storage directory for all payloads jars and libs | JQM_ROOT\jobs | No | Yes |
| ROOTLOGLEVEL | The log level for this engine (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) | INFO | No | Yes |
| EXPORTREPO | Not used | |||
| JMXREGISTRYPORT | TCP port on which the JMX registry will listen. Remote JMX disabled if NULL or <1. | NULL | Yes | Yes |
| JMXSERVERPORT | Same with server port | NULL | Yes | Yes |
(‘restart’ means: restarting the engine in question is needed to take the new value into account)
6.1.3. Global parameters¶
These parameters are set inside the JQM database table named GLOBALPARAMETER. There is no GUI or CLI to modify these, therefore they have to be altered directly inside the database with your tool of choice.
| Name | Description | Default | Restart | Null |
|---|---|---|---|---|
| mavenRepo | A Maven repository to use for dependency resolution | Maven Central | No | At least one |
| mailSmtpServer | SMTP server to send end-of-job notifications | none | No | Yes |
| mailFrom | the “from” field of notification mails | jqm@noreply.com | No | ? |
| mailSmtpUser | if SMTP with authentication | NULL | No | ? |
| mailSmtpPassword | if SMTP with authentication | NULL | No | ? |
| mailUseTls | if SMTP with authentication. true of false | NULL | No | No |
| defaultConnection | don’t use this... | jdbc/jqm | No | No |
| deadline | ??? | ? | ? | ? |
| logFilePerLaunch | if true, one log file will be created per launch. Otherwise, everything ends in the main log. | true | Yes | No |
| internalPollingPeriodMs | Period in ms for checking stop orders | ? | ? | ? |
| aliveSignalMs | Must be a multiple of internalPollingPeriodMs. Perdiod at which the “I’m a alive” signal is sent | ? | ? | ? |
Here, nullable means the parameter can be absent from the table.
Parameter name is case-sensitive.
Note
the mavenRepo is the only parameter that can be specified multiple times. There must be at least one repository specified. If using Maven central, please specify ‘http://repo1.maven.org/maven2/‘ and not one the numerous other aliases that exist. Maven Central is only used if explicitely specified (which is the default).