GRAX Documentation

The GRAX Documentation Hub

Welcome to the GRAX Documentation hub. You'll find comprehensive guides and walkthroughs to help you start working with GRAX as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with GRAX Archive

This guide will walk you through the basics and features of the GRAX Archive product. GRAX’s archive functionalities help you improve application performance as well as manage storage footprints and serves as a crucial point to drive value and ROI across the spectrum for our customers.

Understanding GRAX Archive

GRAX Archive will back up and delete the records you selected from your hierarchy process within a Salesforce org. With GRAX you can still access the data from within the Salesforce interface even though that data is now stored in your data storage environment. This setup allows you to improve your application performance while keeping your archived data live.

📘

GRAX TIP

Go to the ‘Summary’ tab to create tables & charts to summarize and visualize all of your historical archive processes.

Stages of the GRAX Archive Hierarchy Process

There are generally three (3) stages for a GRAX hierarchy process, however, we do allow you to go up to 5-levels deep on chatter-related objects if you need it. These jobs run behind the scenes and this is the order that the code will take when processing a hierarchy job:

Stage Description

Process Parent

Process the very top-level node

Process Children

After processing the parent, each second-level child node is processed. GRAX may cycle through multiple times (potentially at various times)

Process Children
of Children

Following the processing of the children, each child’s children are processed as the third-level nodes (i.e. grandchildren of the main parent)

GRAX Archive Options

When creating a GRAX Archive job, there are two options for your consideration:

Do Not Delete Parent

Override Object Hierarchy

This option will archive all objects selected except for the root parent, which can help you filter. We recommend proceeding with this option when you're first getting started with GRAX to avoid potential complications.

Proceed with caution! With this option, the system forces you to choose all master-detail relationships. If you miss selecting certain objects, this could cause undesired deletions.

Alerting & Notifications

Both object backup and hierarchy process can alert you to various statuses of a job with email notifications for:

  • Process Completion
  • Process Completed – Error Sending Data
  • Process Completed – Error Deleting Records
  • Error Backing Up Files to Storage
  • Error

Creating Your First Hierarchy Process for Archive

  1. Click on the sub-tab Schedule to access the Hierarchy Processes option
  1. Click Create
  1. Fill in the Name of your process
  1. Select the main Salesforce Object (parent)

5.Select your Filter Criteria
*Date is the most used filter, which allows you to select any date field found on the Salesforce Object selected

  1. Select your Schedule for how often you would like this to run
  1. Review what’s checked in your Object Hierarchy for objects that will be archived
  1. Select Archive

Best Practices & Pro Tips

  • Stagger archive jobs that involve the same objects to avoid record locking
  • Use exceptions to prevent setting off triggers, custom code, flows, & processes when deletes are done by a designated GRAX user
  • Always have a unique external ID on objects that are being archived (aside from the lookup relationship fields) to prevent orphans
  • Certain Salesforce objects cannot be archived and can block your process if selected
  • We do not recommend archiving data for 3rd party package customizations/objects unless fully validated
  • Ensure you understand all Salesforce considerations for relationships before running an archive job
  • When running an initial archive job or large archive jobs, we recommend understanding the other DML operations that may be scheduled

Resources

Now that you’ve mastered the basics, you can keep expanding your knowledge & mastery with our Knowledge Base:

Updated about a month ago

Getting Started with GRAX Archive


This guide will walk you through the basics and features of the GRAX Archive product. GRAX’s archive functionalities help you improve application performance as well as manage storage footprints and serves as a crucial point to drive value and ROI across the spectrum for our customers.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.