LogoLogo
TrustAPI Docs
  • Application
  • Support
  • Platform
  • Infrastructure
  • Security
  • Notices
  • Overview
  • Protect Data
    • Auto Backup
      • Auto Backup API Usage
      • Supported Objects
      • Delete Tracking
      • Salesforce Metadata Backup
      • Missing Field Permissions
      • Viewing Records
      • Viewing Files
    • Archive
      • Support for Big Objects
    • Restore
      • Restore Best Practices
    • Purge
  • Reuse Data
    • Global Search
    • Data Lake (formerly History Stream)
      • AWS Data Lakehouse
      • DuckDB Data Lake
      • Heroku Data Lakehouse
      • Azure Data Lake
      • Data Lake FAQ
      • Data Lake v1 (formerly History Stream)
    • Salesforce Sandbox Seeding
      • Sandbox Seeding Walkthrough
    • Public API
    • Managed Package
      • Second Generation
        • Features
        • Install
        • Update
        • Uninstall
      • First Generation
        • Features
        • Configure
        • Uninstall
        • Migrate
      • Frequently Asked Questions
  • Other
    • Settings
      • Connecting Salesforce
      • Connecting Storage
      • Sandbox Refresh
    • Notifications
    • Permissions
      • Integration User
      • Integration User Scripts
    • Troubleshooting
      • Debugging Salesforce Triggers
    • Auto Updates

Copyright © 2025 GRAX, Inc.

On this page
  • What Is Purge?
  • How to access Purge
  • Purge Workflow
  • Auto Purge
  • Purge Jobs
  • Purging Live Records
  • Global Search for Purged Records
  • Frequently Asked Questions

Was this helpful?

Export as PDF
  1. Protect Data

Purge

Last updated 1 month ago

Was this helpful?

Do Not Modify Data Directly

The GRAX data storage layer is a proprietary, compressed, bit-level data store that isn't human readable or editable. Never modify the dataset in storage yourself, including the deletion, modification, renaming, or moving of storage objects. All interaction with the stored data should occur via the GRAX Application.

What Is Purge?

Purge is the new Data Lifecycle Management feature offered by GRAX that supersedes Delete Forever. Purge allows you to define data retention rules that manage the permanent deletion of data from the GRAX Data Vault. This feature is included with GRAX Enterprise and Data Archive and Lifecycle Management licenses.

Please note that the Purge feature is not intended for storage cleanup or reducing storage capacity (Archive is the functionality to be used for those purposes); it is designed to permanently delete data for privacy, legal, and/or compliance reasons and should be used with caution, as data can not be recovered after it has been purged.

How to access Purge

Purge is integrated in two places within the GRAX Application.

Purge Menu Page

Click on Purge in the menu and you will see the button New Purge. This takes you into the Purge workflow.

Record Details

A second method of selecting records to purge can be accessed through record details. Either click on any record link or enter the ID in the Lookup By ID box in the header to arrive at the record details view. Clicking on the vertical ellipsis in the header gives you the option to purge.

Purge Workflow

To purge data, the records must first be deleted in Salesforce or Archived by GRAX. Purged records will be permanently removed from the GRAX Data Vault and will no longer be available to review or restore. Purge provides a workflow to guide you through the steps to purge data.

1

Select the records you want to purge

There are a few ways to tell Purge what records you want to include:

If you're purging records based on specific criteria — such as "All Cases related to a contact with the last name 'Smith'" — you can use Search to quickly find all such records:

If you're purging a fixed set of known records, you can purge them simply by entering one record ID per line:

If you have assembled or determined the list of records to purge from an external system or tool, you can use a CSV as the input source:

2

Choose Purge options

We provide options to verify the records in Salesforce and/or receive an email of important changes.

3

Preparing the Hierarchy

GRAX builds and graphs the hierarchy of your records to prepare for purge. You can see the graph of your records and the number of records that will be purged.

There is also a list view where you are presented with tools to configure a purge allowing you to skip records or include additional objects referenced by your purge data.

You may not want all objects that are referenced in the graph hierarchy. You have the option to skip objects that you don't wish to include. You can define additional referenced objects to include via the Relationships tab.

4

Execute the Purge

After clicking Purge, you are prompted to confirm.

You will be presented with a progress indicator as the data is purged. Once complete, you will be presented with a summary of the purge. You can see the number of records purged, the number of records skipped, and the number of records that failed to purge. You can also see the number of records that were purged from each object.

Auto Purge

After completion of a purge job created from a search source, you can choose to set up an auto purge.

This takes you to the Auto Purge Detail page. You can rename the purge job, skip new objects, and enable it to run as an Auto Purge. You can also choose to receive an email notification when each purge batch is complete or if the job encounters an error.

Purge Jobs

Prior Purge jobs are shown in the Purge tab of the menu with detailed information on each. You can see the status of the job, the number of records purged, the date the job was created, the duration of the job, and the success rate. Clicking on the job name takes you to the job details page where you can see the records that were purged.

Currently enabled and paused Auto Purge jobs are displayed on the top of this page with details on when the job was last modified, the number of records purged, the date the job was last ran, and the next scheduled run. Clicking on the job name takes you to the job details page where you can see the records that were purged. You can pause all Auto Purge jobs by clicking the Pause Auto Purges button. You can also view disabled Auto Purge jobs by clicking the View Disabled option on this page.

Purging Live Records

You can purge records that are still live in Salesforce if you want to remove the data completely from GRAX. If you do not want the data to be backed up again subsequently, you will need to anonymize the data in Salesforce (which will result in anonymized data being backed up) or remove access to the object/record which will prevent backup completely.

To enable the ability to purge live records, you will need to navigate to the Settings page of the GRAX Application, expand the Advanced Features section, and toggle on the related option.

Global Search for Purged Records

Global Search now allows you to search for records that have been Purged (permanently deleted). To search for Purged records, select any Status other than "Live" and add a date filter configured with "Order By: Purged At" and select an appropriate time frame. The Purged records returned by Global Search will not contain any field data other than RecordID. The CSV download of Global Search results will now contain a purgedAt date column.

Frequently Asked Questions

When purging file-related records such as Attachment and ContentVersion, will associated files be deleted?

Yes, purging file-related records will also delete the associated files.

Will purging data remove the associated parquet files written to the Data Lake?

No, we do not modify parquet data after it has been written.

Will purging data remove records that have been seeded to another org?

No, purging will not affect any records that have been seeded.

Will purging data remove records from Delete Tracking?

Delete tracking will still point to a purged record, but there will be no data shown, just a reference to it being purged.

Creating a New Purge via the Purge Page
Creating a New Purge via the Record Details Page
Using Search to Determine Purged Records
Providing Record IDs to Purge
Providing a CSV of Records to Purge
Optional Behaviors of Purge
Pending Purge Hierarchy Details Graph
Pending Purge Hierarchy Details List
Execute Purge Confirmation
Successful Purge Details Graph
Creating an Auto Purge
Configuring an Auto Purge
Purges List