Quick Start Guide
1. Setup in Lightning App Builder
To add the carousel to your page:
- Navigate to the Lightning App Builder for your designated Home Page.
- Locate the Component: In the left-hand menu, under Custom - Managed, find
carouselbanner. - Placement: Drag and drop the component onto your page layout.
- Configuration: On the right-hand panel, set the following:
- Number of Items Per Page: Define how many banners are visible at once (e.g., 3).
- Name of App: Enter the exact API name of the app where this should appear (e.g.,
Service_Console).
- Visibility: Use the Set Component Visibility section to add filters if you only want specific users or profiles to see the banner.
2. Managing Banner Content
Content is managed via Custom Metadata Types. This allows you to update the carousel without editing the page layout.
Accessing Records
- Go to Setup.
- Search for and select Custom Metadata Types.
- Find PSC Carousel Banner Item and click Manage Records.
Adding/Editing an Item
Click New or Edit on a record to configure the following fields:
| Section | Field | Description |
| General | Label / Name | Internal identification for the record. |
| Display Order | The numerical sequence in which the banner appears. | |
| App Name Filter | Ensures the item only shows in specific apps (e.g., Service Console). | |
| Header | Image | The URL for the banner's background image. |
| Body | Title | The main heading displayed on the banner. |
| Body Content | A brief description or announcement text. | |
| YouTubeEmbedURL | (Optional) Link to embed a video directly. | |
| Footer | Button Label / Link | Define the text and destination for up to two action buttons. |
3. Best Practices
- Keep it Current: Use the Deactivated checkbox in the metadata record to hide seasonal or expired announcements without deleting the data.
- Monitor Layout: Ensure your images have consistent aspect ratios for a professional look.
- Test Visibility: Always verify that the
App Name Filterin the metadata matches theName of Appin the App Builder to ensure content displays correctly.