Crons - Revision history

SarahK: /* Task Options for skip and do */

2024-04-24T13:55:58Z

‎Task Options for skip and do

Show changes

SarahK at 21:15, 8 February 2023

2023-02-08T21:15:03Z

PeterM: /* Task Options for skip and do */

2022-07-13T10:09:19Z

‎Task Options for skip and do

SarahK at 16:35, 21 April 2022

2022-04-21T16:35:36Z

SarahK: /* Task Options for skip and do */

2022-04-20T16:28:41Z

‎Task Options for skip and do

PeterM: /* System Cron */

2022-04-13T14:48:49Z

‎System Cron

SarahK: /* Troubleshooting */

2022-01-20T21:50:36Z

‎Troubleshooting

SarahK at 19:26, 18 January 2022

2022-01-18T19:26:45Z

AlexN: /* Tasks & --force Option */

2021-09-15T08:28:27Z

‎Tasks & --force Option

SarahK: /* Domain Sync Cron */

2021-07-22T20:56:01Z

‎Domain Sync Cron

@@ Line 69: / Line 69: @@
 <div class="docs-alert-warning">We recommend moving it to a private directory above your document root. This helps to prevent access by bad actors.</div>
-For more information, see [[Custom Crons Directory]].
+For more information, see [https://help.whmcs.com/m/installation/l/1650302-moving-the-crons-directory Moving the Crons Directory].
 ==System Cron==

@@ Line 308: / Line 308: @@
 | --EmailCampaigns
 | n/a
-| Update the status of Email Campaigns and schedule emails. Batches of 25
+| Update the status of Email Campaigns and schedule emails. Batches of 50
 | As soon as every 5 minutes
 |-

@@ Line 22: / Line 22: @@
 </source>
-You can find the correct command to copy-and-paste for your WHMCS installation by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' and clicking on the first badge. Prior to WHMCS 8.0, visit '''Setup > Automation Settings'''.
+You can find the correct command to copy-and-paste for your WHMCS installation by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' and clicking on the first badge. Prior to WHMCS 8.0, visit '''Setup > Automation Settings'''.
 [[File:Cron-configuration-badge.png|border]]
@@ Line 53: / Line 53: @@
 ===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]].
+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 <tt>now()</tt> timestamp when the <tt>cron.php</tt> script runs. This determines the current '''Time of Day''' based on the value that the PHP configuration returns applied to the <tt>cron.php</tt> execution.
@@ Line 83: / Line 83: @@
 </source>
-The script also provides backwards capability for input options available prior to WHMCS v7.1:
+The script also provides backwards capability for input options available prior to WHMCS 7.1:
 <source lang="cli">
@@ Line 293: / Line 293: @@
 | --ServerUsageCount
 | n/a
-| Auto Update Server Usage Count. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
+| Auto Update Server Usage Count. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
 | Hourly
 |-
 | --ServerRemoteMetaData
 | n/a
-| Auto Update Server Meta Data. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
+| Auto Update Server Meta Data. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
 | Hourly
 |-

@@ Line 134: / Line 134: @@
 ====Task Options for '''skip''' and '''do'''====
-−
 <div id="Option_Flags" style="visibility: hidden"></div>
 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.
-−
 {| class="table"
 |-
@@ Line 189: / Line 189: @@
 | n/a
 | Processing Domain Transfer Syncing for Pending Transfer domains
 | As soon as every hour
 |-
 | --CancellationRequests
@@ Line 242: / Line 242: @@
 |-
 | --SslSync
 | n/a
 | Check validity of SSL Certificates on services and domains. Batches of 100. v7.7+
 | Daily
@@ Line 282: / Line 282: @@
 |-
 | --DataRetentionPruning
 | n/a
 | Process data retention pruning operation. v7.5+
 | Daily
 |-
 | --ServerUsageCount
 | n/a
 | Auto Update Server Usage Count. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
 | Hourly
 |-
 | --ServerRemoteMetaData
 | n/a
 | Auto Update Server Meta Data. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
 | Hourly
 |-
 | --TenantUsageMetrics
 | n/a
 | Auto Update Service Usage Data. Displayed when viewing Service within Client Area. v7.9+
 | Twice-daily
 |-
 | --EmailCampaigns
 | n/a
 | Update the status of Email Campaigns and schedule emails. Batches of 25
 | As soon as every 5 minutes
 |-
 | --ProcessEmailQueue
 | n/a
 | Process scheduled emails within Email Campaigns. Batches of 25
 | As soon as every 5 minutes

@@ Line 22: / Line 22: @@
 </source>
-You can find the correct command to copy-and-paste for your WHMCS installation by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0,  '''Setup > Automation Settings'''. Then, copy the command using the copy button on the field.
+You can find the correct command to copy-and-paste for your WHMCS installation by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' and clicking on the first badge. Prior to WHMCS 8.0, visit '''Setup > Automation Settings'''.
 <div class="docs-alert-success">Most hosting control panels provide a simple user interface for creating cron jobs. For more information, see [[Cron Configuration]].</div>

← Older revision		Revision as of 21:50, 20 January 2022
Line 423:		Line 423:

	<div class="docs-alert-info">If you do not require these proxy files, you can safely remove them from your installation.</div>		<div class="docs-alert-info">If you do not require these proxy files, you can safely remove them from your installation.</div>
−
−	~~==Troubleshooting==~~
−	If you do not receive the daily cron digest email, see a warning on the System Health Status overview page, or on the Automation Status page then this indicates the cron not running. Troubleshooting and resolving this is a matter of priority, as the daily automation tasks are an integral part of WHMCS.
−
−	~~The most common issues and how to resolve them can be found on the [[Cron Job Issues]] page.~~
−
−	~~Detailed steps on how to debug the cron execution can be found in our [https://help.whmcs.com/m/automation/l/683269-advanced-cron-troubleshooting\| Advanced Cron Troubleshooting] Guide.~~
−
−	~~Further useful troubleshooting documentation can be found [https://help.whmcs.com/m/automation/c/195647 here.]~~

@@ Line 405: / Line 405: @@
 <source lang="cli">
-GET http://www.yourdomain.com/admin/cron.php?command=skip&options=DomainRenewalNotices,TicketEscalations
+GET http://www.example.com/admin/cron.php?command=skip&options=DomainRenewalNotices,TicketEscalations
 </source>

@@ Line 327: / Line 327: @@
 * 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====

@@ Line 29: / Line 29: @@
 <div class="docs-alert-warning"><i class="fa fa-question-circle"></i>This cron task is only required in WHMCS 7.5 and earlier. Remove it in WHMCS 7.6 and later.</div>
-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 [[Domains_Tab#Domain_Sync_Enabled Domain Sync Enabled]] and [[Domain Synchronisation]].
+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 [[Domains_Tab#Domain_Sync_Enabled|Domain Sync Enabled]] and [[Domain Synchronisation]].
 '''Sample Cron Command'''