Document Properties
Kbid28518D
Last Modified22-Jun-2020
Added to KB06-Dec-2017
Public AccessEveryone
StatusOnline
Doc TypeGuidelines, Concepts & Cookbooks
Product
  • IOM 2.2
  • IOM 2.9
  • IOM 2.15

Concept - IOM Quartz Jobs


1 Introduction

Intershop Order Management (IOM) has the ability to configure and run time based jobs with the help of the integrated Quartz job scheduling library. This document describes the basic concepts. The target audiences are partners, consultants and developers.

In a nutshell, the main idea behind job scheduling is:

  • To define/configure what should be done and
  • To define/configure when it should be done (once at a specified point in time resp. repeatedly at a specified point in time)

in order to automate processes.

1.1 Glossary

Term

Description

IOMThe abbreviation for Intershop Order Management
QuartzAn open source job scheduling library

1.2 References

2 Usage of Time-based Quartz Jobs in the IOM

The following section lists the main tasks of Quartz jobs in the context of IOM.

2.1 Trigger Jobs for Self-healing of Technical Failures

The IOM uses asynchronous business processes that are initially triggered by:

  • Users via the graphical user interface
  • External systems via interface
  • The application itself
  • And more

For various technical reasons, such business processes can abort unexpectedly. The jobs are responsible for resuming the processing of pending business processes (or single tasks of them), in order to finish them.

For details please see the jobs of the POST_PROCESSING_* and the TRANSMISSION_RETRY job groups in Reference - IOM Quartz Jobs.

2.2 Trigger Jobs for the Import and Export of Data

There are jobs, that trigger the import resp. export of various data (e. g., articles, customers, orders).

For details please see the jobs of the IMPEX_* job groups in Reference - IOM Quartz Jobs.

2.3 Trigger Jobs for Business Operation Tasks

There are jobs, that trigger simple business operation tasks like sending payment reminder e-mails or checking for expiring credit cards, etc.

For details please see the jobs of the BUSINESS_OPERATION_* job groups in Reference - IOM Quartz Jobs.

2.4 Trigger Jobs for Validation Tasks

There is a single job in the VALIDATE_PCM job group, that triggers the validation of existing process control configurations.

For details please see the jobs of the VALIDATE_PCM job group in Reference - IOM Quartz Jobs.

2.5 Trigger the IOM Job Framework

By the default configuration, a single job in the JOB_FRAMEWORK job group triggers the IOM Job Framework.

3 Configuration

In order to use the Quartz job scheduling provided by the Intershop Order Management (IOM) at least two configuration files are required within the $VAR/etc folder. These are:

File nameUsage
quartz-cluster.propertiesbasic scheduling configuration
quartz-jobs-cluster.xmldetailed job and trigger configuration

By default, after the initial setup of the IOM, both configurations already exist with a working set of configurations.

3.1 Basic Scheduling Configuration

The basic scheduling configuration is required to define a single scheduling instance. The corresponding file must be named quartz-cluster.properties, has to be located in the OMS_ETC directory and is used after the startup of the bakery.control-app-$OMS_VERSION.ear artifact to instantiate the scheduling instance. By default, that single clustering scheduling instance is configured to use the detailed job and triggering configuration file (quartz-jobs-cluster.xml) to schedule a working set of time-based jobs. For further details please see the Quartz Configuration Reference.

3.2 Detailed Job and Trigger Configuration

For further details please see the Reference - IOM Quartz Jobs, the Cookbook - IOM Quartz Jobs and the Quartz Cookbook - Initializing Job Data With Scheduler Initialization.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets