Embed GRAX within Salesforce

Deploying the open-source GRAX Embedded Code to your Salesforce org

Documentation & Help

Documentation SFDX, Scratch Orgs, and Development Best Practices

Install Tools

  1. Salesforce CLI
  2. Install GIT
  3. GitHub Sign Up

Deployment process

Step 1 : GRAX Backend

Before starting this process, make sure you have GRAX deployed, setup, and running. If you need help setting up a backend you can email for a Trial or current customers can reach out to Support.

Step 2 : GRAX UI for Salesforce

Below assumes you have knowledge of Salesforce Development, SFDX, and release procedures. If you need more information please refer to the links in the Documentation & Help section above.

  1. Open Terminal or Command Line

    Terminal window

  2. Update SFDX - Update and validate SFDX is installed properly.

    sfdx update

    Terminal window showing sfdx command submission

  3. Navigate to your local directory of repositories

    Terminal window showing the navigation to the local repository directory

  4. Clone repository

    git clone https://github.com/graxinc/grax-salesforce-embedded.git

    Terminal window showing repository cloning

  5. Change to the directory of the newly cloned repository

    cd grax-salesforce-embedded

    Terminal window showing directory change into the repository

  6. Login to Salesforce

    sfdx auth:web:login -a GRAXDev -r https://test.salesforce.com

    Terminal window showing command to authenticate the terminal session through login to web portal

    You should see the Salesforce browser login page open, login with System Administrator user.

    General Salesforce login page

    You can see in the Terminal window that you are now authenticated to the Salesforce org.

    Terminal window showing successful authentication

  7. Enable Set Audit Fields upon Record Creation and Update Records with Inactive Owners User Permissions
    If you don't do this, pushing the permission sets fails due to a setting being unavailable.

    sfdx force:org:open -u GRAXDev -p /lightning/setup/UserInterfaceUI/home

    GRAX Enable Audit Fields

  8. Pushing GRAX to sandbox OR Scratch org

    • Pushing to a Sandbox - Recommended for testing

      sfdx force:source:deploy -p force-app/main/default -u GRAXDev
    • Create & push to Scratch org - Please refer to how to use Salesforce Scratch Orgs

      sfdx force:org:create --definitionfile config/project-scratch-def.json --durationdays 30 --setalias GRAXDev -v DevHub
      sfdx force:user:password:generate -u GRAXDev
      sfdx force:source:push -u GRAXDev

Step 3 : Configure & Go

  1. GRAX Configuration Settings - Click Manage Button on GRAXConfiguration__c object

    sfdx force:org:open -u GRAXDev -p /lightning/setup/CustomSettings/home

    Salesforce Custom Settings Setup page

  2. Add Trusted URLs - Click New Trusted URL
    Name: GRAX
    Trusted Site URL: https://grax-app-url.aws.azure.gcp.grax.com (Sample)

    sfdx force:org:open -u GRAXDev -p /lightning/setup/SecurityCspTrustedSite/home

    Trusted URL

  3. Create User Permission Sets

  4. Assign User Permission Sets

    • Ensure GRAX INTEGRATION USER Permission permission set is assigned to the user GRAX is running as.

      sfdx force:org:open -u GRAXDev -p /lightning/setup/ManageUsers/home

      GRAX Permission Sets

    • Assign the appropriate GRAX permission set to other users to achieve your intended access levels.

  5. Ready to go - Auto Backup >> Enabled

    sfdx force:org:open -u GRAXDev -p /lightning/n/GRAXEmbedSetup

    Auto Backup On