Embed GRAX within Salesforce

Documentation & Help

Documentation SFDX, Scratch Orgs, and Development Best Practices

• Salesforce Scratch Orgs
• Salesforce DX Project Configuration
• Salesforce CLI Setup Guide
• Salesforce DX Developer Guide
• Salesforce CLI Command Reference
• Development Model
• Salesforce Extensions Documentation

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

   

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

   Text

   sfdx update
   

   

3. Navigate to your local directory of repositories

   

4. Clone repository

   Text

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

   

5. Change to the directory of the newly cloned repository

   Text

   cd grax-salesforce-embedded
   

   

6. Login to Salesforce

   Text

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

   

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

   

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

   

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.

   Text

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

   

8. Pushing GRAX to sandbox OR Scratch org

   • Pushing to a Sandbox - Recommended for testing

     Text

     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

     Text

     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

   Text

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

   

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

   Text

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

   

3. Create User Permission Sets

   • Follow the steps on the Integration User permissions page to create the appropriate permission set for the user GRAX runs as.

   • Follow the steps on the Access Management permissions page to create the appropriate permission set for the user GRAX runs as.

4. Assign User Permission Sets

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

     Text

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

     

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

5. Ready to go - Auto Backup >> Enabled

   Text

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