Configurations (admin)
5 min
Set which sandboxes, cleanup methods, and defaults the Cleanup Sandbox tool offers, and how long cleanup history is kept.
Prerequisites
- You have the View Configurations permission to see the settings, or Manage Configurations to change them. Both belong to the Sandbox Tooling permission resource.
- The app's database is initialized. If it isn't, a message tells you to go to Configurations to set it up.
Steps
Open the settings
- In the left navigation, under Administration, click Configurations.
- Click the Sandbox Tooling tab.
- Find the Cleanup Sandbox panel. Without Manage Configurations, there is no Save button, so changes can't be saved.
TODO(user): screenshot of the Sandbox Tooling tab.
Set cleanup history retention
- Under Cleanup history TTL, set Time to live (TTL) for cleanup history to a number of days from 1 to 365. The default is 365.
- To let people delete history records older than the TTL, keep Allow manual deletion of history records older than TTL selected. It is selected by default. TODO(user): confirm where this deletion is done in the app.
Changes to the TTL aren't applied to history records that already exist.
Choose which sandboxes people can pick
- Under Sandboxes, choose one:
- Show all sandboxes.
- Show only sandboxes the user has access to. This is the default.
- To block sandboxes from cleanup, add them to Blacklisted sandboxes. They won't be available in the cleanup tool.
Choose cleanup methods and defaults
- Under Cleanup methods, in Available cleanup methods, select the methods people can choose: User group(s), Age, Keyword(s), and Manual.
- In Default selected cleanup method, choose the method that's pre-selected.
- Use the tabs below to set defaults for each method:
- User group(s): in Allowed User group(s), choose the groups people can select. In Default selected User group(s), choose the groups that are pre-selected. Default groups must also be allowed groups.
- Age: set the default age and unit. The default is 1 month.
- Keyword(s): add the keywords that are pre-filled. Type a keyword and press Enter.
TODO(user): GIF of selecting methods and setting defaults.
Save
Click Save. A message confirms Settings saved successfully.
Expected result
When you open Cleanup Sandbox and click Start cleanup, the Method list shows the methods you enabled, and the defaults you set are pre-filled.