SObject Purge Framework

This framework allows users to configure some data purge operations.

Disclaimer

SObject Purge Framework is not an official Salesforce product, it has not been officially tested or documented by Salesforce.

How Do You Configure SObject Purge Framework ?

The configuration is based on two components:

The delete logic.
The custom metadata records.

Delete logic

The logic can be configured in different places, depending on the use case:

By default, in a checkbox (formula) field named "ToBeDeleted__c" on the object to purge.
A custom WHERE Clause to define which record should be deleted. (WhereClauseToBeDeleted__c field) Warning If you choose this option, be sure that your query is selective
A boolean field on a related object to insert in the CMDT field ExternalToBeDeletedField__c. If this field is not empty, this option will be chosen.

ie LatestPublishedVersion.ToBeDeleted__c to delete ContentDocument based on ContentVersion field.

Warning If none of the fields (ExternalToBeDeletedField__c and WhereClauseToBeDeleted__c) is set, you must create a checkbox (formula) field named "ToBeDeleted__c" on the object to purge

Custom Metadata Records

PurgeSObjectSetting__mdt : Custom Metadata which contains the SObjects to purge and the sequence to address the deletion. The repo contains a custom metadata on Lead to provide an example, you don't have to deploy it.

Sequence__c : Allow user to set the execution order for the purge, useful if we have to delete child objects before the main one.
ExternalToBeDeletedField__c : Allow user to reference a field which contains delete logic on a related object.
PublishPlatformEventOk__c : if checked, a platform event will be published on success.
PublishPlatformEventKo__c : if checked, a platform event will be published on failure.
PlatformEventExternalId__c : Field API name of the record external id.

Platform event example

{
  "data": {
    "schema": "PYnPMKjl73Qx3gYURNrang",
    "payload": {
      "CreatedById": "0057a00000CsmbuAAB",
      "Success__c": true,
      "Message__c": null,
      "CreatedDate": "2022-10-14T07:13:03.051Z",
      "SObject__c": "Account",
      "ExternalId__c": "37",
      "Id__c": "0017a00002556lhAAA"
    },
    "event": {
      "EventUuid": "3e74df29-9a31-4463-8639-f460e5dd9cff",
      "replayId": 2682310,
      "EventApiName": "PurgeSObjectBatch__e"
    }
  },
  "channel": "/event/PurgeSObjectBatch__e"
}

To add a new SObject to the list

Create a Boolean formula field named ToBeDeleted__c and define the criteria to purge the SObject. If your criteria are too complex to be addressed by a formula, you can create a boolean field and handle the logic in a flow or an apex trigger.
Create a new custom metadata in PurgeSObjectSettings by entering the SObject API Name and the sequence to purge the object.

Particular Use Cases

For some particular SObjects, ContentDocument for example, you can't create custom field on it.

You can use a field from another object since this field is referenced in the object.

For our use case, we referenced the ContentVersion's field from the ContentDocument to handle the deletion: LatestPublishedVersion.ToBeDeleted__c

How To Run SObject Purge Framework ?

Schedule the PurgeSObjectBatchSchedulable class
- Apex Classes > 'Schedule Apex' button > Enter PurgeSObjectBatchSchedulable
With CRON schedule:

//CRON to scheduled batch run at 1 AM, on the 1st February.
String sch = '0 0 1 1 2 ?';
String jobId = System.schedule('TestSchedule', sch , new PurgeSObjectBatchSchedulable());

Test Class

The framework contains a test class (PurgeSObjectBatch_Test) which must be adapted to your implementation. Currently it show how to test the deletion on Lead but it should reflect your custom metadata configuration.

If you disable the platform event publication in custom metadata, the class PurgeSObjectBatch may miss some coverage. To handle this particular use case, you can override the variable to have this code covered:

PurgeSObjectBatch batch = new PurgeSObjectBatch();
batch.publishPeOk = true;
Database.executeBatch(batch);

Deploy to Salesforce

Checkout the repo and deploy it with sfdx:

sfdx force:source:deploy -p force-app

Use GitHub Salesforce Deploy Tool:

tprouvot/purge-sobject