The scheduler handles events and alarms and deletes old data.

Scheduler Types

There are two types of schedulers.

Fixtime: A scheduler that runs at a specific time
Interval: A scheduler that repeats at an interval you set

The Interval type counts the interval from the last successful run. Restarting the server does not restart the count, and if a run is already overdue, it runs within a few minutes after the server starts. In this case, the start time varies slightly for each scheduler. If there is no record of a previous run, the scheduler waits for one interval before its first run.

Schedulers

Each scheduler is described below. In the <Admin | Servers | Scheduler> menu, click a scheduler name to change its run time or interval. The interval is in minutes. For the Interval type, enter 0 as the interval to stop it from running.

In a redundant server environment, LogFileCompressor, EventCreatorScheduler, and SystemMonitor run on all nodes. The other schedulers run only on the main node.

AlarmScheduler

Runs alarms. If you set the interval too long, alarms might go off later than the time they were set for.

Interval type. Runs every 5 minutes by default.

BackupScheduler

Backs up data. It runs only when the database is H2 or Apache Derby. It is not supported for other databases, such as Oracle.

Fixtime type. Runs at 4:00 a.m. by default.

CampaignScheduler

Sends campaigns whose scheduled time has passed.

Interval type. Runs every 30 minutes by default.

DocumentFileBuilderScheduler

Exports libraries with the “Creating files with the scheduler” option selected to HTML.

Fixtime type. Runs at 5:00 a.m. by default.

EventClearScheduler

Deletes notification events after a certain period. Unread notifications are deleted after 14 days, and read notifications after 7 days.

Fixtime type. Runs at 3:40 a.m. by default.

EventCreatorScheduler

Creates notification events at a regular interval. After creating them, it clears the cache and removes Work that finished more than a minute ago from the list. If documents are edited frequently, we recommend setting it to 60 minutes.

Interval type. Runs every 10 minutes by default.

LabelExpireScheduler

Removes label assignments whose retention period, set for each label, has passed. The labels themselves are not deleted.

Fixtime type. Runs at 4:00 a.m. by default.

LinkUpdateScheduler

Builds backlinks. If documents are edited frequently, we recommend setting it to 60 minutes.

Interval type. Runs every 30 minutes by default.

LogFileCompressor

Compresses log files by month so that log files do not pile up.

Fixtime type. Runs at 2:00 a.m. by default.

LoginHistoryClearScheduler

Deletes login history data. The default retention period is 365 days, and you can change it. In a redundant environment, it also periodically cleans up login session information left behind by abnormal shutdowns.

Fixtime type. Runs at 3:50 a.m. by default.

MailClearScheduler

Deletes mail data more than 30 days after it was sent.

Fixtime type. Runs at 3:30 a.m. by default.

MailImportScheduler

Imports mail received by mail channels. It processes only channels that use mail settings and sends a notification if the import fails.

Interval type. Runs every 5 minutes by default.

SystemMonitor

Collects monitor data. It collects data only when SUPPORT_MONITORING is true. It does not appear in the scheduler list, and its interval cannot be changed.

Interval type. Runs every 5 minutes.

UserTokenClearScheduler

Users can stay logged in even after they close the web browser. ManualWorks uses user tokens for this. This scheduler deletes user tokens older than the stay-logged-in period(30 days by default), so users who do not log in during this period are no longer kept logged in.

This scheduler also does the following.

If the file system that holds the data directory or backup directory is at or above the FILESTORE_USAGE_THRESHOLD value (95% by default), it notifies the administrator.
By default, it deletes monitor data older than 365 days. Change the retention period with the MONITOR_RETENTION_PERIOD setting. Enter 0 to keep the data.
If SUPPORT_CACHE_CLEAR is true, it clears the web cache and document cache.

Fixtime type. Runs at 3:20 a.m. by default.

VectorStoreUpdateScheduler

Rebuilds vector stores that have automatic updates turned on. It runs only when AI is configured and sends a notification if the update fails.

Interval type. Runs every 7 days (10,080 minutes) by default.

VisitClearScheduler

Deletes visit history data.

Fixtime type. Runs at 4:30 a.m. by default.

By default, it deletes visit history data older than 10 years. To change the retention period, enter the following command in the Console.

set-preference -name VISIT_RETENTION_PERIOD -value 365

The value option is in days. If you enter 0, the visit history is not deleted.

This scheduler also does the following.

It moves the last 5 days of visit history in the database to files in the visit directory of the data directory. If the visit history retention period is 0, it does not move them.
By default, it deletes AI logs older than 90 days. Change the retention period with the AI_LOG_RETENTION_PERIOD setting. Enter 0 to keep the logs.
It cleans up visual page revisions. For visual pages, it keeps the 10 most recent revisions and deletes revisions older than 5 days. For groups, it keeps only the most recent revision.

If visit history stays in the database for more than 30 days, ManualWorks notifies the administrator when the server starts.