Installation

Steps:

1. The scheduler will be automatically available if the case-engine profile to the list of spring active profiles in the bootstrap.properties. More information on how to configure the application using Spring Profiles can be found here: External application configuration with Spring Profiles.
2. Add the application-case-engine.properties file in the configuration location if it does not yet exist. This properties file is added in the 
   spring.config.additional-location
    directory when using the Blueriq installer. Otherwise, please create this according to the documentation below.
3. Run the provided scripts for creating the quartz tables in the database: msssql.sql or oracle.sql. The scripts are located in the release zip in \Runtime\Java\Webapp\DBScripts\blueriq-case-engine-scheduler-quartz
4. Define quartz database connection in the application-externaldatasources.properties file.

Configuration

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 

Memory (default)

By default memory mode is enabled which should be used only for demos and standalone development. For recommended settings please check the database settings. For memory the following setting should be set in the application-case-engine.properties.

spring.quartz.job-store-type = memory

Database

Scripts to create the required database content are provided for the following databases:

• SQL Server
• Oracle

There are two types of connection that are supported:

• JDBC Connection
• JNDI Connection

Generate the Quartz Database

JDBC Connection

To enable the JDBC Connection the externaldatasources profile must enabled and the following properties have to be used:

spring.quartz.job-store-type = jdbc
spring.quartz.properties.org.quartz.jobStore.tablePrefix = QRTZ_

Driver delegate

For MSSQL, you might need to specify a driver delegate for the database to work correctly:

spring.quartz.properties.org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.MSSQLDelegate

External datasources

blueriq.datasource.scheduler-quartz.driverClassName = com.microsoft.sqlserver.jdbc.SQLServerDriver
blueriq.dataSource.scheduler-quartz.url = jdbc:sqlserver://<server_url>:<port>;databaseName=<database_name>;instance=<instance_name>
blueriq.datasource.scheduler-quartz.username = <user>
blueriq.datasource.scheduler-quartz.password = <password>

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.

JNDI Connection

To enable JNDI Connection the jndidatasources profile must be activated and the following properties have to be used:

spring.quartz.properties.org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreCMT
spring.quartz.properties.org.quartz.jobStore.tablePrefix = QRTZ_

Driver delegate

For the two different database options you might need to specify a driver delegate for the database to work correctly:

spring.quartz.properties.org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.MSSQLDelegate

spring.quartz.properties.org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.oracle.OracleDelegate

JNDI datasources

// 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. 

Thread Pool

If 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.

Each DCM project gets it's own trigger. It is recommended to have a thread per DCM project. For example if you have 3 DCM projects you should set the threadCount to 3. Please check that the threadCount does not exceed the number of available database connections (or connections in the database connection pool). 

Thread Pool properties are the following:

spring.quartz.properties.org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
spring.quartz.properties.org.quartz.threadPool.threadCount = 2

Setup Quartz

Various spring configurations

Using spring cloud config

Actions

1. Place your scheduler properties in application-case-engine.properties (Check here for example) in the searchLocations you specified for Spring Cloud.
2. Place application-externaldatasources.properties or application-jndidasarouces.properties files in the searchLocations you specified for Spring Cloud.

Using spring config additional location

1. In spring.config.additional-location directory place the application-case-engine.properties (Check here for example) file.
2. In spring.config.additional-location directory place the application-externaldatasources.properties or application-jndidatasources.properties files

Troubleshooting