Configuration Items

configuration items are special records in salesforce that let you customize how lightning components in improved help work they control things like drop down menus, header tools, tool menus, and row level tools in lists you can set them up to change what users see or do, like adding custom buttons or limiting access setup when setting up unaric guide in a new salesforce org, visit the help settings page to initialize or upload configuration items these are regular salesforce records that can be imported or exported in various ways, and unaric guide provides tools to help with this download configuration items on the global settings page, click download json to export all configuration item records (except those with skip export set to true ) as a json file, ready for use in another helped org upload configuration items save the exported json file as a salesforce document, paste its view file url into the json location text box on the global settings page, then click upsert configuration tools to overwrite existing records (except those with prevent import overwrites set to true ) initialize configuration items leave the json location box at its default value and click upsert configuration tools to reset configuration items to the default values from your improved help release available configuration items item description action code the “message” raised when the configuration item is clicked our component framework code “understands” a certain set of these messages as at any given release examples of the meaning of certain of the current set of known action codes include “log a comment” and “show a callout” the effect of this is that orgs can control how action messages are raised (the particular clickable that raises it / its look, feel and positioning etc) but cannot dynamically add new messages (or if they do, they cannot usefully be processed as they will not be understood) icon class defines the icon to display for a given clickable note that only certain clickable types include icons (e g , dropdowns do not, whereas ellipsis tools do) the class is, in fact, the name of an icon from the set provided by “font awesome” (see the searchable list provided here http //fontawesome io/icons/ http //fontawesome io/icons/ ) label defines the text displayed alongside the tool these can be plain english text, but need to be internationalisation “codes” for multilingual environments description descriptive text describing the purpose and functioning of the configuration tool display grouping not currently used display order positions the tool in the collection within which it appears for example, the lowest numbered drop down tool appears at the top of its drop down list has divider for dropdown and ellipsis tools only, places a horizontal dividing line above the tool when set to “true” icon content text to overlay over the icon displayed for a tool for example, the add / remove bookmark tools use “ ” and “ ” respectively, overlaid on the base bookmark icon that both use permission level defines which user types have access to a given tool options are 1 = all helped users 2 = analysts or above 4 = authors or above 8 = administrator only prevent import overwrites used to control configuration item import behaviour as a rule when uploading configuration tools via the button on the settings page, all existing items are deleted and overwritten by the new records set this flag to true on a configuration item record to prevent it from being overwritten in this way negotiate toolbar level specify a positive integer to allow this item to feature in lists of tool “shortcuts”, such as those presented via the handle of quickaccess menu components whose “show shortcuts” option is ticked skip export used to control configuration item export behaviour as a rule when downloading configuration tools via the button on the settings page, all items are exported to the resulting json text file set this flag to true on a configuration item record to prevent it from being downloaded this is useful when creating tools for local use only that one does not wish to migrate between orgs supporting controls for tools of type = header only, a string defining additional controls that are required to support the action implied when the tool is clicked for example, the “search” header tool requires an associated search text box in order to function for each supporting tool, the string is in the general form shown below id type label placeholder text value ^ id is the html unique id for the supporting control type defines the broad type of supporting control recognised types are text produces a text entry control drop target produces an area that accepts drop events as part of drag and drop operations draggable produces an area that can be dragged as part of drag and drop operations label is an optional text label to display to the left of the control placeholder text is the text to show when no value is present in the control (for certain types only) value is the default value to place in the control the capek (^) is used to separate each required supporting control spaces have been added to the model for clarity the actual string is delimited by tildes ( ) and capeks only tip text the tool tip, internationalised as per label tool class can be used to style individual tools as an example, tool class is used to differentiate the appearance (colour) of the add and remove bookmark tools tool context controls which of each type of tool appear in which of our lightning components for example, it is possible to have one set of ellipsis tools on the help topic viewer and a different set on the listing component select from one of the following pick list values \[hidden] can be used to temporarily hide a particular tool builder reserved for future use cardhelptopic the help topic viewer cardreadinglists the list when listing type = reading lists cardrelatedhelp the list when listing type = related help cardrelatedtags the tagging control in associate mode cardresources the list when listing type = relatedresources cardstickies the list when showing my help notes cardtags thetagging control in search mode cardtree the tree viewer fixedhelp the list when listing type =fixed imageviewer the image viewer newsticky tools to show on entry to the help notes creationscreen qam the quick access menu rlviewer the reading list viewer note when diagnostics are enabled (see elsewhere in this document) clicking the text in the footer of a given card will show a message that includes the tool context and action code that were involved in the last operation performed by it tool filter for listing tools only, controls the record types that should feature the tool, as follows 1 = tool should appear against rows onall listtypes 0 = n/a configuration tool record is not of type= listing 1 = help topics 2 = bookmarks 4 = reading lists andreadinglist entries 8 = resources 16 = help relationships 32 = search results 64 = help notes(“stickies”) the numbers can be added together as required for example, to feature a tool on lists of help topics or search results, enter 33 (1 32) type defines the positioning of the configuration tool, as per the screen shot at the head of this table options are drop down, ellipsis, header, listing note that these are pick list values so must be entered precisely as shown the following values are also possible but not currently in use footer extension