Component glossary¶
Every component in the Highlight Badges managed package (namespace bdgs), by type. For how these components fit together, see Architecture.
Highlight Badges Component Glossary¶
Project Doc: Highlight Badges
Apps¶
Highlight Badges Setup¶
Lightning App to configure Highlight Badge Definitions and create or import Highlight Badges Starter Packs.
Aura Components¶
newHighlightBadgeDefinition¶
Override for New Highlight Badge Definition standard action.
Platform Cache Partitions¶
HighlightBadges¶
Unique visits for a user to a particular record page are cached and later referenced to assess whether or not to display active alerts in highlight badge definitions. 3MB of Provider Free session cache are allocated to the HighlightBadges partition.
Content Assets¶
SerkinSolutionsLogo¶
Lightning app logo.
Static Resources¶
HighlightBadgesLogo¶
Used in icons for invocable actions in Flow Builder.
Documents¶
Highlight Badge Images (Folder)¶
Images used in custom tab icons.
- SerkinSolutions Logo
FlexiPages¶
Highlight Badge Definition Record Page¶
Highlight Badges Setup UtilityBar¶
Highlight Badges Starter Pack¶
Custom Permissions¶
Can Enable System Mode¶
Allows a user to turn System Mode on or off for a Highlight Badge Definition. Granted by the Highlight Badges Admin and Starter Packs Admin permission sets and enforced by the EnforceSystemModePermission validation rule.
Can Manage Starter Packs¶
Allows a user to import and create Highlight Badges Starter Packs.
Can View Highlight Badges¶
Required custom permission for any users accessing the Highlight Badges component on record pages. Checked on the server as well as in the component.
Custom Objects¶
Highlight Badge Definition¶
Configuration for an individual highlight badge. A Highlight Badge Definition record describes the criteria for, appearance, and behavior of displayed badges.
Highlight Badge Action¶
An available action for a highlight badge definition. A configured action can be launched from a button in the badge’s details modal, as well as in configured modal alerts.
Custom Metadata Types¶
Highlight Badges Starter Pack¶
Highlight Badges Starter Packs provide predefined sets of badge configurations, enabling users to quickly deploy collections of Highlight Badges in their Salesforce environments.
Badge Definition Template¶
Badge Definition Template custom metadata creates Highlight Badge Definition records when imported.
Badge Action Template¶
Badge Action Template custom metadata creates Highlight Badge Action records when imported.
Platform Event Channels¶
Highlight Badges Refresh¶
Publish refresh events to refresh Highlight Badges components displaying badges referencing a particular record.
Highlight Badges Deploy Result¶
The result of a metadata deployment, including status, error messages, and deployment job details. Subscribed to by the highlightBadgesStarterPack component using the empApi.
Lightning Web Components¶
confetti¶
Handles confetti. Uses js-confetti library and solution from Mario Pavicic and Salesforce Labs.
https://www.npmjs.com/package/js-confetti
https://github.com/loonywizard/js-confetti/blob/main/LICENSE
https://admin.salesforce.com/blog/2019/introducing-salesforcecelebration
flowRunner¶
Runs screen flows from detail or alert modals.
highlightBadge¶
A custom lightning-badge implementation.
highlightBadgeActionEditor¶
Create and edit a particular Highlight Badge Action.
highlightBadgeActionsManager¶
Manage related Highlight Badge Actions from a Highlight Badge Definition record page.
highlightBadgeActionsManagerModal¶
Modal implements the highlightBadgeActionEditor component.
highlightBadgeActionsPanel¶
A menu of badge actions, displayed in the highlightBadgesDetailModal and highlightBadgesAlertsModal components.
highlightBadgeDefinitionCreator¶
New button override for the Highlight Badge Definition object. A guided wizard for highlight badge definition creation. Mostly intended to remove the clutter of Highlight Badge Definition record details so that the user can engage with these from the components on the lightning record page.
highlightBadgeDefinitionCreatorModal¶
A modal for the highlightBadgeDefinitionCreator component on the New button override.
highlightBadgeDesigner¶
Guided input to set the text, colors, and icon for a highlight badge.
highlightBadgeObjectWizard¶
A setup wizard for configuring a highlight badge definition’s objects and relationships.
highlightBadgeObjectWizardButton¶
Launches the highlightBadgeObjectWizard modal.
highlightBadgePreview¶
Preview the display of a Highlight Badge Definition.
highlightBadges¶
Record page display component of highlight badges.
highlightBadgesAlertsModal¶
Displays modal alerts and related actions when a record page loads.
highlightBadgesAppPage¶
Wrapper for App Pages to resolve the Display Record ID.
highlightBadgesDetailModal¶
Modal to display badge details and related actions.
highlightBadgesExperienceCloud¶
Wrapper for Experience Cloud pages to resolve the Display Record ID.
highlightBadgesStarterPacks¶
Import Highlight Badges Starter Packs custom metadata into Highlight Badge Definition data. Convert Highlight Badge Definition data to starter packs.
iconPicker¶
A type-ahead combobox of SLDS icons.
Implements Eric Smith's contribution to UnofficialSF's FlowScreenComponentsBasePack: fsc_pickIcon
He credits it as based on code in a Salesforce Labs App (Activity Timeline)
lwcUtils¶
Common utilities for lwc. Show toast alerts and handle errors.
newHighlightBadgeDefinitionContainer¶
Container launches modal and handles navigation.
starterPackBuilder¶
Enter starter pack details and select Highlight Badge Definitions to include in a new starter pack.
starterPackBuilderModal¶
Hosts the starterPackBuilder component.
starterPackPreviewer¶
Preview the contents of a highlight badges starter pack. Import starter packs that have not yet been imported.
starterPackPreviewModal¶
Hosts the starterPackBuilder component.
Apex Classes¶
GlobalDescribeService¶
Caches global describe results.
HighlightBadge¶
Data wrapper to represent an individual highlight badge.
HighlightBadgeAction¶
Data wrapper to represent a highlight badge action. Create an empty object, or pass either a highlight badge action or a badge action template custom metadata to the constructor to set all properties.
HighlightBadgeActionEditorCtrl¶
Controller for the highlightBadgeActionEditor LWC.
HighlightBadgeActionService¶
For a single highlight badge action
- Retrieve all record details for an sobject
- Get a HighlightBadgeAction representation of an sobject
- Upsert changes for an action through the highlight badge action editor
HighlightBadgeActionsMgrController¶
Controller for the highlightBadgeActionsManager LWC.
HighlightBadgeDefinition¶
Data wrapper representation of a highlight badge definition.
HighlightBadgeDefinitionSelector¶
Query for highlight badge definitions with child highlight badge actions. Unifies field selection across the application.
HighlightBadgeQueryBuilder¶
Used to construct queries from Highlight Badge Definition configuration.
HighlightBadgeRecordQuery¶
Runs the record queries for definitions in System Mode. Declared without sharing and querying in system mode, so these queries ignore the running user's object, field and sharing access; kept to one class so every such query is easy to review.
HighlightBadgesConfettiInvocable¶
Resource for Flow Builder to trigger confetti for a record page.
HighlightBadgesController¶
Controller for the highlightBadges LWC.
HighlightBadgeSetupController¶
Controller for highlight badge definition configuration.
HighlightBadgeSetupService¶
Service class provides schema information for highlight badge definition configuration.
HighlightBadgesException¶
Generic exceptions in Highlight Badges.
HighlightBadgesRefreshInvocable¶
Resource for Flow Builder to refresh Highlight Badges components that are referencing a provided record id. This could be the display object, or records referenced in any of the active badges.
HighlightBadgesService¶
The HighlightBadgesService provides badges relevant to a particular user and record page.
HighlightBadgesStarterPacksCtrl¶
Controller for the highlightBadgesStarterPacks LWC.
MetadataDeploy¶
Deploy changes to custom metadata configuration.
StarterPack¶
Represents a highlight badges starter pack custom metadata - a collection of badge definition templates and child badge definition actions. Can be imported to create highlight badge definition data.
StarterPackDeployRequest¶
Data wrapper for new starter packs created from sobject equivalents. Represents the details of the Starter Pack custom metadata and the record ids of the highlight badge definitions to bundle.
StarterPackMetadataBuilder¶
Converts a collection of HighlightBadgeDefinition objects into Badge Definition Template and child Badge Action Template custom metadatas.
StarterPackMetadataDeployer¶
Service for the deployment of Starter Pack custom metadata from a list of Highlight Badge Definition sObjects.
StarterPackService¶
Used when importing starter packs. Provides starter pack data with definition and action templates.
Util¶
Common utilities.
- Handle namespaces in dev vs qa/prod environments.
- Generate api safe names for custom metadata.
Permission Sets¶
Highlight Badges Admin¶
Ability to configure Highlight Badge Definitions
Highlight Badges Viewer¶
Ability to view the Highlight Badges component on record pages
Table of Components¶
| Name | Type | Object | Notes |
|---|---|---|---|
| BadgeActionTemplate | Apex Class | ||
| GlobalDescribeService | Apex Class | Caches global describe results | |
| GlobalDescribeService_Test | Apex Class | @IsTest | |
| HighlightBadge | Apex Class | Data wrapper to represent an individual highlight badge | |
| HighlightBadgeActionEditorCtrl | Apex Class | ||
| HighlightBadgeActionEditorCtrl_Test | Apex Class | @IsTest | |
| HighlightBadgeActionService | Apex Class | ||
| HighlightBadgeActionService_Test | Apex Class | @IsTest | |
| HighlightBadgeActionsMgrController | Apex Class | ||
| HighlightBadgeActionsMgrController_Test | Apex Class | @IsTest | |
| HighlightBadgeDefinition | Apex Class | ||
| HighlightBadgeDefinition_Test | Apex Class | @IsTest | |
| HighlightBadgeDefinitionSelector | Apex Class | Queries highlight badge definitions with their actions | |
| HighlightBadgeDefinitionSelector_Test | Apex Class | @IsTest | |
| HighlightBadgeQueryBuilder | Apex Class | Used to construct queries from Highlight Badge Definition configuration | |
| HighlightBadgeQueryBuilder_Test | Apex Class | @IsTest | |
| HighlightBadgeRecordQuery | Apex Class | Runs the record queries for definitions in System Mode (without sharing, system mode) | |
| HighlightBadgesController | Apex Class | Controller for the highlightsBadges lwc | |
| HighlightBadgesController_Test | Apex Class | @IsTest | |
| HighlightBadgeSetupController | Apex Class | Controller for the highlightBadgeSetup component | |
| HighlightBadgeSetupController_Test | Apex Class | @IsTest | |
| HighlightBadgeSetupService | Apex Class | Provides schema information for highlight badge definition configuration | |
| HighlightBadgeSetupService_Test | Apex Class | @IsTest | |
| HighlightBadgesService | Apex Class | The HighlightBadgesService provides badges relevant to a particular user and record page | |
| HighlightBadgesService_Test | Apex Class | @IsTest | |
| HighlightBadgesStarterPacksCtrl | Apex Class | ||
| HighlightBadgesStarterPacksCtrl_Test | Apex Class | @IsTest | |
| MetadataDeploy | Apex Class | ||
| MetadataDeploy_Test | Apex Class | @IsTest | |
| StarterPack | Apex Class | ||
| StarterPackDeployRequest | Apex Class | ||
| StarterPackMetadataBuilder | Apex Class | Converts badge definitions into starter pack templates | |
| StarterPackMetadataBuilder_Test | Apex Class | @IsTest | |
| StarterPackMetadataDeployer | Apex Class | Deploys starter pack custom metadata | |
| StarterPackMetadataDeployer_Test | Apex Class | @IsTest | |
| StarterPackService | Apex Class | ||
| StarterPackService_Test | Apex Class | @IsTest | |
| TestDataFactory | Apex Class | @IsTest | |
| Util | Apex Class | Highlight Badges utilities. Handle namespaces in dev vs qa/prod environments. | |
| newHighlightBadgeDefinition | Aura Component | Override for New Highlight Badge Definition standard action | |
| Account_View_Case_Record | Badge Action Template | Badge Action Template | View Record action for Account: Open Case definition template |
| Contact_View_Case_Record | Badge Action Template | Badge Action Template | View Record action for Contact: Open Case for Account definition template |
| Account_Open_Case | Badge Definition Template | Badge Definition Template | Included in Quick Start Highlight Badges Starter Pack |
| Contact_Birthday_Badge | Badge Definition Template | Badge Definition Template | Included in Quick Start Highlight Badges Starter Pack |
| Contact_Open_Case_for_Account | Badge Definition Template | Badge Definition Template | Included in Quick Start Highlight Badges Starter Pack |
| Highlight_Badge_Definition_Compact_Layout | Compact Layout | Highlight Badge Definition | |
| SerkinSolutionsLogo | Content Asset | SerkinSolutions logo | |
| Highlight_Badges_Setup | Custom Application | Configure highlight badges | |
| Active__c | Custom Field | Badge Action Template | Checkbox |
| Badge_Definition_Template__c | Custom Field | Badge Action Template | Metadata Relationship (Badge Definition Template) |
| Description__c | Custom Field | Badge Action Template | Text Area (255) |
| Flow_API_Name__c | Custom Field | Badge Action Template | Text (80) |
| Flow_Type__c | Custom Field | Badge Action Template | Picklist - Autolaunched Flow or Screen Flow |
| Highlight_Badge_Action_Name__c | Custom Field | Badge Action Template | Text (80) - The name of the Highlight Badge Action record |
| Icon_Name__c | Custom Field | Badge Action Template | Text (80) - Use icon names from the SLDS library (e.g. utility:actions_and_buttons) |
| Icon_Position__c | Custom Field | Badge Action Template | Picklist - Left and Right |
| Include_Display_Record_ID__c | Custom FIeld | Badge Action Template | Checkbox - If checked, the Record ID of the current Display Object record the user is viewing will be provided to the displayRecordId input variable. |
| Include_Source_Record_ID__c | Custom Field | Badge Action Template | If checked, the Record ID of the badge's source record will be provided to the sourceRecordId input variable. |
| Label__c | Custom Field | Badge Action Template | Text (255) |
| Navigation_Type__c | Custom Field | Badge Action Template | View Source Record and Web Page |
| Open_in_New_Tab__c | Custom Field | Badge Action Template | Checkbox - For Web Page navigation type actions, indicates whether the destination should be opened in a new tab |
| Record_Type__c | Custom Field | Badge Action Template | Picklist - Flow, Navigation |
| Sort_Order__c | Custom Field | Badge Action Template | Number (3,2) Determines the order in which the action appears for its highlight badge. Lowest numbers appear first; null values appear last. |
| URL__c | Custom Field | Badge Action Template | Text (255) |
| Variant__c | Custom Field | Badge Action Template | Picklist - The variant of the button that launches the action |
| Active__c | Custom Field | Badge Definition Template | Checkbox - A highlight badge definition must be active to be displayed on record pages |
| Alert_Frequency__c | Custom Field | Badge Definition Template | Picklist - Determines how often an alert will be shown to a particular user. |
| Alert_Message__c | Custom Field | Badge Definition Template | Long Text Area (5,000) - When Alert is checked, this message displays in the pop-up window a page loads. Use {!My_Custom_Field__c} syntax to display merged values from the child object |
| Alert_Type__c | Custom Field | Badge Definition Template | Picklist - Modal/Toast |
| Alert__c | Custom Field | Badge Definition Template | Checkbox - If checked, an alert will display to the user when the page loads |
| Background_Color__c | Custom Field | Badge Definition Template | Text (6) - The hexadecimal number for the background color of the displayed badge |
| Common_Ancestor_Object__c | Custom Field | Badge Definition Template | Text (100) - The API Name of the Salesforce object that serves as a shared ancestor or linking object between the Display Object and the Source Object |
| Confetti_Size__c | Custom Field | Badge Definition Template | Picklist - The size of the confetti items |
| Confetti_Volume__c | Custom Field | Badge Definition Template | Picklist - The quantity of confetti |
| Confetti__c | Custom Field | Badge Definition Template | Checkbox - If checked, confetti will rain when the page loads |
| Description__c | Custom Field | Badge Definition Template | Text Area (255) |
| Display_Object__c | Custom Field | Badge Definition Template | Text (100) - The API Name of the Salesforce object (e.g., Contact, Account, Opportunity) where the Highlight Badge will appear |
| Display_to_Ancestor_Path__c | Custom Field | Badge Definition Template | Text (255) - The API path from the Display Object to the Common Ancestor Object |
| Filter_Criteria__c | Custom Field | Badge Definition Template | Long Text Area (5,000) - Additional criteria to include in the WHERE clause of the SOQL query |
| Highlight_Badge_Definition_Name__c | Custom Field | Badge Definition Template | Text (80) - The name of the Highlight Badge Definition record |
| Highlight_Badges_Starter_Pack__c | Custom Field | Badge Definition Template | Metadata Relationship (Highlight Badges Starter Pack) |
| Icon_Name__c | Custom Field | Badge Definition Template | Text (100) - Use icon names from the SLDS library (e.g. utility:alert) |
| Include_Label_in_Toast__c | Custom Field | Badge Definition Template | Checkbox - If checked, the Label will be displayed as the toast's title. |
| Label_Color__c | Custom Field | Badge Definition Template | Text (6) - The hexadecimal number for the label text color of the displayed badge |
| Label__c | Custom Field | Badge Definition Template | Text (255) - The label of the displayed badge. Use {!My_Custom_Field__c} syntax to display merged values from the source object. |
| Limit__c | Custom Field | Badge Definition Template | Number (6,0) - The maximum number of badges to show for this badge definition |
| Order_By__c | Custom Field | Badge Definition Template | Text (255) - Optionally, define the order in which badges are displayed (e.g. LastModifiedDate DESC) |
| Sort_Order__c | Custom Field | Badge Definition Template | Number (3,2) - Determines the order in which badges of this type will appear. Lowest numbers appear first; null values appear last. |
| Source_Detail_Fields__c | Custom Field | Badge Definition Template | Long Text Area (5,000) - Enter API field names, separated by commas, for any fields from the Source Object that should be displayed when a user selects a badge |
| Source_Object__c | Custom Field | Badge Definition Template | Text (100) - The API Name of the Salesforce object that is the source of the badge information. For example, a badge on a contact record displaying open cases would have a Source Object of 'Case'. |
| Source_to_Ancestor_Path__c | Custom Field | Badge Definition Template | Text (255) - The API path from the Source Object to the Ancestor Object |
| Toast_Mode__c | Custom Field | Badge Definition Template | Picklist - Determines how persistent the toast is. Valid values are: dismissible (default), remains visible until you click the close button or 3 seconds has elapsed, whichever comes first; pester, remains visible for 3 seconds and disappears automatically. No close button is provided; sticky, remains visible until you click the close button. |
| Toast_Variant__c | Custom Field | Badge Definition Template | Picklist - Changes the appearance of the notice. Toasts inherit styling from toasts in the Lightning Design System. Valid values are: info (default), success, warning, and error. |
| Visible_to_External_Users__c | Custom Field | Badge Definition Template | Checkbox - If checked, generated badges will be displayed to external users on Experience Cloud pages |
| Visible_to_Guest_Users__c | Custom Field | Badge Definition Template | Checkbox - If checked, generated badges will be displayed to unauthenticated guest users on Experience Cloud pages |
| Active__c | Custom Field | Highlight Badge Action | Checkbox |
| Flow_API_Name__c | Custom Field | Highlight Badge Action | Text (80) |
| Flow_Type__c | Custom Field | Highlight Badge Action | Picklist - Autolaunched Flow or Screen Flow |
| Highlight_Badge_Definition__c | Custom Field | Highlight Badge Action | Master-detail (Highlight Badge Definition) |
| Icon_Name__c | Custom Field | Highlight Badge Action | Text (80) - Use icon names from the SLDS library (e.g. utility:actions_and_buttons) |
| Icon_Position__c | Custom Field | Highlight Badge Action | Picklist - Left and Right |
| Include_Display_Record_ID__c | Custom FIeld | Highlight Badge Action | Checkbox - If checked, the Record ID of the current Display Object record the user is viewing will be provided to the displayRecordId input variable. |
| Include_Source_Record_ID__c | Custom Field | Highlight Badge Action | If checked, the Record ID of the badge's source record will be provided to the sourceRecordId input variable. |
| Label__c | Custom Field | Highlight Badge Action | Text (255) |
| Legacy_ID__c | Custom Field | Highlight Badge Action | Text (255) |
| Navigation_Type__c | Custom Field | Highlight Badge Action | View Source Record and Web Page |
| Open_in_New_Tab__c | Custom Field | Highlight Badge Action | Checkbox - For Web Page navigation type actions, indicates whether the destination should be opened in a new tab |
| Sort_Order__c | Custom Field | Highlight Badge Action | Number (3,2) Determines the order in which the action appears for its highlight badge. Lowest numbers appear first; null values appear last. |
| URL__c | Custom Field | Highlight Badge Action | Text (255) |
| Variant__c | Custom Field | Highlight Badge Action | Picklist - The variant of the button that launches the action |
| Active__c | Custom Field | Highlight Badge Definition | Checkbox - A highlight badge definition must be active to be displayed on record pages |
| Alert_Frequency__c | Custom Field | Highlight Badge Definition | Picklist - Determines how often an alert will be shown to a particular user. |
| Alert_Message__c | Custom Field | Highlight Badge Definition | Long Text Area (5,000) - When Alert is checked, this message displays in the pop-up window a page loads. Use {!My_Custom_Field__c} syntax to display merged values from the child object |
| Alert_Type__c | Custom Field | Highlight Badge Definition | Picklist - Modal/Toast |
| Alert__c | Custom Field | Highlight Badge Definition | Checkbox - If checked, an alert will display to the user when the page loads |
| Background_Color__c | Custom Field | Highlight Badge Definition | Text (6) - The hexadecimal number for the background color of the displayed badge |
| Common_Ancestor_Object__c | Custom Field | Highlight Badge Definition | Text (100) - The API Name of the Salesforce object that serves as a shared ancestor or linking object between the Display Object and the Source Object |
| Confetti_Size__c | Custom Field | Highlight Badge Definition | Picklist - The size of the confetti items |
| Confetti_Volume__c | Custom Field | Highlight Badge Definition | Picklist - The quantity of confetti |
| Confetti__c | Custom Field | Highlight Badge Definition | Checkbox - If checked, confetti will rain when the page loads |
| Description__c | Custom Field | Highlight Badge Definition | Text Area (255) |
| Display_Object__c | Custom Field | Highlight Badge Definition | Text (100) - The API Name of the Salesforce object (e.g., Contact, Account, Opportunity) where the Highlight Badge will appear |
| Display_to_Ancestor_Path__c | Custom Field | Highlight Badge Definition | Text (255) - The API path from the Display Object to the Common Ancestor Object |
| Filter_Criteria__c | Custom Field | Highlight Badge Definition | Long Text Area (5,000) - Additional criteria to include in the WHERE clause of the SOQL query |
| Icon_Name__c | Custom Field | Highlight Badge Definition | Text (100) - Use icon names from the SLDS library (e.g. utility:alert). Utility icons will match the badge label color. Standard/Custom/Action icons use their native colors. |
| Include_Label_in_Toast__c | Custom Field | Highlight Badge Definition | Checkbox - If checked, the Label will be displayed as the toast's title. |
| Label_Color__c | Custom Field | Highlight Badge Definition | Text (6) - The hexadecimal number for the label text color of the displayed badge |
| Label__c | Custom Field | Highlight Badge Definition | Text (255) - The label of the displayed badge. Use {!My_Custom_Field__c} syntax to display merged values from the source object. |
| Legacy_ID__c | Custom Field | Highlight Badge Definition | Text (255) |
| Limit__c | Custom Field | Highlight Badge Definition | Number (6,0) - The maximum number of badges to show for this badge definition |
| Order_By__c | Custom Field | Highlight Badge Definition | Text (255) - Optionally, define the order in which badges are displayed (e.g. LastModifiedDate DESC) |
| Sort_Order__c | Custom Field | Highlight Badge Definition | Number (3,2) - Determines the order in which badges of this type will appear. Lowest numbers appear first; null values appear last. |
| Source_Detail_Fields__c | Custom Field | Highlight Badge Definition | Long Text Area (5,000) - Enter API field names, separated by commas, for any fields from the Source Object that should be displayed when a user selects a badge |
| Source_Object__c | Custom Field | Highlight Badge Definition | Text (100) - The API Name of the Salesforce object that is the source of the badge information. For example, a badge on a contact record displaying open cases would have a Source Object of 'Case'. |
| Source_to_Ancestor_Path__c | Custom Field | Highlight Badge Definition | Text (255) - The API path from the Source Object to the Ancestor Object |
| System_Mode__c | Custom Field | Highlight Badge Definition | Checkbox - Shows this badge to every user who can see the page, ignoring their object, field and sharing access to the badge's source records. Changing it requires the Can Enable System Mode permission. |
| Toast_Mode__c | Custom Field | Highlight Badge Definition | Picklist - Determines how persistent the toast is. Valid values are: dismissible (default), remains visible until you click the close button or 3 seconds has elapsed, whichever comes first; pester, remains visible for 3 seconds and disappears automatically. No close button is provided; sticky, remains visible until you click the close button. |
| Toast_Variant__c | Custom Field | Highlight Badge Definition | Picklist - Changes the appearance of the notice. Toasts inherit styling from toasts in the Lightning Design System. Valid values are: info (default), success, warning, and error. |
| Visible_to_External_Users__c | Custom Field | Highlight Badge Definition | Checkbox - If checked, generated badges will be displayed to external users on Experience Cloud pages |
| Visible_to_Guest_Users__c | Custom Field | Highlight Badge Definition | Checkbox - If checked, generated badges will be displayed to unauthenticated guest users on Experience Cloud pages |
| Error_Message__c | Custom Field | Highlight Badges Deploy Result | Text (10,000) |
| Job_ID__c | Custom Field | Highlight Badges Deploy Result | Text (18) |
| Status__c | Custom Field | Highlight Badges Deploy Result | Text (255) - required - The status of the deployment (e.g., Success, Partial Success, Failure) |
| Record_ID__c | Custom Field | Highlight Badges Refresh | Text (18) - Required - Components with badges referencing this record are refreshed |
| Author__c | Custom Field | Highlight Badges Starter Pack | Text (255) - The creator of this starter pack |
| Documentation_URL__c | Custom Field | Highlight Badges Starter Pack | Text (255) - A link to documentation on this starter pack |
| Icon_Name__c | Custom Field | Highlight Badges Starter Pack | Text (80) - The SLDS icon to display for this starter pack |
| Imported__c | Custom Field | Highlight Badges Starter Pack | Checkbox - Indicates that this starter pack has already been imported |
| Badge_Action_Template__mdt | Custom Metadata Type | Badge Action Template | A template for a customizable action associated with a Highlight Badge that allows for user interaction and automated tasks |
| Badge_Definition_Template__mdt | Custom Metadata Type | Badge Definition Template | Template for an individual highlight badge configuration |
| Highlight_Badges_Starter_Pack__mdt | Custom Metadata Type | Highlight Badges Starter Pack | A collection of quick start highlight badges for import |
| Highlight_Badge_Action__c | Custom Object | Highlight Badge Action | A customizable action associated with a Highlight Badge that allows for user interaction and automated tasks |
| Highlight_Badge_Definition__c | Custom Object | Highlight Badge Definition | Configuration for an individual highlight badge |
| Can_Enable_System_Mode | Custom Permission | Allows a user to turn System Mode on or off for a Highlight Badge Definition | |
| Can_Manage_Starter_Packs | Custom Permission | Allows a user to import and create Highlight Badges Starter Packs | |
| Can_View_Highlight_Badges | Custom Permission | Allows a user to view Highlight Badges component on record pages | |
| SerkinSolutions_Logo | Document | Custom tab icon | |
| Highlight_Badge_Definition_Record_Page | FlexiPage | Highlight Badge Definition | |
| Highlight_Badges_Starter_Packs | FlexiPage | Import Highlight Badges Starter Packs custom metadata | |
| Highlight_Badge_Action_Editor | Flow | Guided wizard for configuring highlight badge actions | |
| Highlight_Badges_Images | Folder | Document Folder | |
| Quick_Start_Badges | Highlight Badges Starter Pack | Highlight Badges Starter Pack | |
| confetti | Lightning Web Component Bundle | ||
| flowRunner | Lightning Web Component Bundle | Runs screen flows from details or alerts modals | |
| flowSelector | Lightning Web Component Bundle | A picklist enabled for flow builder to allow selection of a flow | |
| highlightBadge | Lightning Web Component Bundle | A custom lightning-badge implementation | |
| highlightBadgeActionEditor | Lightning Web Component Bundle | Create and edit highlight badge actions | |
| highlightBadgeActionsManager | Lightning Web Component Bundle | Manage related Highlight Badge Actions from a Highlight Badge Definition record page | |
| highlightBadgeActionsManagerModal | Lightning Web Component Bundle | ||
| highlightBadgeActionsPanel | Lightning Web Component Bundle | A menu of badge actions | |
| highlightBadgeDefinitionCreator | Lightning Web Component Bundle | A guided wizard for highlight badge definition creation | |
| highlightBadgeDefinitionCreatorModal | Lightning Web Component Bundle | ||
| highlightBadgeDesigner | Lightning Web Component Bundle | Set the text, colors, and icon for a highlight badge | |
| highlightBadgeObjectWizard | Lightning Web Component Bundle | ||
| highlightBadgeObjectWizardButton | Lightning Web Component Bundle | Launches highlightBadgeObjectWizard modal | |
| highlightBadgePreview | Lightning Web Component Bundle | Preview the display of a Highlight Badge Definition | |
| highlightBadges | Lightning Web Component Bundle | Record page display component of highlight badges | |
| highlightBadgesAlertsModal | Lightning Web Component Bundle | Displays modal alerts when a record page loads | |
| highlightBadgesAppPage | Lightning Web Component Bundle | Wrapper for App Pages to resolve the Display Record ID | |
| highlightBadgesDetailModal | Lightning Web Component Bundle | Modal to display badge details and offer record navigation | |
| highlightBadgesExperienceCloud | Lightning Web Component Bundle | Wrapper for Experience Cloud pages to resolve the Display Record ID | |
| highlightBadgesStarterPacks | Lightning Web Component Bundle | Import Highlight Badges Starter Packs custom metadata | |
| iconPicker | Lightning Web Component Bundle | ||
| newHighlightBadgeDefinitionContainer | Lightning Web Component Bundle | Container launches modal and handles navigation | |
| starterPackPreviewModal | Lightning Web Component Bundle | Preview the contents of a highlight badges starter pack | |
| All | List View | Highlight Badge Definition | |
| Badge_Action_Template_Layout | Page Layout | Badge Action Template | |
| Badge_Definition_Template_Layout | Page Layout | Badge Definition Template | |
| Default_Layout | Page Layout | Highlight Badge Action | |
| Flow_Layout | Page Layout | Highlight Badge Action | |
| Navigation_Layout | Page Layout | Highlight Badge Action | |
| Highlight_Badge_Definition_Layout | Page Layout | Highlight Badge Definition | |
| Highlight_Badges_Starter_Pack_Layout | Page Layout | Highlight Badges Starter Pack | |
| Highlight_Badges_Admin | Permission Set | Ability to configure Highlight Badge Definitions | |
| Highlight_Badges_Starter_Packs_Admin | Permission Set | Highlight Badges Admin access, plus access to view, modify, and import Highlight Badges Starter Packs | |
| Highlight_Badges_Viewer | Permission Set | Base access to view Highlight Badges on record pages | |
| HighlightBadges | Platform Cache Partition | Used to store page visits for a given user and record, to allow for limits on the frequency of alerts | |
| Highlight_Badges_Refresh__e | Platform Event | Highlight Badge Refresh | Publish refresh events to refresh Highlight Badges components displaying badges with references to a particular record |
| Highlight_Badges_Deploy_Result__e | Platform Event | Highlight Badges Deploy Result | Publishes the result of a metadata deployment, including status, error messages, and deployment job details. |
| Flow | Record Type | Highlight Badge Action | Launch a flow |
| Navigation | Record Type | Highlight Badge Action | Navigation to an internal or external URL |
| Highlight_Badge_Definition | Tab | Highlight Badge Definition | Icon: SerkinSolutions_Logo |
| Highlight_Badges_Starter_Packs | Tab | App Page. Icon: SerkinSolutions_Logo | |
| EnforceHexColorFormat | Validation Rule | Highlight Badge Definition | Enforce format with leading '#' and valid hexadecimal string |
| EnforceRequiredFieldsForActivation | Validation Rule | Highlight Badge Definition | Ensure all required fields have values before a highlight badge definition can be activated. This record is not ready for activation. Ensure the definition has a label and all objects and relationship paths are defined. |
| EnforceSystemModePermission | Validation Rule | Highlight Badge Definition | Only users with the Can Enable System Mode custom permission can turn System Mode on or off, including on a new or cloned record. Only users with the Can Enable System Mode permission can change System Mode. |