System Cleanup - Revision history

SarahK at 18:47, 9 May 2022

2022-05-09T18:47:49Z

Lawrence: /* Prune Saved Emails */

2022-05-07T20:31:47Z

‎Prune Saved Emails

Lawrence: /* Prune Saved Emails */

2022-05-07T20:26:36Z

‎Prune Saved Emails

Lawrence: /* Prune Saved Emails */

2022-05-07T20:26:02Z

‎Prune Saved Emails

Lawrence: /* Prune Saved Emails */

2022-05-07T20:25:16Z

‎Prune Saved Emails

Lawrence: /* Prune Saved Emails */

2022-05-07T20:23:14Z

‎Prune Saved Emails

SarahK at 19:56, 5 May 2022

2022-05-05T19:56:48Z

SarahK at 22:44, 14 April 2022

2022-04-14T22:44:45Z

SarahK: Created page with "Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space. You can use this tool at ''..."

2022-01-17T21:41:51Z

Created page with "Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space. You can use this tool at ''..."

New page

Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space.

You can use this tool at '''Utilities > System > System Cleanup'''.

<div class="docs-alert-warning">
Note: 
Only delete information you're certain is not necessary. WHMCS Technical Support '''cannot''' assist with some cases if you have removed the relevant logs.
</div>

== Cleanup Operations ==

You can remove data using the following options:

=== Simple ===

For each option in the '''Simple''' tab, click '''Go''' to empty that log or cache.

The system will immediately remove the data and you will see a '''Cleanup Command Successful''' success message.

====Empty Gateway Log====

This clears out the '''Billing > Gateway Log''' communication between you and your payment gateways. It does not affect transactions and invoices.

====Empty Whois Lookup Log====

Clears out the '''Configuration () > System Logs > WHOIS Lookup Log''' ('''Utilities > Logs > WHOIS Lookup Log''' in WHMCS 7.x and earlier) of the domains that clients have checked.

====Empty Ticket Mail Import Log====

This clears out the '''Configuration () > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) of the record of emails you piped into the WHMCS ticket system. It does not affect tickets themselves.

====Empty Template Cache====

WHMCS caches templates into static files to reduce the loading time of each page. In order for template changes to take effect, it is necessary to clear the cached files using this tool. This removes all existing files from the <tt>templates_c</tt> folder.

Make sure the <tt>/templates_c</tt> directory is writeable so that WHMCS is able to delete the cache files and generate new ones.

===Advanced===

For each option in the '''Advanced''' tab, select a date and click '''Delete'''. The system will delete log entries, emails, or attachments from before that date.

The system will immediately remove the data and you will see a '''Cleanup Command Successful''' success message.

====Prune Client Activity Logs====

Select a date to remove any client entries in '''Configuration () > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) before that date. Non-client-related entries will remain.

====Prune Saved Emails====

Select a date to remove any emails in '''Configuration () > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) before that date.

==== Prune Old Attachments====

Select a date to remove any support ticket attachments from closed tickets which are also older than the date selected. The system will also delete them from the /attachments directory.

==System Cleanup page fails to load==
If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable 'attachments' directory.

You should ensure the attachments directory path configured in Storage Settings exists and is readable. It is also important to ensure the attachments directory path is absolute and not relative to avoid timeout issues on the System Cleanup page.

You can find further details on changing the Storage Settings path in our [[Moving_Storage_Locations]] guide.

@@ Line 43: / Line 43: @@
 ====Prune Client Activity Logs====
-Select a date to remove any client entries in the '''Activity Log''' at  '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' before that date. Non-client-related entries will remain.
+Select a date before which to remove any client entries in the '''Activity Log''' at  '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''. Non-client-related entries will remain.
 ====Prune Saved Emails====
@@ Line 55: / Line 55: @@
 ==System Cleanup page fails to load==
-If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable 'attachments' directory.
+If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable <tt>attachments</tt> directory.
-You should ensure the attachments directory path configured in Storage Settings exists and is readable. It is also important to ensure the attachments directory path is absolute and not relative to avoid timeout issues on the System Cleanup page.
+At '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Storage Settings]]''' or, prior to WHMCS 8.0, '''Setup > Storage Settings''', make certain that the attachments directory path exists, is readable, and is absolute.
-For more information on changing the Storage Settings path, see [[Moving Storage Locations]].
+For more information, see [[Moving Storage Locations]].

@@ Line 47: / Line 47: @@
 ====Prune Saved Emails====
-Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any e-mails from before that date.
+Select a date to remove any e-mails from before that date.
 ==== Prune Old Attachments====

@@ Line 47: / Line 47: @@
 ====Prune Saved Emails====
-Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any client e-mails from before that date.
+Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any e-mails from before that date.
 ==== Prune Old Attachments====

@@ Line 47: / Line 47: @@
 ====Prune Saved Emails====
-Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any e-mails from before that date.
+Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any client e-mails from before that date.
 ==== Prune Old Attachments====

@@ Line 47: / Line 47: @@
 ====Prune Saved Emails====
-Select a date to remove any emails in '''Advanced''' at '''Utilities > System > System Cleanup''' from before that date.
+Select a date under '''Prune Saved Emails''' on the '''Advanced''' tab at '''Utilities > System > System Cleanup''' and click '''Delete''' to remove any e-mails from before that date.
 ==== Prune Old Attachments====

@@ Line 19: / Line 19: @@
 ====Empty Gateway Log====
-This clears out the '''Billing > Gateway Log''' communication between you and your payment gateways. It does not affect transactions and invoices.
+Deletes the contents of the '''Billing > [[Gateway Log]]''' (communication between you and your payment gateways). It does not affect transactions and invoices.
 ====Empty Whois Lookup Log====
-Clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > WHOIS Lookup Log''' ('''Utilities > Logs > WHOIS Lookup Log''' in WHMCS 7.x and earlier) of the domains that clients have checked.
+Deletes the contents of the '''WHOIS Lookup Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' of the domains that clients have checked.
 ====Empty Ticket Mail Import Log====
-This clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) of the record of emails you piped into the WHMCS ticket system. It does not affect tickets themselves.
+Deletes the contents of the '''Ticket Mail Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''. This removes the record of emails you piped into the WHMCS ticket system but does not affect the tickets themselves.
 ====Empty Template Cache====
@@ Line 43: / Line 43: @@
 ====Prune Client Activity Logs====
-Select a date to remove any client entries in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) before that date. Non-client-related entries will remain.
+Select a date to remove any client entries in the '''Activity Log''' at  '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' before that date. Non-client-related entries will remain.
 ====Prune Saved Emails====
-Select a date to remove any emails in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier)  before that date.
+Select a date to remove any emails in '''Ticket Mail Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' from before that date.
 ==== Prune Old Attachments====
@@ Line 54: / Line 54: @@
 ==System Cleanup page fails to load==
 If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable 'attachments' directory.
 You should ensure the attachments directory path configured in Storage Settings exists and is readable. It is also important to ensure the attachments directory path is absolute and not relative to avoid timeout issues on the System Cleanup page.
-You can find further details on changing the Storage Settings path in our [[Moving_Storage_Locations]] guide.
+For more information on changing the Storage Settings path, see [[Moving Storage Locations]].

@@ Line 1: / Line 1: @@
 Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space.
-You can use this tool at '''Utilities > System > System Cleanup'''.
+You can access this feature at '''Utilities > System > System Cleanup'''.
 <div class="docs-alert-warning">
-<span class="title">Note:</span><br />
+Only delete information that you're certain is not necessary. WHMCS Technical Support '''cannot''' assist with some cases if you have removed the relevant log files.
 </div>