Contextual & Interaction Tools

tools for detecting context, logging interactions, launching flows, displaying notifications, or tagging/metadata management they enable dynamic responses to user actions or page contexts position detector ( ihposdetect ) this component can log context interactions and issue contextualisation messages to which other components can respond the position detector appears in the tool palette like our other lightning components, but has a different icon style to mark it out from other components this is because it often has no visible user interface once delivered to a lightning page instead the component remains hidden reporting positioning and context information to other components that may need it best used for/key features help request mode cue (hidden tracking) help button component generator mobile ready admin insights & deployment tips hidden cue for analytics (user analytics integration); visible ‘?’ for on demand help; supports labels and placement options example use cases track flow completion or capture 'help requested' clicks expected business outcomes actionable adoption data targeted training button text width ( helpbuttontextwidth ) for the help button role, sets the width of the optional text area in pixels if the button text attribute is empty, this setting is ignored if button text is shorter than sufficient to fill the specified width, the button will occupy the specified width regardless if button text is longer than will fit in the specified width, behaviour is dependent upon text wrapping settings as set via the button text style attribute button position ( helpbuttonposition ) for the 'help button' role, controls button positioning this positioning attribute affects the help button (icon and any optional text) as a whole note that whatever position is chosen, the button will always remain within the column of the lightning page layout into which the position detector was placed select from left the button is aligned to the left of its column right the button is aligned to the right of its column above left / above right the button is aligned to the left or right as appropriate, but also slightly higher than normal, such that it does not (as it usually would) slightly overlie the following component inline button is aligned left in cases where button text style allows wrapping such that the height of the button increases, inline position forces other page content down the page, preventing overlaps button text style ( helpbuttontextstyle ) for the 'help button' role, controls how optional text wraps this attribute is useful where one wishes to use button text of more than a few words combined with button text width and button position, this attribute can be used to control line wrapping behaviour select from ellipsis text will be allowed to grow to button text width but will not wrap if there is too much text to display in the available space, the text will be truncated and an ellipsis ( ) displayed to highlight this fact wrap 100 percent text will wrap when it reaches the width of the containing lightning page layout column and the height of the button area will grow accordingly this setting does not work with the inline setting of the button position attribute wrap fixed width text will wrap when it reaches the width specified by the button text width attribute button text size ( helpbuttontextsize ) for the 'help button' role, sets the font size of optional text select from small, medium or large font size button text ( helpbuttontext ) for the help button role, optional text to display alongside the icon note that any specified text always appears to the left of the button icon for string options, please refer to related button text design attributes log context interaction ( logcontextinteraction ) check this box (set attribute to true) to log a help interaction when context messages are issued for the help cue and help button roles, check this box to log a help interaction event when context messages are issued (i e , every time the button is clicked or the cue is triggered) help context ( helprecordid ) information defining any contextual request to issue for the help cue and help button roles, information defining the contextual request to issue for example, a help topic id (if a help listing is the response) or (for fixed energy) the api name of an object positioning group ( positioninggroup ) an identifier that will be included along with page content information in any help interaction or contextual events for help and button roles, an identifier not equipping the all position detector is made that they can collaborate to identify the bounds of areas of this screen for help button and help cue roles, an identifier that will be included along with page content information in any help interaction module this detector is to generate other help components should include this value as part of their 'listen it' or parameter in order to respond when contextual events and interactions from the detector fire this parameter can be any adjustments' value (the screen) that is unique to the pair of detectors on the current screen positioning role ( positioningrole ) defines the overall function that the position detector will perform defines the overall function that the position detector will perform options are help button in this role, the position detector will manifest to end users as a button offering help for the context it serves when a user clicks this, other components (such as help listings or topic viewers) that are configured to 'listen' to messages from this detector will refresh to show related help data help cue in this role, the position detector behaves in the same way as for the help button role, however no button is shown and the user need not interact directly to trigger context interactions are logged and contextualisation messages fired as soon as the detector comes into existence when placed on a salesforce related list tab, for example, context fires every time that tab is selected by the user component generator in this role, the position detector manifests as an icon only button (no text) when the button is clicked, a component of a help author's choosing (for example, a topic viewer or utility 1) can be made to appear below the button subsequent clicks of the button toggle the visibility of this component, allowing users to 'summon' help in situ, then hide it and continue working help authors have access to a "design" mode allowing them to select the component they wish to generate, set its attributes then save their settings as of version 1 53, top and bottom roles have been deprecated and can no longer be selected quick access menu ( ihqam ) the qam allows full help facilities to be made available via the addition of a single component that floats in place, so is always within reach, yet occupies minimal real estate the qam manifests as a handle in the right hand gutter of the page, allowing users to open/close a help menu at will to obtain a variety of information it offers a number of help listings, which can be selected via a drop down; the qam remembers the user's selection and retains it between page refreshes and across page layouts, so the listing most relevant to the user is selected when they open the menu best used for/key features minimal deployment contextual help index experience cloud friendly knowledge sign posting admin insights & deployment tips add globally or per object; configure ‘help for this page’ mode example use cases qam on accounts for one click help expected business outcomes reduced training time higher user satisfaction topic labelling option ( rowlabellingoption ) controls the fields to display for help topic listings in the qam for help topic listings that are featured in the qam, the fields to display for each row options are element name topic name topic name (element type) topic name start automatically ( startautomatically ) when checked, qam is populated on page load uncheck this box to populate help lists only as the qam is opened this will improve page load times, but will result in a slight delay when opening dialogue display mode ( dialoguemode ) controls the way in which certain options, such as the reading list viewer, are displayed select from modal options are displayed as pop up, lightning modal style (lightboxed) dialogues in qam options are listed within the body of the qam itself tagged content settings ( listingtagfilters ) defines the filters to show via the qam's tagged items listing option help index layout ( formfactor ) if a help index is to be made available, specify the form factor of the resulting utility 1 the quick access menu now includes an embedded copy of 'utility 1' (see elsewhere in this documentation) which can display a hierarchic index of help topics if a help index is to be made available, specify whether to use the standard (tree and topic side by side) or single column (switch between tree and topic) layout help index root topic ( rootnode ) if a help index is to be made available, specify the id of the record to be used as the root the quick access menu now includes an embedded copy of ‘utility 1’ (see elsewhere in this documentation) which can display a hierarchic index of help topics if a help index is to be made available, specify the id of the record to be used as the root of the tree of topics to display default menu option ( defaultmenuoption ) choose whether to display the 'help for this page' listing or the 'help index' (requires a help index root topic) when users first open the qam collapse tools at ( maxlistingtools ) pass through parameter to control the behaviour of the qam’s listing component see the identically named parameter of the listing component for more details show shortcuts ( negotiatetoolbars ) check this box to provide shortcuts to menu tools in the qam handle applies to header and ellipsis tools only to feature items in the handle in this way, set the relevant configuration item record’s “negotiate toolbar level” to 1 flow launcher ( ihflowlauncher ) launch one of a selection of salesforce flows relevant to a particular page context flow launcher, in conjunction with helped element records, offers users the ability to launch one of a selection of salesforce flows that help authors deem relevant to a particular page context best used for/key features contextual flow access launch multiple flows reusable across topics admin insights & deployment tips place on help pages or utility bar; launch modally or in a new tab; reduces flow placement limits example use cases ‘submit case’ flow launched from help panel expected business outcomes faster process execution greater flow reuse flow parameters ( theflowparams ) optionally, provide input parameter values for the specified flow parameters specified via this design parameter are ignored in favour of those provided via helped element records when flow name is set to \[context] each parameter should be in the form name¬data type¬value use a pipe (|) to separate multiple parameters eg myfirstparameter¬string¬hello world!|parameter2¬number¬27 in addition to the parameters sent to the flows being offered, the launcher component itself offers an optional ‘dialoguemode’ parameter that can be set using a syntax similar to the above to control how individual flows will be launched dialoguemode¬¬newtab launches the flow in a new browser tab dialoguemode¬¬lightbox launches the flow in a modal dialogue dialoguemode¬¬inplace (default) launches the flow in situ on the page, within the bounds of the flow launcher component flow name ( theflowname ) api name of the salesforce flow you wish to launch via this component enter \[context] to prompt the user to select a flow from those available to the current help layout the list of available flows is defined using helped element records, as follows switch to the improved help for lighting app select the helped page layouts tab if not already produced for the page on which you wish to feature the flow launcher (for example, by creating context help using help enable mode on the help autoform or quick access menu), create a helped page layout record for each contextual flow that is to be offered to users, create a helped element record, as follows helped page layout as created above identifier the api name of the flow helped element name the label to display next to the option button representing this flow element type contextual flow parameters optional parameters to supply to this flow when launching format is as described under ‘flow parameters’ nudge ( ihnudge ) the nudge component displays messages to the user on arrival on a page in a variety of formats the text of the message can be fixed or derived from details of a help topic selected at random from a specified pool of tagged items in fixed text mode the page author specifies the title and / or subtitle text to display clicking the nudge dismisses it in random pool topic mode the page author specifies the pool of topics from which to select nudges topic name and summary text will be shown clicking the nudge opens full topic details in the help portal best used for/key features page hints & tips data driven page alerts onboarding new users process alerts sales promotions / compliance reminders service duplicate case alerts admin insights & deployment tips add to key object pages; configure via tagged help topics or record criteria; can show random help tips or data driven warnings example use cases alert a sales rep when an opportunity close date is overdue warn service agent if another case exists for same customer expected business outcomes drives action and compliance improves customer experience raises data quality nudge period ( nudgeperiod ) determines the number of hours during which nudges are counted toward the max nudges limit if max nudges is set to a number greater than zero, it tracks how many nudges are shown within this time period to decide if the maximum has been reached for example, to remind users of something a maximum of twice in any given week, enter max nudges 2 nudge period 168 (24 x 7) max nudges ( maxnudges ) number of nudges to issue to a user within the nudge period before ceasing to display this component zero (0) = keep nudging indefinitely auto hide after ( autohidetime ) hides the nudge automatically after the number of milliseconds entered by entering zero, one can specify that the nudge is to remain in position until positively dismissed by the user (by clicking on the close icon or, in fixed mode,by clickingon the text) animation speed ( animationspeed ) controls the speed at which the nudge bar animates into the specified “vertical range” position enter the number of milliseconds this is to take vertical range the depth in pixels (y axis extent) to which nudge bar should animate (ymax) typically, you would use a comparatively small number to display a less critical message or a larger one (which will position the nudge in a more “invasive” position) to inform users of critical information nudges always slide into view from the top of the screen callout option ( calloutoption ) for non fixed nudges only, controls how to respond to item clicks options are topic selected event only nudge issues a contextualisation message to which other components may respond topic selected event plus topic view issues a contextualisation message, but also opens the relevant help topic in a new browser tab palette ( selectedpalette ) controls the visual styling of the nudge area as a whole, based on recommended slds palettes available options are error info offline warning selected style ( selectedstyle ) controls the overall appearance of the nudge bar styles are based on those recommended by salesforce in slds for a scoped notification as of this release, the options are alert nudge is full screen width toast nudge occupies a fractional portion of the screen, towards the left fixed title and fixed sub title ( currenttname & currenttsummary ) enter text into either or both of these fields to ignore the specified scope / topic pool and show a fixed message scope ( rootnode ) the scope attribute sets the id of a topic that defines a tag pool, which is a group of tagged help topics this determines which topics the nudge component can display as notifications if you leave the fixed title and fixed sub title fields blank, the nudge will randomly pick from this tag pool to show different messages tags ( ihtags ) this component can be used to tag help topics with metadata (by relating them to “tag” topics) or search for tagged items best used for/key features knowledge base taxonomy content app filters admin insights & deployment tips create tag topics and link to help topics; use consistent taxonomy example use cases tag content by role or region for filtered views expected business outcomes faster search re usable content selected style ( selectedstyle ) styling option to apply to selected tags the available styles are a subset of salesforce’s lightning design system recommended colours allow cloud editing ( allowcloudediting ) check this box to allow authorised users to edit the tags that feature in the selected cloud this includes adding a delete icon to each tag, allowing its removal from the cloud enabling the control as a drop zone topics can be added to the pool by dragging their names from listings or topic viewer controls allow cloud selection ( allowcloudselection ) controls if tag pool / cloud selection is available check this box to allow authorised users to select the tag cloud to display scope ( rootnode ) the scope attribute requires the record id of a help topic that defines a tag cloud, which is a group of tagged members this determines the content displayed by this component based on the tag cloud’s members the component will display a tag lozenge for each help topic that has a member type help relationship linking to this topic mode ( cardconfig ) controls the behaviour of this control when its contents are clicked the tag component can operate in one of two different ways in search mode, tag lozenge clicks fire a filtering event that listening components (lists) are able to use to re query their content, displaying only items that are tagged with the selected item(s) in associate mode, lozenge clicks toggle the relevant meta tag on and off for the scoped record in this mode, the tagging control should “listen” to a component that includes current record information, such as a topic viewer