Latest revision as of 13:55, 24 April 2024

You must create cron tasks in order to automate tasks within WHMCS.

The cron is a system daemon used to execute tasks at designated times. WHMCS includes processes that must run on a periodic basis via the cron. All of these files are in the crons directory.

Setting up the Cron Tasks

System Cron

The system cron automates tasks within WHMCS. Configure this to use the appropriate frequencies:

Sample Cron Command

*/5 * * * * php -q /home/username/crons/cron.php

You can find the correct command to copy-and-paste for your WHMCS installation by navigating to Configuration () > System Settings > Automation Settings and clicking on the first badge. Prior to WHMCS 8.0, visit Setup > Automation Settings.

Domain Sync Cron

This cron task monitors incoming domain transfers and synchronises expiry date changes made directly at a registrar. We only recommend running this every few days. More information is available at Domain Sync Enabled and Domain Synchronisation.

Sample Cron Command

0 3 */2 * * php -q /home/username/crons/domainsync.php

The above example will run at 3 a.m. every two days.

POP Email Import Cron

This cron task is only required if you wish to import emails to the support queue via the POP3 protocol. (We recommend using Email Piping instead.) If you use this, configure it to run every five minutes.

Sample Cron Command

*/5 * * * * php -q /home/username/crons/pop.php

The above example will run the POP3 email import task every five minutes.

Change of Daily Cron Hour

You can change the time at which the daily automated actions run using the Time of Day setting. For more information, see Automation Settings.

WHMCS uses the PHP now() timestamp when the cron.php script runs. This determines the current Time of Day based on the value that the PHP configuration returns applied to the cron.php execution.

We recommend executing the cron task every 5 minutes. WHMCS will never perform a particular task more frequently than they are listed here. You can set the cron.php file to run every 5 minutes without any duplication.

If you only want to execute cron.php at the "Time of Day" hour, ensure that WHMCS's configured time zone matches the server's time zone. For more information, see Changing_Timezone.

Secure The crons Directory

You can move the crons folder to any location above or below the document root.

For more information, see Moving the Crons Directory.

System Cron

The system cron (crons/cron.php) automates tasks within WHMCS. This script can run with several optional values. This allows very specific control of the tasks that run and the script's output. Most WHMCS installations only require an entry that invokes the system cron script (crons/cron.php).

Input

The system cron script has the following argument input structure:

cron.php [<argument> [options]]

The script also provides backwards capability for input options available prior to WHMCS 7.1:

cron.php [legacy_option_flags]

Mixing legacy option flags with the current argument structure is not supported and will not work.

Arguments

The cron.php script includes three essential arguments:

• all — Attempt to perform all due automation tasks. If you do not provide input, this argument is applied by default.
• skip — Perform all tasks (in the same way as the all argument) but exclude tasks that you specify.
• do — Only perform the tasks that you specify.

There are two supporting arguments:

• help — Lists help and options for the argument you specify.
• list — Lists all possible arguments.

Options

Each argument has its own set of options, which you can view using help <argument>.

Additional Options

• -F, --force
  • Force the execution of tasks, regardless of "due" or "in progress" state
• -v, -vv, -vvv
  • Verbosity of command line output
• --email-report=[1|0]
  • Force send a digest report of work performed during execution. During the normal "daily" run, this is set to an implicit value of "1". In all other cases, the implicit value is "0"
• -V, --version
  • Output the WHMCS version and exits
• --no-ansi
  • Strip any non-printing command line markup (used for color output)
• -h, --help
  • Print help for a command; same as the help command itself

Output

The System Cron will not generate any success console output by default. Use the verbosity options if you require progressive completion information while attending the manual execution of System Cron invocation.

The System Cron will, by default, generate a Digest Email Report when performing the "Daily" group of tasks. This report can be forcibly generated for any particular invocation with the --email-report=1 report. The Digest Email Report will only contain information related to that execution and will not contain aggregate information from prior executions. Please visit the Automation Status page in your Admin area to get an overview of daily aggregated work.

Tasks

All routines of system cron (cron.php) are tasks. Most tasks are daily, and should only be run once a day. Some tasks benefit from running multiple times a day, such as ticket escalations or checking for WHMCS Updates. Other tasks should only run once a month, such as calculating overage usage and generating the respective invoices.

Task Options for skip and do

When performing a skip or do command, you can itemize which tasks are excluded or included respectively. Below is a table that itemizes these task options, as well as their normal frequency.

Types

There are two types of tasks:

• Application: Advances state of client data, such as orders, billing, and provisioning
• System: Provides software related functionality, such as generating backups or performing database normalization.
  • The "DatabaseBackup" task is the only task option of the System type which can be included/excluded from execution. All other System type task options will be performed explicitly as required by WHMCS and thus do not have option flags.

Tasks & --force Option

The "--force" option does exactly that...it will force execute any application tasks (respective of the command [all, skip, do]) regardless if the task is suppose to run once a day, a month, or at a time other than now.

