How to Configure Salesforce Lightning Scheduler Integration with Revenue Grid¶
For users of the Email Sidebar on:
4 min read
Tip
See this article for more information on using Salesforce Lightning Scheduler and this article to learn how the underlying API endpoints work. Also, see this video https://youtu.be/D6betOrxAwo to learn how to work with Salesforce Lightning Scheduler via RG Email Sidebar
This article provides the steps on how to configure Salesforce Lightning Scheduler integration with RG Email Sidebar.
Important
So far, this feature is implemented only for EWS users and is not available for the MS Graph users
Step 1: Dedicated Salesforce Managed Package Installation¶
This is a bulk action performed by the Admin for all end users.
Note
The prerequisite for Managed package installation is to set up Salesforce Lightning Scheduler, as described in this Salesforce article
To run Salesforce Lightning 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 integration package RG Lightning Scheduler Adapter should be installed by the local Salesforce Admin as described in this Salesforce article; follow the steps below:
1.1. Make sure that you have set up My Domain name for your Salesforce Org and deployed it for the users. Please follow the instructions in this Revenue Grid article to learn how to do that
Another prerequisite for Managed package installation is to enable the setting Publish Appointments as Platform Events in Salesforce Scheduler Settings.
To do this:
-
Switch to Lightning Experience
-
Click the Gear (Setup Menu) icon in the upper right corner of the page to open Salesforce Setup menu
-
In the Quick Search field in the upper left corner, type “Scheduler Settings” to quickly find the necessary tab
-
On the newly opened Salesforce Scheduler Settings page, enable the setting Publish Appointments as Platform Events
1.2. Open package installation link:
You can get the latest version of the managed package here:
https://login.salesforce.com/packaging/installPackage.apexp?p0=04t09000000vFKz
Managed package updates are released regularly. Guidance on updating managed package is provided in this section.
1.3. Log in to your Salesforce account (it must have Admin permissions in your Org)
1.4. 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.5. Indicate if you want to install the package for:
- All users in your Org
- (recommended) Only for specific users who will be using Lightning Scheduler integration
- Only for the Admins
1.6. 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.
Note
The managed package is guaranteed to be secure, confidential, and free of any malicious content, under Revenue Grid Privacy & Security policies
1.7. Next, after the managed package is installed, log in to Salesforce with Admin credentials
1.8. Switch to Lightning Experience as described in this Salesforce article
1.9. Click the Gear (Setup Menu) icon in the upper right corner of the page to open Salesforce Setup menu
1.10. In the Quick Search field in the upper left corner, type “Custom Settings” to quickly find the necessary setting
1.11. On the Custom Settings page, click Manage button next to Scheduler Setting label
1.12. Next, on the Scheduler Setting page, click Edit action next to the Scheduler name
1.13. On the Scheduler Setting Edit page, paste the Clientid you received from our Support team in the relevant field and click Save
Step 2: Set the Custom Apex Class¶
This is a bulk action performed by the Admin for all end users.
In order to accurately retrieve occupied Lightning 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 in the upper left corner of Salesforce Setup page, 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 at the bottom of the dialog
Now Lightning Scheduler integration is connected and ready to be used. See this video to learn how to use the feature.
Step 3: Connect Lightning Scheduler Integration¶
It’s recommended that the Admin performs this action in a dedicated Salesforce Service Account.
Next, you need to connect integration via the installed managed package. Perform the following steps:
3.1 Open Salesforce Setup Menu
3.2. In the Quick Find field in the upper left corner of Salesforce Setup page, enter “Installed packages’‘
3.3. 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
3.4. Click on Configure next to RG Lightning Scheduler Adapter package
3.5. In the dialog that appears, enter the specific Sync URL provided by Revenue Grid support team for your Org, e.g., https://sample-sync.revenuegrid.com, into the designated field
3.6. Click the button Connect next to the field
3.7. You will see a link appear on the page
3.8. Copy the link and open it in an incognito browser window
3.9. You will see a standard Salesforce OAuth window. Log in to it with Salesforce credentials to authorize data access for integration
3.10. Go back to the page in step 3.5. and check whether the green popup notification “Connected” appeared.
Step 4: Check your 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 is the auxiliary step 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 Lightning Scheduler Adapter.
1. Switch to Lightning Experience
2. Click the Gear (Setup Menu) icon in the upper right corner of the page to open Salesforce Setup menu
3. In the Quick Search field in the upper left corner, type “Flows” to quickly find the necessary tab
4. Next, in the list of flows, find the one that was created from the template Inbound New Guest Appointment
4.1. Click on the flow to open the Flow builder
4.2. Then find the Action: Save Appointment block and click on it
4.3. In the dialog window, click on the Advanced section to expand it
4.4. In Transaction control, select the option "Let the flow decide (recommended)"
4.5. Click Done
4.6. In the upper right-hand corner, click Save to enforce the changes
5. In the list of flows, find the one that was created from the template Book Appointment from Invitation
5.1. Click on the flow to open the Flow builder
5.2. Then find the Action: Save Guest Appointment block and click on it
5.3. In the dialog window, click on the Advanced section to expand it
5.4. In Transaction control, select the option "Let the flow decide (recommended)"
5.5. Click Done
5.6. In the upper right-hand corner, click Save to enforce the changes
Updating the Salesforce Lightning Scheduler¶
To catch up with the latest Salesforce updates and ensure seamless Lightning Scheduler Integration functioning, we regularly release updates. The updated links are published in this article’s topmost section.
To upgrade to the latest Salesforce Lightning Scheduler version:
1. Open the new managed package link in your web browser
2. Log in to your Salesforce account (it must have Admin permissions in your Org)
3. Indicate if you want to upgrade the package for:
- All users in your Org
- (recommended) Install for specific Profiles which will be using Revenue Grid components
- Only for the Admins
4. If you chose Install for specific Profiles, set the needed profiles scope using the controls underneath
Note
Also see the relevant Salesforce guide for details
5. 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
6. 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.
We would love to hear from you!