Framework Overview

this page provides an overview of embedded help's different components and how they work together as the backend of content creation and managing how embedded help works help is created through the help enable mode, which allows help authors to point and click screen elements and associate them with specific help topics this creates helped page layout and helped element records that define what help appears where, showing up as clickable help icons positioned close to the helped items when clicked, these icons trigger callouts that display the linked help topic content, such as text, images, or videos, providing context specific assistance directly within the user’s workflow example workflow setup & component by using help enable mode, a help icon has been added to the account name field, linking it to a topic id with a tip (" enter your company name here ") a topic viewer is also placed on the page, set to show that topic id in a callout additionaly, a configuration item with log a comment action adds a feedback option in the callout scenario a user visits an account record page interaction the user clicks the icon; a callout pops up with the tip if a reading list is linked, additional steps (e g , " next tip ") will appear appear help enable mode help enable mode is designed for simplicity, allowing help authors to use it without needing coding skills or deep knowledge of salesforce elements further, since it can be opened directly on the page where information is missing, authors can create contextual help as they encounter pages that need it help enable workflow enter help enable mode items that can become help enabled are highlighted in yellow click to select click any highlighted item to toggle help on or off for that element return to view mode select the appropriate option from the same menu confirm changes you'll be prompted to verify your selections before saving or cancelling when you save your selections, the system automatically creates a helped page layout record for the screen being viewed a helped element record for each selected item a draft help topic associated with each helped element after saving, the selected screen elements will have help icons next to them when users click these icons, help callouts will display with the associated help topic content enter help enable mode add an autoform component to the page layout where embedded help is desired select help enable mode from the autoform's tools ( icon) menu enable help on the page (adds a quick access menu to the right gutter) select help enable mode from this menu helped page layouts & help element records helped page layout records represent known page contexts that have been enabled with unaric guide taken together, a helped page layout and its associated helped elements define the help that will be offered to users on a particular page; in other words, they represent the page's contextual help a helped page layout represents a particular type of screen—for example a salesforce record page layout where help is desired helped element records represent the help enabled items on a helped page layout each helped element captures the details of a particular feature on the screen that is to be helped, pointing to exactly one help topic , which may or may not be re used by more than one element flowchart td a\[helped page layout] > b\[helped element] b > c\[help topic] %% explanations a explain >|defines contextual help for a page| b b explain >|each element links to one topic| c c explain >|topics may be reused| c classdef explain fill\ none,color\ gray,stroke dasharray 2 2 helped page layout and helped element records can be created manually just like any other objects in salesforce, but are usually produced automatically through help enabling, the process of adding contextual help using the help enable mode these records also allow to vary the help offered to users based on the data they are viewing—a concept known as data driven help callouts callouts display help materials embedded directly where the user is working via a compact area of screen they provide help on demand by allowing users to show and hide the associated help topic by clicking an icon positioned close to the helped item in callouts, the help is displayed in one of a variety of formats defined by the callout template chosen by the help author to suit their specific needs standard callout templates include summary only one line statements, ideal for field definitions and naming conventions topic text adds rich text content topic details includes media like images or videos help resources lists related resources custom templates are also available contact unaric guide support for setting them up you don't create callouts directly as standalone items rather, you create embedded help for a specific item on a salesforce page in help enable mode