Scheduler module
Administration Bundled: Community Edition
Edition |
CE |
License |
|
Issues |
|
Maven site |
|
Latest |
2.3.6 |
The Magnolia Scheduler module allows you to schedule commands to run at regularly scheduled times and is powered by the Quartz Engine.
Installing with Maven
Bundled modules are automatically installed for you.
If the module is unbundled, add the following to your bundle including your project’s <dependencyManagement> section and your webapp’s <dependencies> section.
If the module is unbundled but the parent POM manages the version, add the following to your webapp’s <dependencies> section.
<dependency>
<groupId>info.magnolia</groupId>
<artifactId>magnolia-module-scheduler</artifactId>
<version>2.3.6</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
Usage
The Scheduler module can be used to execute any configured command at regular intervals. For example, it can:
-
Publish or unpublish a promotional web page on a specific date.
-
Import content from an external source into a Magnolia workspace.
-
Send emails on specific days.
-
Delete specified forum messages or threads.
-
Synchronize target and source instances.
-
Execute a custom command.
Configuration
The Scheduler module is used to execute commands that are typically configured in other modules. See Commands for more.
Scheduled tasks are configured in modules/scheduler/config/jobs.
Example: demo job that activates the /news page hourly.
|
required Jobs node. |
|
required Name of the job. |
|
optional Parameters node. |
|
required/optional Parameters passed to the command. Depends on the command. For example,
the |
|
required Name of the catalog where the command resides. |
|
required Name of the command. |
|
required CRON
expression that sets the scheduled execution time. For example,
|
|
optional Description of the job. |
|
optional, default is Enables and disables the job. |
|
optional, default is Defines whether the same job can be running concurrently. |
| The Synchronization, Backup and RSS Aggregator modules use the Scheduler module for scheduling their execution. |
Scheduling tasks on cluster nodes
In a clustered configuration one or more workspaces is stored in a shared, clustered storage. See Clustering for more. Cluster nodes (Magnolia instances) access the clustered workspace rather than their own workspaces. This can lead to a situation where multiple scheduled jobs attempt to access the same content simultaneously and a lockup occurs. To avoid this situation, identify the cluster nodes and run the job on only one node.
-
Set the
magnolia.clusteridproperty in themagnolia.propertiesfile of the cluster node. The file is in the/<CATALINA_HOME>/webapps/<contextPath>/WEB-INF/config/defaultfolder. The property value can be a literal cluster name such aspublic123(magnolia.clusterid=public123) or a variable such as${servername}. -
To configure the job to run on the identified cluster node, go to
/modules/scheduler/jobsand edit the job configuration. -
Under the
paramsnode, add aclusterIdproperty and set the value to match themagnolia.clusterIdof the cluster node where you want to run the job.
Job configurations are stored in the config workspace. If you want to
run a particular job on all cluster nodes you would have to cluster the
config workspace so that all instances can read the configuration or
create the same job configuration on all cluster nodes. This can be time
consuming. As a workaround, configure the job once on a clustered
instance without the clusterId property. This has the effect that the
job will run on all cluster nodes.