User security

Permissions

Access to create Highlight Badge Refresh platform events should be added to all users.

There are three permission sets included in the Highlight Badges package.

Permission Set	Description
Highlight Badges Viewer	Ability to view the Highlight Badges component on record pages
Highlight Badges Admin	Highlight Badges Viewer access, plus the ability to configure Highlight Badge Definitions
Highlight Badges Starter Packs Admin	Highlight Badges Admin access, plus access to view, modify, and import Highlight Badges Starter Packs

What a viewer sees

Badges respect the viewer's object, field and sharing access. A badge appears for a user only when they can read:

• the badge's source object and the source records themselves (sharing applies)
• the fields in its Filter Criteria and Order By
• the fields on the Source to Ancestor Path and the Display to Ancestor Path
• any merge fields in its Label or Alert Message

If any of those is unreadable, that badge is hidden for that user and the other badges on the page still show. Source Detail Fields work differently: the details modal shows the detail fields the user can read and leaves out the rest, so a badge with five detail fields shows three to a user who can read three.

A definition in System Mode is the exception: its badge shows regardless of the user's access to the source records, and the details modal and record navigation are withheld instead when the user cannot read the record.

Alternatively, add the following permissions to custom permission sets for each role.

Highlight Badges Viewer

Ability to view the Highlight Badges component on record pages

• Custom Permissions
  • Can View Highlight Badges
• Object Settings (Object Access, Field Level Security, Platform Events and Tabs)
  • Highlight Badge Definition (Read Only)
    • Read Only access to all fields
  • Highlight Badge Action (Read, Create, Edit, Delete)
    • Read Only access to all fields
  • Highlight Badges Refreshes (Read, Create)
• Apex Classes
  • HighlightBadgesController

Highlight Badges Admin

Highlight Badges Viewer access, plus the ability to configure Highlight Badge Definitions

• Assigned Apps
  • Highlight Badges Setup
• Custom Permissions
  • Can View Highlight Badges
  • Can Enable System Mode
• Object Settings (Object Access, Field Level Security, Platform Events and Tabs)
  • Highlight Badge Definition (Read, Create, Edit, Delete)
    • Read/Write access to all fields
  • Highlight Badge Action (Read, Create, Edit, Delete)
    • Read/Write access to all fields
  • Highlight Badges Refreshes (Read, Create)
• Apex Classes
  • HighlightBadgeActionEditorCtrl
  • HighlightBadgeActionsMgrController
  • HighlightBadgesController
  • HighlightBadgeSetupController

Highlight Badges Starter Packs Admin

Highlight Badges Admin access, plus access to view, modify, and import Highlight Badges Starter Packs

• Assigned Apps
  • Highlight Badges Setup
• Custom Permissions
  • Can View Highlight Badges
  • Can Enable System Mode
  • Can Manage Starter Packs
• Object Settings (Object Access, Field Level Security, Platform Events and Tabs)
  • Highlight Badge Definition (Read, Create, Edit, Delete)
    • Read/Write access to all fields
  • Highlight Badge Action (Read, Create, Edit, Delete)
    • Read/Write access to all fields
  • Highlight Badges Starter Packs
    • Tab available and visible
  • Highlight Badges Refreshes (Read, Create)
  • Highlight Badges Deploy Results (Read, Create)
• Custom Metadata Types
  • Badge Action Template
  • Badge Definition Template
  • Highlight Badges Starter Pack
• Apex Classes
  • HighlightBadgeActionEditorCtrl
  • HighlightBadgeActionsMgrController
  • HighlightBadgesController
  • HighlightBadgeSetupController
  • HighlightBadgesStarterPacksCtrl
• System Permissions
  • View Setup and Configuration
  • Modify Metadata Through Metadata API Functions
  • View Roles and Role Hierarchy

Hand-built permission sets

If you built your own permission sets from the lists above before version 1.12, update them:

• Viewers need Read access to the System Mode field on Highlight Badge Definition. The component reads definitions as the running user, so a missing field read hides every badge for that user.
• Admins who should be able to turn System Mode on or off need the Can Enable System Mode custom permission.