Gentics CMS Documentation

Chapters

1. Scheduler REST API

2. Scheduler email Notification

3. Internal scheduler tasks

   • purgelogs

   • purgeversions

   • purgemessages

   • purgewastebin

   • linkchecker

   • publish

4. Custom Tasks

The scheduler is automatically started with Gentics CMS, no further configuration is necessary besides creating tasks and schedules in the admin UI.

1 Scheduler REST API

The status of the scheduler itself as well as tasks, schedules and executions can be queried and modified via the REST API. For further details see the documentation for the scheduler resource.

2 Scheduler email Notification

In case of errors the Scheduler is able to send notification mails. Use the array $SCHEDULER_JOB_FAILURE_EMAIL to configure notifications.

See eMail Sending with Gentics CMS for the necessary configuration items for sending emails.

// Additional recipient address to send a notification to besides the ones listed in the corresponding schedule.
$SCHEDULER_JOB_FAILURE_EMAIL["to"] = 'admin@emailaddress.com';
// The sender address.
$SCHEDULER_JOB_FAILURE_EMAIL["from"] = 'root@myserver.com';
// The email subject.
$SCHEDULER_JOB_FAILURE_EMAIL["subject"] = 'Scheduler execution failed: #name# (#id#)';
// Whether the email body is HTML text (defaults to false).
$SCHEDULER_JOB_FAILURE_EMAIL["is_html"] = false;
// The email body.
$SCHEDULER_JOB_FAILURE_EMAIL["body"] = "Scheduler Run Failed '#name#' (#id#)
Command: #cmd#
ReturnValue: #returnvalue#
StartTime: #starttime#
EndTime: #endtime#
Output:
#output#";

In "subject" and "body" the following placeholders will be replaced with actual data from the schedule and its execution:

3 Internal scheduler tasks

The following internal tasks are always available, and do not require a shell script to execute.

3.1 purgelogs

Will remove old log entries from the system. The following data will be purged:

• User activities
• Error messages and warnings
• Scheduler task information

The variable $CN_KEEPLOGS allows you to define, when data will be deleted:

// delete logs older than 12 months (default value)
$CN_KEEPLOGS = 12;

3.2 purgeversions

The command purgeversions will delete page versions older than $CN_VERSIONAGE months.

// delete page versions older than 12 months (default value)
$CN_VERSIONAGE = 12;

3.3 purgemessages

The command purgemessages will delete inbox messages older than $KEEP_INBOX_MESSAGES months.

// delete inbox messages older than 12 months (default value)
$KEEP_INBOX_MESSAGES = 12;

3.4 purgewastebin

The command purgewastebin will remove objects from the wastebin if either

• they reach the maximum age in the wastebin, or
• the wastebin feature has been turned off again.

The maximum age in the wastebin can be configured globally or per node:

	$WASTEBIN_MAXAGE = 7*24*60*60; // maximum age: 7 days (in seconds)
	$WASTEBIN_MAXAGE_NODE[1] = 60; // objects in node with ID 1 last only 60 seconds

3.5 linkchecker

This task will execute the link checker. The configuration options are described in the Link Checker Feature Documentation.

3.6 publish

This task will start a publish run.

4 Custom Tasks

When creating a custom task, only scripts in /Node/bin/scheduler-commands are valid commands by default. Unless the feature INSECURE_SCHEDULER_COMMAND is enabled, only scripts in /Node/bin/scheduler-commands may be executed. Other commands will be not be started by the scheduler.

To migrate existing tasks to the new scheduler, create a script in /Node/bin/scheduler-commands with the old tasks commands and call this script from the custom task. Make sure that the node user can read and execute scripts in that directory.