You can deliver Pendo guides, including embedded guides, based on Salesforce data values by leveraging parameters shared through the Page Data LWC of the Pendo Toolkit for Salesforce (hereafter, Salesforce toolkit). These parameters are incorporated into the event properties of tagged Pages in Pendo, which you can then use to control when a guide is displayed.
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. For information and instructions, see The Pendo Toolkit for Salesforce and Set up the Pendo Toolkit for Salesforce.
- Page event properties enabled. For instructions, see Page event properties.
- The Page Data LWC placed in the Lightning record page for the Salesforce object you want to target guides based on. For instructions, see Share Salesforce data with Pendo using the Page Data LWC.
- In the Pendo Data Configuration settings page in Salesforce, object fields with Data Attribute selected for guide targeting. For instructions, see Share Salesforce data with Pendo using the Page Data LWC.
Step 1. Add Page event properties to Pendo
Page event properties are required to map Salesforce data fields to Pendo for guide targeting.
- Go to Product > Pages.
- Select the down arrow next to Tag Pages and choose Manage Page event properties.
- Enter the URL of the record page and then select Launch Designer. This opens the Visual Design Studio.
- Select Add Event Property and enter a name for it using lowercase letters, numbers, and underscores.
- Select Source > Standard CSS.
- For CSS Selector, enter the following:
.active pendo_one-page-data
- For the field labeled Select a value for the element, enter
dataset.
followed by the data attribute name from the Salesforce Page Data LWC, for example,dataset.Object_Field
. For packaged and custom objects and fields, include the Salesforce namespace prefixes, and the object and field suffixes, in the field reference, for example,dataset.Namespace__Object__c__Field__c
. - Select Save.
- Repeat the steps for each Page event property you create.
Step 2. Tag Salesforce record page URLs with Page event properties
Use the Page event properties you created in Pendo to tag record page URLs from Salesforce as Pages in Pendo. For instructions, see Step 3 in Page event properties.
Step 3. Use tagged Pages for guide location settings
From the Location tab of the Visual Design Studio, you can configure guide activation based on Pages tagged with event properties.
- In Pendo, go to Guides > Guides
- Find and open your guide.
- Select Manage in my app. This opens the Visual Design Studio.
- Open the Location tab in the Edit Container window.
- Under Page Location, select Only on this page.
- Choose the page you created with your Page event property in Step 2 from the dropdown menu under Only on this page.
- Select Done in the bottom-right corner of the Edit Container window.
- Select Save and then Exit.