Change the Nightly Maintenance schedule times

You can change the time that PaperCut will perform it’s nightly maintenance by using the Config Editor. By default these run at 12:55am (the Config Key setting is schedule.daily-maintenence=0 55 0 * * ?).

Prior to version 11.2 the daily maintenance tasks were run at 1:15am. This was changed to avoid issues around daylight savings change overs, which could result in the job not being run.

A number of different scheduled tasks run during the nightly maintenance, principally a synchronisation to add new PaperCut users and groups against your defined synchronisation source.

Format

The format of the value is a string comprised of 6 fields separated by white space. The format is similar to the “cron” format which is a job scheduler used in Linux & Unix. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:

Field NameMandatoryAllowed Values
-YES0
MinutesYES0–59
HoursYES0–23
Day of monthYES1–31 ? or *
MonthYES1–12 or JAN-DEC or ? or *
Day of weekYES1–7 or SUN-SAT or ?

for example: 0 15 1 * * ?


The question mark (?) can be considered to be the same as saying “any”.
For example; if I want my maintenance to run on a particular day of the month (say, the 28th), but I don’t care what day of the week that happens to be, I would put “28” in the day-of-month field, and “?” in the day-of-week field.

The asterix (*) can be considered to be the same as saying “every”.
For example; if I want my maintenance to run on a particular day of the month (say, the 28th), but I want it to run every month, I would put “28” in the day-of-month field, and “*” in the Month field.

From the example above we have:- 0 0 3 28 * ?
Which means… Run at 3AM - on the 28th day of the month - every month - on any day of the week.

Others examples:

0 15 1 * * ? - Daily 1:15AM
0  0 4 * * ? - Daily 4:00AM
0  0 2 ? * 1 - Sunday 2:00AM

Other Config Keys which uses the cron time format are:

schedule.hourly - Responsible for the timing of the external Shared Account synchronisation and Refund Request Emails.
schedule.daily - Responsible for the timing of the daily Quota Allocation task.
schedule.weekly - Responsible for the timing of the weekly Quota Allocation task & weekly Database Backup.
schedule.monthly - Responsible for the timing of the monthly Quota Allocation task.

Making changes

To make this change perform the following steps:

  1. Log into the PaperCut administration interface.
  2. Navigate to Options → Config editor (advanced).
  3. Search for the key schedule.daily-maintenence.
  4. Change the Value as required.
  5. Press Update.
  6. For the change to take effect, restart the PaperCut Application Server.

keywords: MON-FRI, cron, schedule, changing schedule, 0 30 10 ? * MON-FRI, 0 20 0 ? * 1, 0 30 0 1 * ?, 0 0 * * * ?, 0 55 0 * * ?, 0 10 0 * * ?, change Scheduled reports delivery times, nightly sync, maintenance window, user sync time, 12.55am, synchronisation, nightly maintenance, maintenence


Categories: How-to Articles, Administration


Comments