Page collections
Summarize
Summary of Page collections
Page Collections in ServiceNow are groups of pages designed for reuse across multiple digital experiences. They enable you to consolidate and replicate custom pages efficiently, saving time when delivering consistent content to different user groups. These collections can be displayed within modal viewports or tab components, providing flexible ways to present additional information without navigating away from the parent page.
Show less
Page collections operate in a sandboxed environment, meaning they do not have direct access to URL parameters or data resources of the calling page. Instead, they receive data through a specified Controller record passed at runtime, ensuring controlled interaction between the collection and its host page.
Key Features
- Reusability: Create collections of pages or tabs that can be shared across multiple experiences, reducing duplication effort.
- Sandboxed Pages: Ensures that page collections do not directly modify the parent page, maintaining stability and separation of concerns.
- Event Dispatching: Page collections can dispatch events that the parent page listens to, enabling indirect communication and interaction.
- Component Compatibility: Currently supported components include Viewports, Viewport Modals, and Tabs, allowing flexible display options.
- Controller and Data Binding: Requires specification of a controller and binding of data resources to pass necessary information into the collection.
Practical Use and Considerations
- Page collections are created within the ServiceNow platform, accessible from the UI Builder home screen or components that utilize collections.
- When creating a page collection, you must select the component type (Tab or Viewport) and assign a controller to manage data and interactions.
- Data from the parent page must be explicitly bound and routed to the specific page within the collection to be displayed.
- Using viewport modals allows users to view and interact with pages within a collection without leaving the original context, enhancing user experience.
What You Can Expect
By leveraging page collections, ServiceNow customers can efficiently manage shared content across multiple experiences, maintain cleaner page designs through sandboxing, and facilitate user interactions via event-driven communication. This approach streamlines content delivery, reduces redundancy, and improves consistency across your ServiceNow digital experiences.
Page Collections are groups of pages that can be used across multiple experiences.
What is a page collection
Page Collections (sys_ux_extension_point) are groups of pages that are meant to be re-used across multiple experiences. These sets of pages can be used in a modal viewport or in a tabs component. These pages are sandboxed and do not have access to things like URL params or data resources from the page that is calling them. All they have access to is the Controller record that is specified on the Page Collection record and that is passed down by the calling page in runtime.
Page collections are sandboxed inside of the pages they are within, this means that they do not have direct access to change the parent page. However, because of the way seismic works, your page collection page can dispatch an event that the calling page can listen for to take action. This is the only way to achieve a change in the calling page.
Why should you use page collections
Page collections allow you to reuse custom pages across experiences. This will save you time if you need to replicate a page for multiple experiences and help pass information to different groups of users.
You can also use page collections to provide additional information within an existing topic by using a viewport modal. A viewport modal will allow your audience to view pages outside of their experience to make changes without leaving the parent page.
Create collection of tabs that can be shared across experiences. Each tab is an individual page in a page collection.
Where can you use page collections
You can access a page collection from the UI Builder home screen. The list of page collections details which component and type each page collection is.
You can create a page collection from the UI Builder home screen, or from a component that uses page collections.
- Viewports
- Viewport Modals
- Tabs
Things to consider
The page collection creation screen requires a component and controller selection.
Data resources need to be selected to pass information to a page collection. Need to bind data from the parent page.
Need to route to the page in a page collection you want to display in a viewport.
Add a link to creating a page collection.
Page collection on the platform
You create a page collection within the ServiceNow platform. At this time, only the Tab and Viewport component can be used when creating a page collection. You can select a controller or pass controller dependencies using JSON.