Properties
Info |
---|
Quartz is configured using a set of properties that are available for the Runtime. Quartz uses a job store in order to persist jobs details, triggers and other job related information. All quartz related properties are stored in application-scheduler-quartz.properties in spring.config.additional-location.
Read best practices to know every insight on how to use these properties. |
Quartz Properties
Info |
---|
In this section can find a list of properties which we use to set up a job store for quartz. These properties should be placed in the application-scheduler-quartz.properties file in spring.config.additional-location.
|
UI Expand |
---|
|
JobStore Properties |
---|
Quartz Property Key | Example Value | Default Value | Description |
---|
spring.quartz.job-store-type | jdbc | memory | The type of job store to be used by quartz. Do not use memory in production environments as there is no way to save quartz jobs during downtime. The preferred way is to use Direct or JNDI Connection. To configure a Direct or JNDI Connection please visit Quartz Scheduler Configuration. | spring.quartz.properties.org.quartz.jobStore.tablePrefix | QRTZ_ | QRTZ_ | The table prefix you used for quartz tables in your database. In case of an in-memory connection, this property is not required. | spring.quartz.properties.org.quartz.jobStore.dataSource | NAME | null | Represents the name of your datasource. It can be any string, but be sure you will use the same value for your datasource properties described in the next section. | spring.quartz.properties.org.quartz.jobStore.misfireThreshold | 60000 | 60000 | The number of milliseconds the scheduler will tolerate a trigger to pass its next-fire-time by, before being considered misfired. In case you do not specify this property, 60 sec is considered as misfire. | Datasource Properties in external datasources
|
---|
blueriq.datasource.scheduler-quartz.url | com.microsoft.sqlserver.jdbc.SQLServerDriver | null | Java class name of JDBC driver for your database connection.
To configure other types of datasources, visit Quartz Scheduler Configuration . | blueriq.datasource.scheduler-quartz.url | jdbc:sqlserver://[host]:[port];databaseName=[dbname];instance=SQLEXPRESS | null | Url Connection to your database. | blueriq.datasource.scheduler-quartz.username | test | "" | Username which is used for connecting to the database. | blueriq.datasource.scheduler-quartz.passwor | test | "" | Password which is used for connecting to the database. | Thread Pool Properties |
---|
spring.quartz.properties.org.quartz.threadPool.class | org.quartz.simpl.SimpleThreadPool | null | The name of thread pool implementation you want to use. | spring.quartz.properties.org.quartz.threadPool.threadCount | 30 | -1 | Represents the number of threads that are available for concurrent execution of jobs. | Clustered Environment Properties |
---|
spring.quartz.properties.org.quartz.jobStore.isClustered | true | false | Enables clustering. | spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval | 90000 | 15000 | Represents the number of threads that are available for concurrent execution of jobs. | Quartz Scheduler Properties |
---|
spring.quartz.properties.org.quartz.scheduler.instanceName | MyScheduler | QuartzScheduler | Name of the cluster. Must be the same for all nodes in the cluster.
| spring.quartz.properties.org.quartz.scheduler.instanceId | AUTO | NON_CLUSTERED | Instance id of the quartz node. Each node in the cluster must use a unique instanceId. (This is done by setting AUTO) | spring.quartz.properties.org.quartz.scheduler.skipUpdateCheck | true | false | If this is true, quartz skips running a request which checks if there is an updated version of Quartz available. It is recommended to be true for production environment so Quartz updates do not interfere with the application. |
|
Info |
---|
Configuration Anchor |
---|
| Configuration |
---|
| Configuration |
---|
|
Info |
---|
Every Quartz configuration property has to be specified in application-scheduler-quartz.properties for Runtime. |
In order to tune resources for job execution we provided a few details about the Thread Pool. Quartz is configured using a set of properties. Quartz uses a job store in order to persist jobs details, triggers and other job related information. We support two types of job stores: - Memory (default) for demo's and standalone development
- Database recommended
|
Examples
In memory
Info |
---|
|
This is the default configuration for java environments. For more details about in memory job store configuration please visit Config RAM Job Store. |
By default memory mode is enabled. The following setting should appear in the application-scheduler-quartz.properties.
Code Block |
---|
title | application-scheduler-quartz.properties |
---|
|
spring.quartz.job-store-type=memory |
If you want to use jdbc mode you must specify in the application-scheduler-quartz.properties:
Code Block |
---|
title | application-scheduler-quartz.properties |
---|
|
spring.quartz.job-store-type=jdbc |
Info |
---|
Memory (default)By default memory mode is enabled which should not be used unless for demo's and standalone development. For recommended settings please check the database settings. For memory the following setting should appear in the quartz.properties. Code Block |
---|
title | application-scheduler-quartz.properties |
---|
| spring.quartz.job-store-type=memory |
|
Direct Database connection
Anchor |
---|
| DatabaseConnection |
---|
| DatabaseConnection |
---|
|
Info |
---|
|
If you want to use jdbc connection for quartz, externaldatasources profile must be enabled.
The database connection for quartz is defined in application-externaldatasources.properties file in spring.config.additional-location. Jdbc settings can be used only if the externaldatasources profile is enabled too.
For more details about direct database connection visit JobStoreTX. You can find there a list of supported database types. In this sections we present an example of quartz.properties files for MsSql and Oracle database connections.
|
MSSQL
Code Block |
---|
title | application-externaldatasources.properties - mssql |
---|
|
blueriq.datasource.scheduler-quartz.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
blueriq.dataSource.scheduler-quartz.url=jdbc:sqlserver://<server_url>:<port>;databaseName=<database_name>;instance=SQL_EXPRESS
blueriq.datasource.scheduler-quartz.username=<user>
blueriq.datasource.scheduler-quartz.password=<password>
|
Oracle
Code Block |
---|
title | application-externaldatasources.properties - oracle |
---|
|
blueriq.datasource.scheduler-quartz.driverClassName=oracle.jdbc.driver.OracleDriver
blueriq.dataSource.scheduler-quartz.url=jdbc:oracle:thin:@<server_url>:<port>:xe
blueriq.datasource.scheduler-quartz.username=<user>
blueriq.datasource.scheduler-quartz.password=<password>
|
JNDI connection
Info |
---|
|
For more details about JNDI connection visit JobStoreCMT. A JNDI connection can be provided for quartz datasource, which can be configured in the application-jndidatasources.properties file. When configuring JNDI datasources the jndidatasources profile should be enabled. |
Code Block |
---|
title | application-jndidatasources.properties - jndi |
---|
|
// JBoss Example provided that the jndi name is set to java:jboss/jdbc/quartzdb
blueriq.datasource.scheduler-quartz.jndiName=java:jboss/jdbc/quartzdb
// Tomcat Example provided that the jndi name is set to jdbc/quartzdb
blueriq.datasource.scheduler-quartz.jndiName=java:/comp/env/jdbc/quartzdb |
Info |
---|
DatabaseScripts to create the required database content are provided for the following databases: There are two types of connection that are supported: - JDBC Connection
- JNDI Connection
JDBC ConnectionTo enable the JDBC Connection the externaldatasources profile must enabled and the following properties have to be used: Code Block |
---|
title | application-scheduler-quartz.properties |
---|
| spring.quartz.job-store-type=jdbc
spring.quartz.properties.org.quartz.jobStore.tablePrefix=QRTZ_
|
Code Block |
---|
title | application-externaldatasources.properties - mssql |
---|
| blueriq.datasource.scheduler-quartz.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
blueriq.dataSource.scheduler-quartz.url=jdbc:sqlserver://<server_url>:<port>;databaseName=<database_name>;instance=SQL_EXPRESS
blueriq.datasource.scheduler-quartz.username=<user>
blueriq.datasource.scheduler-quartz.password=<password>
|
Code Block |
---|
title | application-externaldatasources.properties - oracle |
---|
| blueriq.datasource.scheduler-quartz.driverClassName=oracle.jdbc.driver.OracleDriver
blueriq.dataSource.scheduler-quartz.url=jdbc:oracle:thin:@<server_url>:<port>:xe
blueriq.datasource.scheduler-quartz.username=<user>
blueriq.datasource.scheduler-quartz.password=<password>
|
JobStoreTX allows Quartz managing quartz related transactions. JDBCJobStore’s “table prefix” property is a string equal to the prefix given to Quartz’s tables that were created in your database. You can have multiple sets of Quartz’s tables within the same database if they use different table prefixes. Info |
---|
When changing the org.quartz.jobStore.tablePrefix, please change the create scripts accordingly. |
Info |
---|
For more information and properties related to the connection JobStoreTX please visit JDBC-JobStoreTX. |
JNDI ConnectionTo enable JNDI Connection jndidatasources profile must be activated and the following properties have to be used: Code Block |
---|
title | application-scheduler-quartz.properties |
---|
| spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreCMT
spring.quartz.properties.org.quartz.jobStore.tablePrefix=QRTZ_
|
Code Block |
---|
title | application-jndidatasources.properties - jndi |
---|
| // JBoss Example provided that the jndi name is set to java:jboss/jdbc/quartzdb
blueriq.datasource.scheduler-quartz.jndiName=java:jboss/jdbc/quartzdb
// Tomcat Example provided that the jndi name is set to jdbc/quartzdb
blueriq.datasource.scheduler-quartz.jndiName=java:/comp/env/jdbc/quartzdb |
JobStoreCMT relies upon transactions being managed by the application which is using Quartz. Info |
---|
For more information and properties related to the connection JobStoreCMT please visit JDBC-JobStoreCMT. |
|
Cluster
Anchor |
---|
| clusterProperties |
---|
| clusterProperties |
---|
|
Info |
---|
|
Clustered environment can be configured only for JDBC JobStore (JobStoreTX and JobStoreCMT). For more information about clustered setup read Configuring Clustered Environment. |
Code Block |
---|
title | applcation-scheduler-quartz.properties - cluster |
---|
|
spring.quartz.properties.org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
spring.quartz.properties.org.quartz.threadPool.threadCount=2
spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
spring.quartz.properties.org.quartz.jobStore.tablePrefix=QRTZ_
spring.quartz.properties.org.quartz.jobStore.isClustered = true
spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval = 90000
spring.quartz.properties.org.quartz.scheduler.instanceName = MyClusteredScheduler
spring.quartz.properties.org.quartz.scheduler.instanceId = AUTO
spring.quartz.properties.org.quartz.scheduler.skipUpdateCheck = true
|
Info |
---|
Thread PoolIf the Database configuration is chosen we recommend to also add the thread pool with the following default values: The quartz documentation suggests the following configuration: provided that the database allows X connections, then the threadCount must be set to X - 3. If a JNDI connection is used, then the connection that is behind the JNDI name defines a max number of connections in the pool - say Y. In this case the thread count must be Y - 3. Thread Pool properties are the following: Code Block |
---|
language | powershell |
---|
title | application-scheduler-quartz.properties |
---|
| spring.quartz.properties.org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
spring.quartz.properties.org.quartz.threadPool.threadCount=2 |
|
Scheduler Properties
Anchor |
---|
| SchedulerProperties |
---|
| SchedulerProperties |
---|
|
Info |
---|
In this section you can find a list of scheduler related properties. These should be placed in a file named application-scheduler-quartz.properties in spring.config.additional-location. These properties are needed to enable or personalize scheduler functionalities from blueriq runtime perspective. |
UI Expand |
---|
|
Blueriq Property Key | Default Value | Description |
---|
blueriq.scheduler-quartz.enable-task-migration | false | Used to enable quartz migration.
For more information about the migration API visit Migration API, for details about this property visit Migration. | blueriq.scheduler-quartz.retryInterval | 30 | Represents a number in minutes, which is used for jobs retry mechanism in case of misfire.
For more information about this property visit Retry Interval. | blueriq.scheduler-quartz.handleModelChanges | false | Used to enable updates on tasks and jobs when model changes. For more information about this property visit Handle Model Changes. |
|
Examples
Default configuration file:
Anchor |
---|
| SchedulerProperties |
---|
| SchedulerProperties |
---|
|
Code Block |
---|
title | application-scheduler-quartz.properties |
---|
|
blueriq.scheduler-quartz.enable-task-migration=false
blueriq.scheduler-quartz.retryInterval=30 |
Generate the Quartz Database
Warning |
---|
Generate the quartz database with respect to the database used (either oracle or mssql). In the blueriq deliverable there is a scheduler-quartz-component that contains sql scripts. Use the favourite database viewer to run those scripts against the database server. - Connect to the database server with the favorite viewer.
- Create a new database dedicated to quartz - pick a meaningful name for this, e.g. 'QuartzScheduler'.
- Depending on the database viewer used, one must make sure that the new database created is selected and set by default in the editor.
- Import the mssql.sql (for mssql server) or oracle.sql (for oracle server) and run it in the editor. If the run was successful new tables should be present under the newly created database.
|
Setup Quartz
Using spring cloud config
Actions
- Place your scheduler properties in application-scheduler-quartz.properties (Check here for example) in the searchLocations you specified for spring cloud.
- Place application-externaldatasources.properties or application-jndidasarouces.properties files in the searchLocations you specified for spring cloud.
Not using spring config additional location
Anchor |
---|
| NoSpringConfig |
---|
| NoSpringConfig |
---|
|
Default quartz properties will be used because application-scheduler-quartz.properties file is not present. The default setup is in-memory configuration.
Scheduler properties can be personalized via JVM arguments:
Code Block |
---|
|
-Dblueriq.scheduler-quartz.enable-task-migration=false
-Dblueriq.scheduler-quartz.retryInterval=30 |
If no property is defined, the default ones will be used.
Using spring config additional location
Info |
---|
Configure a spring.config.additional-location for your application. For more details about how to do this visit Installing Runtime. |
- In spring.config.additional-location folder place the application-scheduler-quartz.properties (Check here for example) file.
- In spring.config.additional-location folder place the application-externaldatasources.properties or application-jndidasarouces.properties files
Using existing scheduled tasks
Anchor |
---|
| setupWithSchedule |
---|
| setupWithSchedule |
---|
|
In order for the already scheduled tasks to be executed in time, you need to do a migration to the scheduler.
Before running the migration you need to create the following files and place them in your spring.config.additional-location folder:
- Create a application-scheduler-quartz.properties file with one of the following configurations: Direct Connection(MsSql, Oracle), JNDI Connection.
We advise you not to use an In-Memory Configuration or leave the default one for this purpose. - In the application-scheduler-quartz.properties file, set blueriq.scheduler-quartz.enable-task-scheduler and blueriq.scheduler-quartz.enable-task-migration to true (Check here for example).
Info |
---|
|
For more information regarding migration preconditions read Migration API Preconditions.
We exposed four endpoints to migrate timer, expiration, priority and pending automatic tasks to quartz scheduler. In order to use them follow the steps described in Scheduler Migration API. |
Setup quartz in cluster
Overview
Basic Scheduler
The quartz evaluation of time dependent tasks (timer nodes, tasks with priority algorithms, expiration tasks, automatic recovery tasks) is done per Process Engine per Project installed on the Runtime. A quartz job is created for every single project which uses a process engine in the cluster. The number of jobs in Quartz equals with the number of initialized projects from the cluster which are using a process engine. The number of jobs in quartz does not depend on the number of runtime instances available in the cluster.
An interval is defined in the application.properties file which marks the triggering and execution of the job. If the interval is MINUTE, the quartz job will be triggered and executed every minute. The execution consists in finding and evaluating all the timer tasks, expiration tasks, tasks with priority which should fire in that period.
The Runtime instances are selected for execution almost randomly, more busy servers have a lower chance to be selected for the execution.The main advantage for this is that: As multiple runtime instances are available in cluster, the execution of the jobs might be done in parallel.
The quartz job is created in the cluster when the project which uses a process engine is initialized. This means whenever a project is published and the process engine is initialized in a Runtime, that Runtime will try to start the job for the project if the job is not already created.
The execution of quartz jobs is being done on any Runtime in the cluster as soon as the Runtime is started. This might happen even though in that Runtime no projects are published yet.
Advanced Scheduler
The quartz evaluation of a timer task, a expiration task, a task with priority or an automatic task is done per task. A quartz job is created for every task which has one of the types described earlier. The number of jobs in quartz equals with the number of timer, expiration and task with priority which have to be evaluated in the future.
Every job fires exactly at the time it was modelled without re-checking this at an interval as the basic scheduler did. The runtime instances are selected randomly and the execution of a job can happen on any of those instances in parallel.
Setup
Info |
---|
|
In order to run the Quartz Scheduler on multiple Runtime instances in a cluster, every Runtime instance has to be identical and have the same projects installed. Each instance in the cluster needs to have the same application-scheduler-quartz.properties files. You may set different thread pool size on each node. To read more about quartz clustered environment visit Quartz in Cluster. |
To set up quartz in cluster create the following two files and place them in your spring config additional location:
- Create a application-scheduler-quartz.properties file (check Quartz Properties Cluster for an example)
Make sure the following were added:
1.1 Set spring.quartz.properties.org.quartz.jobStore.isClustered to true
1.2 Set spring.quartz.properties.org.quartz.scheduler.instanceId to AUTO, or a different id for each instance node.
- Create application-scheduler-quartz.properties file (Check here for example)
Warning |
---|
title | Do not enable this setting in clustered environment |
---|
|
When quartz is used in a clustered environment one must not set the blueriq.processengine.cancel-started-tasks=true. The property can be set in the application-scheduler-quartz.properties file and the default value is false. When a single server is restarted and the blueriq.processengine.cancel-started-tasks is set to true all opened task are reset so they can be opened again. In a multi node environment the danger is when a single node is restarted and could result in having all tasks that are in progress being reset while they are still in progress on the other server. |
Troubleshooting
Warning |
---|
|
There might be a side scenario in which one runtime in a cluster does not have all the projects available but it is started. In this case, Quartz might trigger a job on that server without having a project to run on. If this happens the job for that project is deleted and won't trigger until the project is loaded - this usually means that there is a configuration problem in the cluster. Loading/publishing a project in a Runtime will trigger the creation of the job in the cluster if the job doesn't already exist. If you're uncertain that a job is running or not, you can check the logs. Starting or deleting a job is always logged. Besides this you can check the quartz database. In the table QRTZ_JOB_DETAILS there should be a column JOB_NAME. That field should contain the project and process engine name for which that job was created. It is very recommended that no changes to be done in quartz tables and you let only Quartz manage the data there. |