Introduction

The Case Engine Scheduler Component is introduced to be able to schedule without having a dependency on the runtime. It supports all scheduling options that the case engine needs. The  Case Engine Scheduler is implemented using Quartz Enterprise Job Scheduler.


Table of Contents

The case engine scheduler will share the Quartz scheduler instance with the basic/advanced scheduler, so if you already configured Quartz for the basic/advanced scheduler, you just need to enable the case-engine profile and you can skip the remainder of this guide.

Installation

Steps:

  1. The scheduler will be automatically available if the profile is added 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  directory when using the Blueriq installer.
  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 file.


Steps 3 and 4 are applicable only if Quartz triggers and jobs are stored in a database instead of in memory.


Configuration

Every Quartz configuration property has to be specified in application-case-engine.properties for the Runtime.


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)

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

Generate the Quartz Database

Create the Quartz database with respect to the database used (either Oracle or MSSQL).

In the Blueriq release zip there is a case-engine-scheduler-quartz directory that contains SQL scripts. Use your favorite database tool to run those scripts against the database server.

  1. Connect to the database server with the database tool.
  2. Create a new database dedicated to quartz - pick a meaningful name for this, e.g. 'CaseEngineQuartzScheduler'.
  3. Depending on the database tool used, one must make sure that the new database created is selected and set by default in the editor.
  4. Import the mssql.sql (for MSSQL) or oracle.sql (for Oracle server) and run it in the editor. If the run was successful new tables should be present in the newly created database.

Specify database properties

To enable the JDBC Connection the  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_

# For MSSQL, use a driver delegate
#spring.quartz.properties.org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.MSSQLDelegate

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.

When changing the org.quartz.jobStore.tablePrefix, please change the SQL create scripts accordingly.

Specify connection

The datasource can be specified directly using the external datasources, or via JNDI.

JDBC connection

Enable the profile and add the following properties to the :

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>

JNDI connection

To enable JNDI Connection enable the profile and add the following properties to the :

 

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

Thread Pool

When the database is configured, we recommend to also configure the thread pool. Each DCM project gets its 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). The quartz documentation suggests the following: provided that the database allows X connections, then the threadCount must be set to X - 3.

Below are the default thread Pool properties:

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

For more information and properties related to Quartz ThreadPool, please visit ThreadPool Configuration

Clustering

There are many configuration properties for clustering, see the Quartz documentation. To enable clustering, specify at least these properties:

spring.quartz.properties.org.quartz.jobStore.isClustered = true
spring.quartz.properties.org.quartz.scheduler.instanceName = MyClusteredScheduler
# Have Quartz generate an instanceId for each node in the cluster
spring.quartz.properties.org.quartz.scheduler.instanceId = AUTO

Troubleshooting


For more information on quartz configurations, please visit: Quartz-Scheduler.org.