Difference between revisions of "Automation Status"

From WHMCS Documentation

(→‎Cron Detail)
(→‎Available Information)
 
(12 intermediate revisions by 5 users not shown)
Line 2: Line 2:
  
 
The Automation Status page gives you insights and information about the daily automation activity that occurs in WHMCS.  It provides a way of viewing and monitoring automation activity over time, allowing you to see trends and identify any issues more easily.
 
The Automation Status page gives you insights and information about the daily automation activity that occurs in WHMCS.  It provides a way of viewing and monitoring automation activity over time, allowing you to see trends and identify any issues more easily.
 +
 +
You can access this feature at '''Utilities > Automation Status''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
 +
 +
You can also access it by clicking any summary graph shown in the '''Automation Overview widget''' on the [[Admin Dashboard|admin dashboard]] or, in WHMCS 8.0 and later, by clicking the cog (<i class="fa fa-cogs" aria-hidden="true"></i>) icon at the top of the [[Admin Area]].
  
 
==How to use it==
 
==How to use it==
  
−
To view the automation status, click any summary graph shown in the Automation Overview widget on the admin dashboard. Or alternatively navigate to ''Utilities > System > Automation Status''.
+
This page displays a summary of invoice generation activity for the last 7 days and the results and totals from the current day's automation tasks.
  
−
Upon first visiting the Automation Status page, you will be shown a summary of invoice generation activity for the last 7 days, and the results and totals from the current day's automation tasks.
+
You can browse to earlier days by using the arrow keys or selecting a date from the calendar.
−
 
 
−
You can browse to earlier days by using the arrow keys, or selecting a date from the calendar.
 
  
 
[[File:AutomationStatusPage.png]]
 
[[File:AutomationStatusPage.png]]
  
−
<div class="docs-alert-info">Be aware that historic automation activity information will only start being recorded from the day you upgrade to WHMCS 7.1 or later</div>
+
<div class="docs-alert-info">
 +
Historic automation activity information will only start being recorded from the day you upgrade to WHMCS 7.1 or later.
 +
</div>
  
 
==Available Information==
 
==Available Information==
 +
 
The page details items completed by a cron run for the selected date:
 
The page details items completed by a cron run for the selected date:
−
* '''Invoices''' - The count of invoices generated.
+
−
* '''Late Fees''' - The count of late fees applied to invoices.
+
* '''Invoices''' — The total number of invoices generated.
−
* '''Credit Cards''' - The count of successful and declined credit card attempts.
+
* '''Late Fees''' — The total number of late fees applied to invoices.
−
* '''Invoice & Overdue Reminders''' - The count of any invoice and overdue reminders sent.
+
* '''Credit Cards''' — The total number of successful and declined credit card attempts.
−
* '''Cancellation Requests''' - The count of any processed cancellation requests. This also details the failed requests.
+
* '''Invoice & Overdue Reminders''' — The total number of any invoice and overdue reminders sent.
−
* '''Overdue Suspensions''' - The count of successful and failed suspensions.
+
* '''Cancellation Requests''' — The total number of any processed cancellation requests. This also details the failed requests.
−
* '''Overdue Terminations''' - The count of successful and failed terminations.
+
* '''Overdue Suspensions''' — The total number of successful and failed suspensions.
−
* '''Fixed Term Terminations''' - The count of terminations defined by a product configuration.
+
* '''Overdue Terminations''' — The total number of successful and failed terminations.
−
* '''Domain Renewal Notices''' - The count of any domain renewal emails sent.
+
* '''Fixed Term Terminations''' — The total number of terminations defined by a product configuration.
−
* '''Inactive Tickets''' - The count of inactive tickets closed.
+
* '''Overdue Invoice Cancellation''' — The total number of overdue unpaid invoices that the system cancelled.
−
* '''Delayed Affiliate Commissions''' - The count of commissions applied.
+
* '''Domain Renewal Notices''' — The total number of any domain renewal emails sent.
−
* '''Email Marketer Rules''' - The count of emails sent for the marketer.
+
* '''Inactive Tickets''' — The total number of inactive tickets closed.
−
* '''Database Backup''' - Was the last database backup setup.
+
* '''Delayed Affiliate Commissions''' — The total number of commissions applied.
−
* '''WHMCS Updates''' - Was the check for Updates successful?
+
* '''Email Marketer Rules''' — The total number of emails sent for the marketer.
−
* '''Currency Exchange Rates''' - Was the currency exchange rate update successful?
+
* '''Database Backup''' — Whether the system set up the database backup.
−
* '''Product Pricing Updates''' - Was the update of product pricing successful?
+
* '''WHMCS Updates''' — Whether checking for updates was successful.
−
* '''Server Usage Stats''' - Did the usage information update?
+
* '''Currency Exchange Rates''' — Whether the currency exchange rate updated successfully.
 +
* '''Product Pricing Updates''' — Whether product pricing updated successfully.
 +
* '''Server Usage Stats''' — Whether the usage information updated successfully.
  
 
==Failed Actions==
 
==Failed Actions==
 +
 
If you see a number marked as failed items, this indicates some items failed to complete successfully.
 
If you see a number marked as failed items, this indicates some items failed to complete successfully.
  
−
In the case of credit card captures declining, these will be retried automatically based upon your settings defined in ''Setup > Automation Settings''.
+
In the case of credit card captures declining, these will be retried automatically based upon your settings defined in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
  
 
For failure items relating to Suspensions, Terminations, Cancellations, etc..., these will be retried daily until successful.  They will also be added to the Module Queue from where you can view and resolve them. See the [[Module Queue]] page for more information.
 
For failure items relating to Suspensions, Terminations, Cancellations, etc..., these will be retried daily until successful.  They will also be added to the Module Queue from where you can view and resolve them. See the [[Module Queue]] page for more information.
  
 
==Historic Data and Trends==
 
==Historic Data and Trends==
 +
 
The graph allows you to view a number of the task metrics over time.
 
The graph allows you to view a number of the task metrics over time.
  
Line 51: Line 60:
 
[[File:automation-status-graph-new.png|600px]]
 
[[File:automation-status-graph-new.png|600px]]
  
−
==Cron Detail==
+
== Cron Task Reporting ==
−
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This section describes features available in version 7.10 and above</div>
+
 
 +
<div class="docs-alert-info">
 +
This section describes features available in version 7.10 and above.
 +
</div>
  
 
From the first daily cron run after upgrading to WHMCS 7.10, detailed information about actions completed will be saved and available in WHMCS.
 
From the first daily cron run after upgrading to WHMCS 7.10, detailed information about actions completed will be saved and available in WHMCS.
  
 
From the Automation Status Page clicking on the Cron Task boxes will open a modal that will detail the actions that completed successfully or failed with a link to the appropriate location in WHMCS.
 
From the Automation Status Page clicking on the Cron Task boxes will open a modal that will detail the actions that completed successfully or failed with a link to the appropriate location in WHMCS.
 +
 +
[[File:CronTaskAutomationModal.png]]
  
 
The following table lists the cron tasks that have additional detail:
 
The following table lists the cron tasks that have additional detail:
Line 68: Line 82:
 
| Invoices  
 
| Invoices  
 
|| A list of invoices generated via the cron run  
 
|| A list of invoices generated via the cron run  
−
|| To Invoice using ID and Edit icon  
+
||  
−
To client using client name  
+
*To Invoice using ID and Edit icon  
 +
*To client using client name  
 
|| The invoice status is the current invoice status
 
|| The invoice status is the current invoice status
 
|-
 
|-
 
| Invoice & Overdue Reminders  
 
| Invoice & Overdue Reminders  
 
|| A list of reminders sent separated by type  
 
|| A list of reminders sent separated by type  
−
|| To Invoice using ID and Edit icon
+
||  
−
To client using client name  
+
*To Invoice using ID and Edit icon
 +
*To client using client name  
 
|| The invoice status is the current invoice status
 
|| The invoice status is the current invoice status
 
|-
 
|-
 
| Late Fees  
 
| Late Fees  
 
|| A list of invoices that had a late fee added  
 
|| A list of invoices that had a late fee added  
−
|| To Invoice using ID and Edit icon
+
||  
−
To client using client name  
+
*To Invoice using ID and Edit icon
 +
*To client using client name  
 
|| The invoice status is the current invoice status
 
|| The invoice status is the current invoice status
 
|-
 
|-
 
| Credit Card Charges  
 
| Credit Card Charges  
 
|| A list of attempted payments whether successful or failed  
 
|| A list of attempted payments whether successful or failed  
−
|| To Invoice using ID and Edit icon
+
||  
−
To client using client name  
+
*To Invoice using ID and Edit icon
 +
*To client using client name  
 
|| The invoice status is the current invoice status
 
|| The invoice status is the current invoice status
 
The error message is the latest decline reason
 
The error message is the latest decline reason
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Cancellation Requests
−
|-
+
|| A list of services that had a cancellation request processed separated by success and failure
−
| Value || Value || Value || Value
+
||  
−
|-
+
* To Invoice using ID and Edit icon
−
| Value || Value || Value || Value
+
* To client using client name
 +
* To the [[Module Queue]] for the failed task if unresolved
 +
|| The status is the current status of the service
 +
The error message is message that occurred on cron run.
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Overdue Suspensions
 +
|| A list of suspensions attempted separated by success and failure
 +
||
 +
*To the service/addon using the ID and Edit icon
 +
*To the client using client name
 +
*To the [[Module Queue]] for the failed task if unresolved
 +
||  
 +
*The status is the current status of the service/addon
 +
*The error message is message that occurred on cron run.
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Overdue Terminations
 +
|| A list of terminations attempted separated by success and failure
 +
||
 +
*To the service/addon using the ID and Edit icon
 +
*To the client using client name
 +
*To the [[Module Queue]] for the failed task if unresolved
 +
||  
 +
*The status is the current status of the service/addon
 +
*The error message is message that occurred on cron run.
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Fixed Term Terminations
 +
|| A list of fixed term terminations attempted separated by success and failure
 +
||
 +
*To the service/addon using the ID and Edit icon
 +
*To the client using client name
 +
*To the [[Module Queue]] for the failed task if unresolved
 +
||  
 +
*The status is the current status of the service/addon
 +
*The error message is message that occurred on cron run.
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Domain Renewal Notices
 +
||A list of domains that a renewal notice was sent for. Separated into first to fifth and also lists emails that failed to send
 +
||
 +
* To Domain using ID and Edit icon
 +
* To client using client name
 +
||The status is the current status of the domain
 
|-
 
|-
−
| Value || Value || Value || Value
+
| Inactive Tickets
 +
|| A list of tickets automatically closed due to inactivity
 +
||  
 +
* To Ticket using ID and Edit icon
 +
* To client using client name (if a registered client)
 +
|| The status is the current status of the ticket
 
|-
 
|-
 +
| Client Status Update
 +
|| A list of clients updated separated by status being set
 +
|| To the client using the id, client name, and edit icon
 +
|| The status is the current status of the client
 
|}
 
|}

Latest revision as of 13:55, 24 April 2024

This page describes a feature available in version 7.1 and above

The Automation Status page gives you insights and information about the daily automation activity that occurs in WHMCS. It provides a way of viewing and monitoring automation activity over time, allowing you to see trends and identify any issues more easily.

You can access this feature at Utilities > Automation Status or, prior to WHMCS 8.0, Setup > Automation Settings.

You can also access it by clicking any summary graph shown in the Automation Overview widget on the admin dashboard or, in WHMCS 8.0 and later, by clicking the cog () icon at the top of the Admin Area.

How to use it

This page displays a summary of invoice generation activity for the last 7 days and the results and totals from the current day's automation tasks.

You can browse to earlier days by using the arrow keys or selecting a date from the calendar.

AutomationStatusPage.png

Historic automation activity information will only start being recorded from the day you upgrade to WHMCS 7.1 or later.

Available Information

The page details items completed by a cron run for the selected date:

  • Invoices — The total number of invoices generated.
  • Late Fees — The total number of late fees applied to invoices.
  • Credit Cards — The total number of successful and declined credit card attempts.
  • Invoice & Overdue Reminders — The total number of any invoice and overdue reminders sent.
  • Cancellation Requests — The total number of any processed cancellation requests. This also details the failed requests.
  • Overdue Suspensions — The total number of successful and failed suspensions.
  • Overdue Terminations — The total number of successful and failed terminations.
  • Fixed Term Terminations — The total number of terminations defined by a product configuration.
  • Overdue Invoice Cancellation — The total number of overdue unpaid invoices that the system cancelled.
  • Domain Renewal Notices — The total number of any domain renewal emails sent.
  • Inactive Tickets — The total number of inactive tickets closed.
  • Delayed Affiliate Commissions — The total number of commissions applied.
  • Email Marketer Rules — The total number of emails sent for the marketer.
  • Database Backup — Whether the system set up the database backup.
  • WHMCS Updates — Whether checking for updates was successful.
  • Currency Exchange Rates — Whether the currency exchange rate updated successfully.
  • Product Pricing Updates — Whether product pricing updated successfully.
  • Server Usage Stats — Whether the usage information updated successfully.

Failed Actions

If you see a number marked as failed items, this indicates some items failed to complete successfully.

In the case of credit card captures declining, these will be retried automatically based upon your settings defined in Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > Automation Settings.

For failure items relating to Suspensions, Terminations, Cancellations, etc..., these will be retried daily until successful. They will also be added to the Module Queue from where you can view and resolve them. See the Module Queue page for more information.

Historic Data and Trends

The graph allows you to view a number of the task metrics over time.

By default the current week is displayed showing the number of invoices generated each day. You can choose other metrics and also choose from timeline options including the previous week, this month and last month.

Historic data is purged periodically.

Automation-status-graph-new.png

Cron Task Reporting

This section describes features available in version 7.10 and above.

From the first daily cron run after upgrading to WHMCS 7.10, detailed information about actions completed will be saved and available in WHMCS.

From the Automation Status Page clicking on the Cron Task boxes will open a modal that will detail the actions that completed successfully or failed with a link to the appropriate location in WHMCS.

CronTaskAutomationModal.png

The following table lists the cron tasks that have additional detail:

Task Name Logs Additional Links Notes
Invoices A list of invoices generated via the cron run
  • To Invoice using ID and Edit icon
  • To client using client name
The invoice status is the current invoice status
Invoice & Overdue Reminders A list of reminders sent separated by type
  • To Invoice using ID and Edit icon
  • To client using client name
The invoice status is the current invoice status
Late Fees A list of invoices that had a late fee added
  • To Invoice using ID and Edit icon
  • To client using client name
The invoice status is the current invoice status
Credit Card Charges A list of attempted payments whether successful or failed
  • To Invoice using ID and Edit icon
  • To client using client name
The invoice status is the current invoice status

The error message is the latest decline reason

Cancellation Requests A list of services that had a cancellation request processed separated by success and failure
  • To Invoice using ID and Edit icon
  • To client using client name
  • To the Module Queue for the failed task if unresolved
 The status is the current status of the service

The error message is message that occurred on cron run.

Overdue Suspensions A list of suspensions attempted separated by success and failure
  • To the service/addon using the ID and Edit icon
  • To the client using client name
  • To the Module Queue for the failed task if unresolved
  • The status is the current status of the service/addon
  • The error message is message that occurred on cron run.
Overdue Terminations A list of terminations attempted separated by success and failure
  • To the service/addon using the ID and Edit icon
  • To the client using client name
  • To the Module Queue for the failed task if unresolved
  • The status is the current status of the service/addon
  • The error message is message that occurred on cron run.
Fixed Term Terminations A list of fixed term terminations attempted separated by success and failure
  • To the service/addon using the ID and Edit icon
  • To the client using client name
  • To the Module Queue for the failed task if unresolved
  • The status is the current status of the service/addon
  • The error message is message that occurred on cron run.
Domain Renewal Notices A list of domains that a renewal notice was sent for. Separated into first to fifth and also lists emails that failed to send
  • To Domain using ID and Edit icon
  • To client using client name
 The status is the current status of the domain
Inactive Tickets A list of tickets automatically closed due to inactivity
  • To Ticket using ID and Edit icon
  • To client using client name (if a registered client)
The status is the current status of the ticket
Client Status Update A list of clients updated separated by status being set To the client using the id, client name, and edit icon The status is the current status of the client
Retrieved from "http://3.17.75.209/index.php?title=Automation_Status&oldid=34556"