Embedded guides intended for Salesforce can be delivered in an Embedded Guide LWC, which is part of the Salesforce Pendo Toolkit (hereafter, Salesforce toolkit). This functionality helps to overcome the challenges associated with the structure of Salesforce pages, which can make it difficult to select elements to embed content.
For information about the Salesforce toolkit, see The Pendo Toolkit for Salesforce.
How it works
Internal Pendo users that build guides provide instructions to the Salesforce Toolkit Administrator about where they want to embed content. This article provides instructions for a Salesforce Toolkit Administrator to place the Embedded Guide LWC in the intended location in Salesforce Lightning pages.
Prerequisites
- Pendo installed and configured using the Pendo Launcher browser extension. For more information, see Plan your browser extension implementation and the IT guide to deploying the Pendo Launcher.
- The Salesforce toolkit for Pendo set up. For instructions, see The Pendo Toolkit for Salesforce and Set up the Pendo Toolkit for Salesforce.
Step 1. Add the Embedded Content LWC to a record page
To add the Embedded Guide LWC to a record page in Salesforce:
- Open a record page in Salesforce, such as an Account, Opportunity, or Contact.
- Select the gear icon in the top right and select Edit Page. This opens the Lightning App Builder.
- In the component list on the left side of the page, find Pendo Embedded Guide.
- Drag and drop the Pendo Embedded Guide LWC to an appropriate location in the record page. This is visible to both Pendo Toolkit Administrators and Pendo Toolkit Users. For more information about these permission sets, see The Pendo Toolkit for Salesforce.
- For each Pendo Embedded Guide LWC placed on the page, enter a unique Component ID in the component settings on the right side of the Lightning App Builder. This ID is needed to target content to this component.
- Select Save.
Step 2. Create embedded content in Pendo
After you’ve placed the Embedded Guide LWC in Salesforce, go to Pendo to create your embedded Guide. For instructions, see Create embedded guides.
As part of this process, define any additional settings for your embedded guide, such as goals, activation, segments, scheduling, and localization. For more information, see Define guide settings.
Step 3. Set the LWC as the target element for your embedded content
After you’ve built your embedded guide, use the Visual Design Studio in Pendo to insert that guide into the Embedded Guide LWC in Salesforce.
- In Pendo, go to Guides > Guides, open your embedded guide, select Manage in my app, and then select Launch Designer. This opens the Visual Design Studio for your embedded guide.
- Open the Location tab in the Edit Container window.
- Under Select Element, choose Custom CSS and enter the following:
.active [data-component-id="COMPONENTID"]. Replace the capitalized value in quotes with the unique Component ID you assigned to the Embedded guide LWC in Salesforce, which is where you want the guide to appear. - Select Done in the bottom-right corner of the Edit Container window of the Visual Design Studio.
- Select Save in the action bar.