Revision as of 14:38, 12 December 2014

The WHMCS cron job is the process that performs all the automated actions.

Just 1 single cron job needs to be setup to automate all the core functions of the system (invoicing, reminders, suspensions, etc...)

The cron must be configured to run no more than once per day.

Setting Up Cron Jobs

The tutorials & screenshots below demonstrate how to configure the WHMCS cron on the most common hosting control panels.

You can obtain the exact cron command you need to use for your installation from Setup > Automation Settings at any time.

The examples below will setup the cron to run at 9am every day.

cPanel

Click on the Cron Job icon in cPanel, select the Once A Day option from the Common Settings dropdown menu. Then paste the cron command into the Command field.

Alternatively click the Advanced (Unix Style) button and use the following:

Direct Admin

The command for Direct Admin is generally the same as cPanel, however, you need to reference the full path to the php binary.

This can be /usr/bin/php, /usr/bin/home/php or /usr/local/bin/php but this is dependent on the server setup and you should check with your Server Administrator for the full path to the php binary.

An example command to run is:

DotNetPanel

Navigate to the hosting space in which WHMCS is installed and click Scheduled Tasks from the Hosting Space Menu, then click Add Scheduled Task.

From the Task Type dropdown menu select the Check Web Site Availability option and enter the URL of the cron.php file into the URL field. Use the Schedule options to run this task Daily and finally ensure it's active and running.

Windows Server

Depending on your server setup, you can run the cron directly from the php executable. If this is not possible, you would need to use the server browser to run the cron

An example command to run is:

You should then set the task to run at a certain time every day. The time is up to you.

Plesk

You can specify the php command using the following on Linux Plesk:

env php -q /home/user/whmcs/admin/cron.php

The Windows version of Plesk is slightly different. You need to specify the path to the php executable and then specify the path to your cron.php file.

Check the appropriate boxes to run at the time you wish and press ok to save.

Helm

InterWorx

Option Flags

Passing in option flags to the cron process allows you to customise the actions that get performed. By default, all actions will run but you can pass in any of the flags below to skip or only do certain processes.

In WHMCS 5.2, the option flags were expanded to include do options for when you only wish to run a specific action or two as the cron runs.

Flags

• affcommissions
• affreports - First day of the month only
• backups
• cancelrequests
• ccexpirynotices
• ccprocessing
• clientstatussync
• closetickets
• domainrenewalnotices
• emailmarketing
• fixedtermterminations
• invoicereminders
• invoices
• latefees
• overagesbilling - Runs on the last day of the month only.
• suspensions
• terminations
• updatepricing
• updaterates
• usagestats
• skip_report

How to use Option Flags

Flags are passed in by simply appending them to the cron command. All the flags can be preceded with do_ or skip_. When running with do_, the cron will only complete the actions listed, everything else will be skipped. When using skip_, WHMCS will run all other commands except those defined.

Skipping Actions

For example to not run CC processing you could use "php -q /home/username/public_html/admin/cron.php skip_ccprocessing" or alternatively as a browser request, like this "get http://www.yourdomain.com/admin/cron.php?skip_ccprocessing=1"

To skip multiple items the following format can be used "php -q /home/username/public_html/admin/cron.php skip_ccprocessing skip_usagestats" or alternatively "get http://www.yourdomain.com/admin/cron.php?skip_ccprocessing=1&skip_usagestats=1"

Doing Specific Actions

In some instances, it is easier to define the actions you wish to complete rather than those you do not. For example, if you wished to take a backup of your database more regularly than once per day, you could schedule the command "php -q /home/username/public_html/admin/cron.php do_backups" or alternatively as a browser request, like this "get http://www.yourdomain.com/admin/cron.php?do_backups=1"

In this way, you can also complete actions separately that you may have skipped with a separate cron. Perhaps you want to separate when your CC processing and usage information updates are completed. To do multiple items, the following format is used "php -q /home/username/public_html/admin/cron.php do_ccprocessing do_usagestats" or alternatively "get http://www.yourdomain.com/admin/cron.php?do_ccprocessing=1&do_usagestats=1"