• The all command with the "--force" flag will execute all application tasks, as if each one were due exactly now.
• The skip command with the "--force" will first exclude the specified tasks (i.e., the ones provided as task option flags) and then operate on all other tasks as if each were due exactly now, similar to the all command.
• The do command is designed to only run the tasks specified (i.e., the ones provided as task option flags) and to run them immediately, thus the "--force" option is always implied and is not a valid option.
• The "--force" option has no effect on System type tasks (except "DatabaseBackup")
• The "--force" option has no effect on whether the Daily Digest Email Report is sent, that is controlled via the --email-report option.

Advanced Task Scheduling

In some environments or use-cases, having fine-grained control of one or more tasks is important. This is possible through a combination of multiple do and skip crontab entries. Tasks performed as part of a do command will not have their internal scheduling tracking modified. This is to ensure the integrity of a normal invocation of the System Cron. If you want a particular task to only execute on a particular schedule, create a do command for that task and alter your main System Cron invocation to skip that task (all other non-itemized tasks will be performed on the WHMCS schedule in this skip). Likewise, if you never wish to have a particular task executed, alter your System Cron entry to be a skip command with the option for that particular task.

Hook Points

The System Cron has six hook events:

• PreCronJob
  • Fires only during the daily cron run
  • Is invoked before any tasks are executed
  • Registered hooks receive no parameter arguments
• PreAutomationTask
  • Is invoked before each Application task
  • Registered hooks receive one parameter argument:
    • The task object that is about to be executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
    • The return value of this hook is not inspected. However, if an exception is thrown, the task will not be executed, be marked as incomplete, and iteration to the next task will commence
• PostAutomationTask
  • Is invoked after each Application task
  • Registered hooks receive two parameter arguments:
    • The task object that was just executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
    • The boolean state if the task executed without throwing an Exception
    • The return value of this hook is not inspected. Any Exception thrown will be discarded
• DailyCronJobEmail
  • Fires during the daily cron run or when --email-report=1 is specified
  • Is invoked after all Application tasks are executed, immediate prior to the DailyCronJob hook
  • If a registered hook returns true, the digest email report will not be sent
  • Registered hooks receive no parameter arguments
• DailyCronJob
  • Fires only during the daily cron run
  • Is invoked after all Application tasks are executed, immediate proceeding the DailyCronJobEmail hook
  • Register hooks receive no parameter arguments
• AfterCronJob
  • Fires each time cron is invoked
  • Is invoked after all Application & System tasks are executed, just prior to script termination
  • Registered hooks receive no parameter arguments

Example Crontab Entries

Below are examples that demonstrate the flexibility of the System Cron input options and how you could craft your crontab entry. For most WHMCS installation, you should just have one entry (Ex. 1). If you wish to disable certain tasks entirely, consider looking at the related functionality's documentation first to understand how your may be able optimize your WHMCS settings from the administration area and potential avoid unnecessary crontab entries.

Ex 1. Standard System Cron entry:

*/5 * * * * php -q /path/to/cron.php

Ex 2. Explicit entry to perform all scheduled task if they are due (will behave the same as Ex. 1):

*/5 * * * * php -q /path/to/cron.php all

Ex 3. Always skip sending domain renewal notices, but perform all other tasks as normal if they are due:

*/5 * * * * php -q /path/to/cron.php skip --DomainRenewalNotices

Ex 4. Always skip ticket escalations and auto suspensions. Process ticket escalations Monday-Friday during business hours, at the top of the hour, and auto suspension Monday-Friday at the start of business:

*/5 * * * * php -q /path/to/cron.php skip --TicketEscalations --AutoSuspensions
0 9,10,11,12,13,14,15,16 * * 1-5 php -q /path/to/cron.php do --TicketEscalations
0 9 * * 1-5 php -q /path/to/cron.php do --AutoSuspensions

Ex 5. In some hosting environments, direct crontab entries are not permitted. The System Cron can be invoked through an HTTP request (provided the script is accessible within the docroot) The follow demonstrates performing all tasks except DomainRenewalNotices and TicketEscalations

GET http://www.example.com/admin/cron.php?command=skip&options=DomainRenewalNotices,TicketEscalations

Legacy Cron File Locations

Prior to WHMCS version 6, the automated task files were located across various directories. From WHMCS version 6 onwards all cron files are now located in the crons directory by default.

To aide in the transition process to their new locations, version 6.0 of WHMCS includes proxy files in the old locations that will allow all existing configured cron and piping commands to continue operating without any changes post-upgrade to 6.0.

However, we encourage you to update your cron and piping commands to use the new locations prior to updating to Version 8.0.

The old locations are deprecated as of Version 6.0, and the proxy functionality is removed as of version 8.0. The proxy files and their proxy locations are:

• /admin/cron.php
• /pipe/pipe.php
• /pipe/pop.php