Clean up a sandbox
Remove objects you no longer need from an AEP sandbox, from choosing the sandbox to checking the results.
Prerequisites
- You have the Execute Cleanup Sandbox permission.
- You know which sandbox you want to clean and why. You are asked for a reason.
- Nobody else is cleaning that sandbox. A sandbox with an unfinished cleanup doesn't appear in the list.
- The sandbox isn't blocked by your admin, and you have access to it if your admin limits the list to sandboxes you can access.
Steps
Configure the cleanup
- In the left navigation, under Sandbox Tooling, click Cleanup Sandbox.
- Click Start cleanup. The wizard opens full screen. TODO: GIF of opening the wizard from the Cleanup Sandbox page.
- In Sandbox, select the sandbox to clean.
- In Reason, enter a short reason for the cleanup.
- In Method, choose how the tool should suggest items to remove, then fill in the field that appears:
- User group(s): in Keep items created by users in these User group(s), select one or more groups.
- Age: set a number and a unit (Days, Weeks, Months, or Years).
- Keyword(s): in Keywords to match, type a keyword and press Enter. Repeat for more keywords.
- In Apps to clean up, choose which apps to include. All four are selected by default. Selecting or clearing RTCDP or AJO changes both, because they are linked.
- Click Start Cleanup. In the confirmation dialog, check the sandbox, apps, and method, then click Start Cleanup again.
TODO: screenshot of the Configure step.
This locks the sandbox for other users until the cleanup is completed or aborted. After you start, you can't change the sandbox.
Curate the items
- On the Curate Items step, wait for each category to finish loading. Each row shows the category, its status, the Total items, and how many are set to Keep and to Remove.
- If you selected more than one app, use the app tabs at the top to switch between them.
- For each category that has items tagged for removal, click the category name to open it. A warning icon marks categories that need review.
- In the dialog, click the Keep or Remove badge in the Action column to change an item. Items that come with the platform are hidden. Turn on Show OOTB Items to see them. Their action can't be changed. TODO: GIF of changing an item from Remove to Keep in the category dialog.
- Click Save & Approve to mark the category as reviewed.
- Repeat for every category that needs review. To keep everything in a category, use Tag all as 'Keep'.
- When every category is approved and at least one item is tagged for removal, click Next.
TODO: screenshot of the Curate Items step with the category table and a warning icon.
Review and run the cleanup
- On the Review step, check the final list. Use the app tabs, then expand a category to see the type and name of each item. Click Back if you need to change anything.
- Click Execute Cleanup.
- In the confirmation dialog, type the sandbox name exactly as shown to confirm, then click Execute Cleanup.
You can't abort or undo the cleanup after this point.
Follow the cleanup and check the results
- On the Execute step, watch the progress. The page updates about every 4 seconds and shows overall progress plus each app, category, and item.
- When the cleanup finishes, the wizard moves to the Recap step on its own.
- Expand the apps and categories to see what was removed. Click an item with an error to see why it wasn't removed.
- Click Done.
TODO: screenshot of the Recap step.
Expected result
The cleanup appears in the history table on the Cleanup Sandbox page with the status Completed, the number of items removed, and, if any items failed, the number of errors. The sandbox is unlocked for other users.
To stop before executing, click Abort on the Curate or Review step, then Yes, Abort. The sandbox is unlocked.