jobs

This configuration is required when using the plugin JobScheduling.

Documentation
YAML Format
XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.

<jobsConfig

required

<heartbeat

optionalduration

Interval at which the job scheduler instance checks whether a new job needs to be created based on the job descriptions, and interval at which the Cadenza instances check whether executable jobs are available. The interval is specified according to ISO 8601 in PnYnMnDTnHnMnS format, e.g. PT600S means "up to 600 seconds from now"; more information. The default value is PT1M (1 minute). Note: If the interval is set too long, e-mails may be sent too late.

</heartbeat>

<datasource

<driverName

requiredstring

Fully qualified name of the JDBC driver

</driverName>

<jdbcURL

requiredstring

JDBC URL of the database

</jdbcURL>

<user

requiredstring

The database user on whose behalf the connection is being made

</user>

<password

requiredstring

Encoded password of the database user. Use the Cadenza password encoder for this.

</password>

<connectionPoolSize

optionalint

Size of Hibernate Connection Pools

Default: 10

</connectionPoolSize>

<connectionIdleTimeout

optionalint

DEPRECATED: 'connectionIdleTimeout' has been deprecated and should be removed. Due to improvements in connection pooling, Cadenza works with fixed-size connection pools, so the 'connectionIdleTimeout' setting no longer has any effect. A future Cadenza version may fail to start if the configuration is still present.

</connectionIdleTimeout>

<properties

<property

xs:string

name

required

string

description

optional

string

optionalmax. unbounded

</property>

optional

</properties>

required

Connection to the database in which the jobs are managed. Please also note the information on preparing the job management database (see below).

</datasource>

<execution

required

<workerThreadPoolSize

required

Number of threads that check for new jobs and execute them (e.g. executing a database query for the event-driven sending of emails) Important: The number of threads must be matched to the configured number of connections that the connection pool is allowed to create to the database (see `<connectionPoolSize>` element). It should not be higher, as this can have a negative impact on performance. Furthermore, these sizes must be adjusted accordingly in cluster operation so that the database is not requested with more connections than have been configured for it.

>=1xs:int

</workerThreadPoolSize>

<workerKeepAliveTime

optionalduration

Duration after which an idle thread is terminated The duration is specified according to ISO 8601 in PnYnMnDTnHnMnS format. The default value is PT1D (1 day). Note: This value only needs to be adjusted if the interval for creating and executing the jobs (see <heartbeat> element) is significantly greater than one minute. In this case, a thread can be started for a short period of time in order to release the resources again immediately afterwards.

</workerKeepAliveTime>

</execution>

<cleanup

optional

Settings for the cleanup job.

<intervalInHours

required

Interval for the execution of the cleanup job in hours The first execution of the day always takes place at 00:00. The subsequent executions of the same day follow at the interval configured here. Valid values must be a divisor of 24 (1, 2, 3, 4, 6, 8, 12, 24). The default value is 24, i.e. 24 hours.

Default: 24

xs:int

</intervalInHours>

</cleanup>

</jobsConfig>

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.

cadenzaconfig:
  settings:
    jobs:
      heartbeat: "P2DT3M"
      datasource:
        driverName: "text"
        jdbcURL: "text"
        user: "text"
        password: "text"
        connectionPoolSize: 15
        connectionIdleTimeout: 15
        properties:
        - name: "text"
          description: "text"
          value: "text"
        - name: "text"
          description: "text"
          value: "text"
      execution:
        workerThreadPoolSize: 15
        workerKeepAliveTime: "P2DT3M"
      cleanup:
        intervalInHours: 15

Filename: jobs-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobsConfig>
  <heartbeat>P2DT3M</heartbeat>
  <datasource>
    <driverName>text</driverName>
    <jdbcURL>text</jdbcURL>
    <user>text</user>
    <password>text</password>
    <connectionPoolSize>15</connectionPoolSize>
    <connectionIdleTimeout>15</connectionIdleTimeout>
    <properties>
      <property name="text" description="text">text</property>
      <property name="text" description="text">text</property>
    </properties>
  </datasource>
  <execution>
    <workerThreadPoolSize>15</workerThreadPoolSize>
    <workerKeepAliveTime>P2DT3M</workerKeepAliveTime>
  </execution>
  <cleanup>
    <intervalInHours>15</intervalInHours>
  </cleanup>
</jobsConfig>