Deploying the GRAX Embedded Code
Deploying the open-source GRAX Embedded Code to your Salesforce org
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
Step 1 : GRAX Backend
Before starting this process, make sure you have GRAX deployed, setup, and running in Self-Managed, AWS Marketplace, or GRAX Managed. 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.
Open Terminal or Command Line
Update SFDX - Update and validate SFDX is installed properly.
Navigate to your local directory of repositories
Clone repository (needs screenshot)
git clone https://github.com/graxinc/grax-salesforce-embedded.git
Change to the directory of the newly cloned repository
Login to Salesforce
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.
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
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
GRAX Configuration Settings - Click "Manage" Button on GRAXConfiguration__c object
sfdx force:org:open -u GRAXDev -p /lightning/setup/CustomSettings/home
Add CSP Trusted Site - Click "New Trusted Site"
Trusted Site URL:
sfdx force:org:open -u GRAXDev -p /lightning/setup/SecurityCspTrustedSite/home
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.
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
Assign the appropriate GRAX permission set to other users to achieve your intended access levels.
Ready to go - Auto Backup >> Enabled
sfdx force:org:open -u GRAXDev -p /lightning/n/GRAXEmbedSetup
Updated about 2 months ago