Difference between revisions of "Data Retention Policy Automation"

From WHMCS Documentation

(Automatically Delete Inactive Clients)
 
Line 1: Line 1:
<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above</div>
+
#REDIRECT [[Automation_Settings#Data_Retention_Settings]]
 
 
__TOC__
 
 
 
The length of time you must keep data for is often governed by the laws and regulations of your local jurisdiction.  One thing most jurisdictions share in common however is that you should only keep personal data for as long as is necessary.
 
 
 
The Data Retention Policy Automation introduced in WHMCS 7.5 allows you to have WHMCS automatically enforce your data retention policy in relation to the length of time you keep your client records for.
 
 
 
==Data Retention Settings==
 
 
The data retention settings are in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' ('''Setup > Automation Settings''' in WHMCS 7.10 and earlier).
 
 
<onlyinclude>
 
===Automatically Delete Inactive Clients===
 
 
<div class="docs-alert-danger">
 
<span class="title">Paid Invoices and Transactions</span><br />
 
The presence of paid invoices or transactions within the specified period determines whether WHMCS retains client records. If you enable this feature, WHMCS will immediately delete clients who are in the ''Inactive'' or ''Closed'' statuses and have no invoice or transaction history.
 
</div>
 
 
 
This setting causes the system to perform the '''Data Retention Pruning''' task each day. This will delete client records that meet the following criteria:
 
 
 
* A status of [[Automation_Settings#Client_Status_Update|'''Inactive''' or '''Closed''']].
 
* No paid invoices within the specified number of months.
 
* No entered or applied transactions within the specified number of months.
 
* If the client is an affiliate, a commission balance of <tt>0</tt> or no referrals within the specified retention period. <div class="docs-alert-info"><span class="title">Client Status Update</span><br />The system can automatically change the client status. Use the '''[[Automation_Settings#Client_Status_Update|Client Status Update]]''' setting to control this.</div>
 
 
 
To enable this setting, select '''After no invoice payment has occurred for the inactive or closed client in the following number of months''' and specify a number of months that is greater than <tt>0</tt>. This setting is disabled by default.
 
 
<div class="docs-alert-info">
 
<span class="title">WHMCS 8.3 and earlier</span><br />
 
In WHMCS 8.3 and earlier, this was the '''After no invoice or transaction activity has occurred for the following number of months''' setting.
 
</div>
 
 
Optionally, you can set '''Delete associated users if the user(s) are not associated with any other client account.''' to '''YES''' to cause the '''Data Retention Pruning''' task to also delete users who are only associated with this client.
 
 
 
</onlyinclude>
 

Latest revision as of 19:18, 7 February 2022