DEMO CLEANUP

This package contains a Lightning component and other support to help clean up demos between demo presentations, dry runs, and tests.

Summary

I often find myself in a situation where I need to dust off a demo long after I originally presented it and have forgotten if certain records are required for the demo, were generated during my testing, or were created during the last presentation. This makes getting the demo in a clean state for the next presentation more time-consuming and risky.

This component simply executes a number of demo cleanup tasks based either on criteria specified in a SOQL WHERE clause or through custom Apex or Flow actions.

Installation and Setup

Read the disclaimer below and click on the Install the Package link. This will install all the components, objects, and other metadata to your org.

When installing, select the "Compile only the Apex in the package" option under the Advanced Options.

Assign the Demo Cleanup permission set to anyone who needs to use the component.

Once the package is deployed, you will need to create a Lightning app page with the Lightning App Builder and drag the Demo Cleanup custom component on the page where you would like to place it.

Right after you first install the package and place the component, you will have no demo cleanup tasks:

Click the "Take Me There" button to go to the Demo Cleanup Tasks tab, click the New button and choose which kind of cleanup task you wish to create:

• SOQL cleanup tasks use a SOQL WHERE clause to determine which records of an object to delete. Supply an object API name, a description, and an optional SOQL WHERE clause expression which specifies which records of that object should be deleted. For each task, you can also choose to permanently the records, or keep them in the recycle bin. Repeat for all of the objects whose records you would like to delete. Note: The component will check for tasks which attempt to clean up records of the same object, and disable any beyond the first. This is to ensure that records not specified in one WHERE clause don't get clobbered in another. To fix this, either combine the multiple Demo Cleanup Tasks into a single one with a unified WHERE clause (preferred), or check the box in the component's configuration section in the Lightning App Builder called "Allow Reused Objects in SOQL Tasks" (and take full responsibility for the possible consequences).
• Apex cleanup tasks allow the Apex developer to create arbitrary code to perform cleanup tasks that SOQL cannot handle by itselt. For these kinds of tasks, you need to enter the name of an Apex class that implements the DemoCleanupApexItem interface, and a description. A template Apex class called DemoCleanupCustomApex is included as part of the package which you can copy and fill out to suit your needs (Note: do not modify the original class since it will be overwritten the next time you upgrade the package).
• Flow cleanup tasks allow the declarative developer to invoke an arbitrary autolaunched flow. The component will pass in the Id of the demo cleanup task that invoked the flow through the DemoCleanupTaskId input variable in case the flow needs to access any of the fields in the task itself.

Ordering the Demo Cleanup Tasks

Beginning with version 2 of this component, Demo Cleanup Tasks are executed sequentially. To reorder the tasks, drag and drop them in the correct order using the component. The order is automatically saved in the Salesforce database.

Running the Demo Cleanup tool

Once the Demo Cleanup Tasks have been placed in the order in which you would like to have them executed, select the ones you want run and click the Clean Up the Demo button. You will be presented with a confirmation dialog showing exactly what will be done. Please read this carefully! Deletions that are not sent to the Recycle Bin will be deleted permanently. Pay particular attention to the SOQL cleanup tasks to ensure that the WHERE clause is correct: the WHERE clause should evaluate to true if the records should be deleted.

After execution, the Demo Cleanup tool will display any errors that occurred in a list at the bottom of the component.

Caveats and Known Limitations

• If you are upgrading from a 1.x version of this package and you have Apex Cleanup Tasks already in the org, you might get errors during the upgrade and definitely during the execution. I changed the DemoCleanupApexItem interface for version 2 and your existing Apex classes that implemented the old interface will be out of date.
• Please be patient as the cleanup process progresses. Each Demo Cleanup Task is executed in its own asynchronous environment (Batchable for SOQL Cleanup Tasks and Queueable for Apex and Flow Cleanup Tasks). During times that the Salesforce infrastructure is particularly busy, you may see wait times of up to several minutes before a task is begun.
• You may have a maximum of 90 cleanup tasks active at any given time. This is to avoid exceeding Salesforce governor limits around the number of SOQL queries in a single transaction while building the list of cleanup tasks inside the component. The workaround is to just deactivate some of the demo cleanup tasks temporarily. Hopefully this will not be a problem for most people.
• The cleanup tasks are performed sequentially, with the Apex and Flow Cleanup Tasks executed asynchronously in chained Queueable Apex classes. Queueables have limits on the number that can be sequentially chained in Trial and Developer orgs and, although I make sure that limits are not exceeded, I do not warn about having too many in a chain. This means that in some orgs, you need to make sure that you don't clump more than 5 Apex or Flow Cleanup Tasks together.

How to Deploy This Package to Your Org

I am a pre-sales Solutions Engineer for Salesforce and I develop solutions for my customers to demonstrate the capabilities of the amazing Salesforce platform. This package represents functionality that I have used for demonstration purposes and the content herein is definitely not ready for actual production use; specifically, it has not been tested extensively nor has it been written with security and access controls in mind. By installing this package, you assume all risk for any consequences and agree not to hold me or my company liable. If you are OK with that ...

Install the Package in Production

Install the Package in a Sandbox

Acknowledgements

I was inspired by work done by Salesforce super-SE John Schillaci to create this component.

Maintainer

John Meyer / johnsfdemo

Current Version: 3.2