Configuring the Quartz Scheduler

Configuring the Quartz Scheduler

Important: Quartz must be enabled on at least one platform instance, or the platform won't run. If you have multiple instances, Quartz should run on only one of them, unless you follow the Quartz clustering instructions below. Changing the quartz configuration requires a restart of all Application Servers.

Enabling Quartz on a Platform Instance

1. Edit {install_dir}/tomcat/webapps/networking/WEB-INF/web.xml

2. Modify the quartz servlet mapping so that:

a. The config-file parameter points to the Quartz properties file:
{install_dir}/tomcat/conf/RN/quartz.properties

b. The start-scheduler-on-load property is set to true, to make sure that quartz is started whenever the platform starts.

Example:

<servlet>
    <servlet-name>
        QuartzInitializer
    </servlet-name>

    <display-name>
       Quartz Initializer Servlet
    </display-name>

    <servlet-class>
        org.quartz.ee.servlet.QuartzInitializerServlet
    </servlet-class>

    <init-param>
        <param-name>config-file</param-name>
        <param-value>C:/apache-tomcat-6.0.20/conf/RN/quartz.properties</param-value>
                         [ ^-- Path to the properties file ]
    </init-param>

    <init-param>
        <param-name>shutdown-on-unload</param-name>
        <param-value>true</param-value>
    </init-param>

    <init-param>
        <param-name>start-scheduler-on-load</param-name>
        <param-value>true</param-value>
                     [ ^--Enables Quartz ]
    </init-param>

    <load-on-startup>
         1
    </load-on-startup>
</servlet>

3. Edit {install_dir}/tomcat/conf/RN/quartz.properties

4. Add the following information:

a. Database user name (an admin user)

b. Password for that user

Example:

org.quartz.dataSource.myDS.URL = jdbc:mysql://...

org.quartz.dataSource.myDS.user = rootuser                 [database user]

org.quartz.dataSource.myDS.password = password        [database user password]

Moving Quartz to Another Platform Instance

Suppose you have one application server instance, and you have decided to add another to handle the traffic volume. And let's say you also decide to move quartz to the new instance, to further reduce the load on the original server. To that, you disable Quartz on the first instance, and start it on the second.

Here is the procedure:

1. Open {install_dir}/tomcat/webapps/networking/WEB-INF/web.xml

2. Find the quartz servlet mapping for the first instance:

<servlet>
     <servlet-name>
         QuartzInitializer
     </servlet-name>

      ...

     <init-param>
         <param-name>start-scheduler-on-load</param-name>
         <param-value>false</param-value>
                      [ ^-Disables Quartz ]
     </init-param>

      ...

</servlet>

3. For the second instance, follow the steps above, in Setting up Quartz on a Platform Instance

Setting up a Quartz Cluster

By default, Quartz is pre-configured to run as a cluster of instances running on different servers. To run successfully, however, each server must have the settings shown here. Otherwise, a Quartz instance will not know that the others exist, and will not lock job records that are in progress. Perform this configuration on any server you later add to the cluster.

1. Open {install_dir}/tomcat/conf/RN/quartz.properties

2. Check this line:

org.quartz.scheduler.instanceId = AUTO                [VERIFY THIS LINE]

3. Under # Configure JobStore, check these lines:

...
# Configure JobStore
org.quartz.jobStore.misfireThreshold = 60000          [VERIFY THESE LINES]
org.quartz.jobStore.isClustered = true
org.quartz.jobStore.clusterCheckinInterval = 20000

In addition, MySQL must be configured to set the appropriate transaction-isolation level and to specify row-based replication:

1. Edit {MYSQL_INSTALLATION}/my.cnf
2. Use the following settings:

transaction-isolation = READ-COMMITTED
binlog-format = ROW