Composite & Utility

pre built combinations or wrappers utility 1 ( ihutility1 ) visually, the utility 1 component is a ready made combination of a topic viewer and a tree view however, it also includes a position detector in help cue mode that is able to provide automatic contextualisation and interaction logging if desired whilst it can be deployed in a wide variety of lightning page layouts, utility 1 is particularly suited to use in the utility bar a given utility item can contain only a single lightning component, so it’s useful to have a wrapper that offers the services of several items in one being a combination of components, many of the design parameters of this component are similar to those described elsewhere best used for/key features always on help training hub feedback & sentiment tracking admin insights & deployment tips deploy to utility bar; configure contextualisation rules; collect heat maps & feedback example use cases 'help for this page' everywhere in salesforce expected business outcomes immediate adoption gains higher user satisfaction tree collapse tools at ( treemaxlistingtools ) the maximum number of tools to display against each node of the utility 1's tree sub component enter a positive integer to display that number of tools (maximum) before collapsing to an ellipsis enter 1 to always show all available tools without collapsing to an ellipsis enter 0 (zero) to always collapse to an ellipsis menu, tree enable drand and drop ( treeddallowed ) controls the drag and drop behaviour of the utility 1's tree sub component for more details, refer to the tree component's enable drag and drop parameter contextualisation listens to ( pdlistensto ) see details under common attributes contextualisation component id ( pdpositioninggroup ) see details under common attributes note that utility 1 uses the value provided to set the component ids of its tree and topic viewer sub components if component id is set to myutility1 utility 1’s tree will have a component id of myutility1 tree utility 1’s topic viewer will have a component id of myutility1 topic contextualisation navigation checking interval ( pdcontextcheckinterval ) use with due regard for machine resources enter zero unless re contextualisation is required enter a number greater than zero (representing milliseconds) to check for changes in user context (page address) periodically and issue related re contextualisation instructions to this component's tree view and topic viewer minimum recommended interval is 1000 contextualisation auto open utility item ( poputilitybar ) if using this component in the utility bar, check this box to pop it open when contextualisation messages are received contextualisation log interaction ( pdlogcontextinteraction ) see log context interaction under position detector contextualisation help context ( pdhelprecordid ) see ‘help context’ under position detector tree max depth ( treemaxdepth ) see ‘max depth’ under tree view tree node provider ( treenodeprovider ) see ‘node provider’ under tree view tree node icon style ( treenodeiconstyle ) see ‘node icon style’ under tree view tree display density ( treedisplaydensity ) see ‘display density’ under tree view tree suppress node tools ( treesuppresslistingtools ) see ‘suppress node tools’ under tree view general allow popout ( supportspopout ) when used in the utility bar, set to true (tick the box) to enable utility 1 to be 'popped out' into a separate window general tool context ( toolcontext ) see details under common attributes general root topic ( rootnode ) id of the record to be used as the ' root ' of the tree view (and the initial item displayed on the topic viewer) on this component general left column width ( columnratio ) default width of the left hand (tree view) component of this utility, as a percentage select from 33, 40 or 50 percent if setting this attribute via parameters to the improved help lightning out host (the ihluxouthost visualforce page), values should be passed without the percentage sign, for example /apex/iahelp ihluxouthost?nsapp=iahelp\&app=appih\&nscomp=iahelp\&comp=ihutility1\&parms=pdpositioninggroup ihluxapp utilbar^columnratio 40^height 2^suppressheaders true^suppressfooters true^treesuppresslistingtools true^rootnode \[topic id] general layout ( formfactor ) controls the overall appearance of the component, which can be useful in limited screen real estate scenarios, such as mobile layouts set to single column to switch between tree and topic viewer when navigating use standard to show both components at all times general suppress headers ( suppressheaders ) & footers ( suppressfooters ) these parameters operate as described under common attributes however, these parameters are named in the plural because they control the headers and footers of both the tree view and the topic viewer forming the utility 1