How to Configure Salesforce Scheduler Integration with Revenue Grid¶
[SSA version 1]
For users on:
Important
So far, this feature is implemented only for EWS users and is not available for MS Graph users
This article provides the steps on how to configure Salesforce Scheduler Adapter version 1 (further referred to as “SSA”) with RG Email Sidebar.
For instructions on configuring SSA version 2 (with Salesforce widgets), refer to this article.
The setup process consists of the following steps:
- Install a dedicated Salesforce managed package
- Set the custom Apex class
- Add a new remote site
- Connect Salesforce Scheduler Adapter
- Configure the necessary Salesforce flows (auxiliary)
Tip
See this article for more information on using Salesforce Scheduler. Refer to this article to learn how the underlying API endpoints work.
Prerequisites for managed packages installation¶
Using Salesforce Scheduler Adapter (SSA) requires:
-
Setting up Salesforce Scheduler, as described in this Salesforce article
-
Setting up My Domain name for your Salesforce Org and deploying it for the users. Follow the instructions in this Revenue Grid article to learn how to do that
-
Enabling the setting Publish Appointments as Platform Events in Salesforce Scheduler Settings:
- Switch to Lightning Experience
- Open Salesforce Setup menu
- In the Quick Search field, enter "Scheduler Settings"
- Click on Salesforce Scheduler Settings
- Enable the setting Publish Appointments as Platform Events
Step 1: Dedicated SSA managed package installation¶
Running Salesforce Scheduler integration requires a set of special Salesforce objects and classes. Revenue Grid created a special Salesforce managed package that includes all required assets to facilitate the integration setup process. The managed package is guaranteed to be secure, confidential, and free of any malicious content, under Revenue Grid Privacy & Security policies
Install the integration package RG Salesforce Scheduler Adapter as described in this Salesforce article or as described below:
1.1. Install the managed package¶
1.1.1. Open package installation link:
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tJ80000004dfW&isdtp=p1
1.1.2. Log in to your Salesforce account (it must have Admin permissions in your Org)
1.1.3. Select the checkbox I acknowledge that I’m installing a Non-Salesforce Application that is not authorized for distribution as part of Salesforce’s AppExchange Partner Program to permit installation
1.1.4. Indicate if you want to install the package for:
- All users in your Org
- (recommended) Only for specific users who will be using Salesforce Scheduler integration
- Only for the Admins
1.1.5. Click the Install button in the lower right corner of the page
You’ll see a notification “Installing and Granting Access to Specific Users…”, then receive an email message that the package has been installed successfully.
Step 2: Set the custom Apex class¶
In order to accurately retrieve occupied Salesforce Scheduler hours spans from Salesforce, a custom Apex Class included in the managed package must be set in Salesforce Scheduling policy settings. Follow the steps below to do that:
2.1. Open Salesforce Setup Menu
2.2. In the Quick Find field, enter “Scheduling policies”
2.3. Click on Scheduling policies in the navigation pane on the left. You will see the list of policies in the main pane
2.4. In the Scheduling Policies dialog, click Edit next to Default Appointment Scheduling Policy
2.5. In the field Check External Systems for Resource Availability, enter the value ServiceResourceScheduleHandlerImpl; it is a dedicated Apex class included in the managed package
2.6. Click Save
Step 3: Add a new remote site¶
3.1. In the Quick Find field, enter “Remote site settings“
3.2. Click on Remote Site Settings in the navigation pane on the left; you will see the list of remote sites configured for your Org in the main pane
3.3. Click the New Remote Site button
3.4. Fill in the necessary info on the Remote Site Edit page:
- Enter “SSA” in the Remote Site Name
- Enter the Sync URL provided by Revenue Grid support team for your Org, e.g. https://sample-sync.revenuegrid.com in the Remote Site URL
- Make sure that the Active checkbox is enabled
3.5. Click Save
Step 4: Connect Salesforce Scheduler Adapter¶
Important
Before proceeding with this step, you should create a Salesforce Integration User for connecting to Revenue Grid's Salesforce Scheduler Adapter
4.1. In the Quick Find field, enter “Installed packages“
4.2. Click on Installed packages in the navigation pane on the left; you will see the list of Managed packages installed in your Org in the main pane
4.3. Click Configure next to RG Salesforce Scheduler Adapter package
4.4. On the page that appears, enter the Client ID provided by [Revenue Grid support team] for your Org
4.5. Enter the Sync URL provided by Revenue Grid support team for your Org, e.g., https://sample-sync.revenuegrid.com, into the designated field
4.6. Click Connect
4.7. Log in with Salesforce Integration User’s credentials in the Salesforce OAuth window.
4.8. You will be redirected to the Connect page. You will see that the Connection status and/or date are updated
Check the connection status¶
1. Enter the specific Sync URL provided by Revenue Grid support team, e.g., https://sample-sync.revenuegrid.com, into the URL field in your web browser
2. Select the option “Sign in with Salesforce”
3. You will see a standard Salesforce OAuth window. Log in to it with Salesforce credentials to access RG sync settings page
4. Check the connection status.
If the connection wasn’t established, contact our support team for assistance.
Step 5: Configure the necessary Salesforce flows (auxiliary)¶
Important
This step is ONLY for the organizations which use custom Salesforce flows created from Inbound New Guest Appointment and Book Appointment from Invitation standard flow templates for scheduling appointments.
If your organization does not use any custom Salesforce flows created from Inbound New Guest Appointment and Book Appointment from Invitation standard flow templates, skip this step
If your company utilizes the Salesforce flows created using the Inbound New Guest Appointment and Book Appointment from Invitation standard flow templates for scheduling appointments, you must configure your custom flows additionally to use the RG Salesforce Scheduler Adapter.
5.1. Switch to Lightning Experience
5.2. Open Salesforce Setup menu
5.3. In the Quick Search field, enter “Flows” to quickly find the necessary tab
5.4. Click Flows. You will see the list of your Org’s flows
5.5. In the list of flows, find the one that was created from the template Inbound New Guest Appointment
5.5.1. Click on the flow to open the Flow builder
5.5.2. Then find the Action: Save Appointment block and click on it
5.5.3. In the dialog window, click on the Advanced section to expand it
5.5.4. In Transaction control, select the option "Let the flow decide (recommended)"
5.5.5. Click Done
5.5.6. In the upper right-hand corner, click Save to enforce the changes
5.6. In the list of flows, find the one that was created from the template Book Appointment from Invitation
5.6.1. Click on the flow to open the Flow builder
5.6.2. Then find the Action: Save Guest Appointment block and click on it
5.6.3. In the dialog window, click on the Advanced section to expand it
5.6.4. In Transaction control, select the option "Let the flow decide (recommended)"
5.6.5. Click Done
5.8.6. In the upper right-hand corner, click Save to enforce the changes