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    

GRAX Overview

Learn at a high level about the GRAX solution and why it provides such a robust data value platform.

GRAX Solution High Level Overview

The GRAX solution is a Data Value platform that provides replicate & preserve (backup & archive) functionality as well as advanced audit trail features to your data scenarios. GRAX is built with a core focus on Salesforce.com based data and data structures, allowing the offsite storage, management, and use of your valuable Salesforce.com data, as well as use with other non SalesForce.com platforms and services. Due to the nature of today’s cloud platforms, GRAX was designed to take advantage of 4 major technologies to achieve its value to any enterprise: Salesforce.com, Heroku, Elastic, and AWS (with an option for Azure in place of AWS).

Below is an overview of the GRAX ‘stack’, essentially, the 4 technologies that GRAX is built upon to achieve one, cohesive data value solution. It is essential to understand how GRAX utilizes these 4 core technologies, as the major areas of planning, installation, and enablement involve the configuration and management of each of these essential tiers of the GRAX solution (the ‘stack’).

Let's get into the core platforms and related components configured as part of the GRAX installation...

Salesforce.com

This serves as the user interface tier of GRAX, and is the tier where the GRAX managed application is installed and is your main point of interaction with GRAX (user interface, job scheduling, archive, restore, etc.). Items for consideration and configuration consist of:

  • GRAX managed package installation
  • Permission sets, roles, and security
  • Remote site settings
  • Connectivity to the GRAX Heroku layer of the GRAX ‘stack’
  • Validate availability of SF Connect (external data sources and connections) if using GRAX for advanced reporting and visualization (Einstein, standard reporting, etc.)

Heroku

This tier serves as the core GRAX application or middle tier, and supports and manages the proxying of data bi-directionally between the GRAX data lake and Salesforce.com, ability to scale elastically, manage dynos and resources, privacy, etc. Most of the configuration is managed at the Heroku layer of the GRAX app, as this essential middle -tier bridges the gap between Salesforce.com (the GRAX managed application\UI) and the GRAX data lake. Items for consideration and configuration consist of:

  • SFDC user name, password, login URL and token for Heroku to Salesforce.com connectivity
  • AWS S3 or Azure Blob Storage credentials: key, secret key, region, bucket name
  • Geographic regions for ‘where’ data can run and legally needs to reside
  • Private space setup: setup, custom domain, VPC peering
  • Does client need Private Space ‘Shield’?
  • Heroku resources to power GRAX: Dynos’ etc. Ensuring enough add-on credits to be able to performance tune GRAX effectively for the specific scenarios

Elasticsearch

This tier serves as the 1st part of the core data lake underlying technology for GRAX data lake storage. Elasticsearch indexes the most recent version of the SFDC data record for fast recall, search, and restore functions. GRAX uses this technology in cooperation with S3 or Blob Storage. You may choose to use the GRAX indexing or host your own Elastic Search. If hosting your own Elastic Search, additional consideration and configuration will need to be addressed, such as firewalls, proxies, etc. Items for consideration and configuration consist of:

  • Bonsai plan sizing required for your data sizing
  • Regions for plans are based on the geo-regions of your GRAX app (see above)
  • If self-hosting, additional considerations may need to be taken, such as:
    • IP restrictions
    • Proxies, networking restrictions, etc.
    • Any firewall rules (if hosting Elastic Search on premise)
    • Other security and access challenges or roadblocks

AWS S3 or Azure Blob Storage

This tier serves as the 2nd part of the core data lake underlying technology for GRAX data lake storage. This tier serves as the primary data repository/long term storage for the data lake in that it contains all backup versions of records and the actual attachment binaries.

Items for consideration and configuration consist of:

  • AWS S3 credentials required for GRAX: region, bucket name, secret key, key
  • Azure Blob Storage credentials for GRAX: account name, container name, account access key
  • Additional considerations include:
    • IP restrictions
    • Organizational Units in AWS
    • Any firewall rules (if hosting AWS\Azure Storage on premise)
    • Other security and access challenges or roadblocks

Min.IO Storage

MinIO is an object storage server released under Apache License v2.0. It is compatible with the Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. The size of an object can range from a few KBs to a maximum of 5TB.
If you have decided to use Amazon S3 as your preferred long term storage, you will need to create an S3 bucket and a credential that can only access that bucket. This credential can only read and write to S3 and nothing else (including logging into the UI). Typically, we name the bucket/policy/user the exact same name.

GRAX Overview


Learn at a high level about the GRAX solution and why it provides such a robust data value platform.

Suggested Edits are limited on API Reference Pages

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