Page collections
Summarize
Summary of Page collections
Page Collections in ServiceNow are groups of reusable pages designed to be deployed across multiple experiences. These collections enable consistent use of custom pages in various components such as modal viewports and tabs, providing a streamlined way to share content without duplicating effort.
Show less
Each page collection is sandboxed, meaning it does not have direct access to the parent page’s URL parameters or data resources. Instead, it relies on a specified Controller record to receive data and can communicate changes back to the calling page via event dispatching, ensuring controlled interaction and security.
Key Features
- Reusable Sets of Pages: Group multiple pages for repeated use across different experiences, saving development time.
- Sandboxed Environment: Restricts direct access to parent page data, enhancing encapsulation and modularity.
- Event-Based Communication: Allows page collections to trigger events that the calling page can handle, enabling indirect interaction.
- Supports Multiple Components: Page collections can be embedded in Viewports, Viewport Modals, and Tabs components.
- Controller-Driven Data Passing: Data is passed into collections via a Controller record or JSON dependencies, ensuring controlled data flow.
- Modal Viewport Usage: Enables users to view and interact with pages in modals without leaving the parent page.
- Tabbed Content Management: Facilitates creation of tab collections where each tab is an individual page, shareable across experiences.
Practical Use and Considerations
- Page collections are created within the ServiceNow platform, accessible from the UI Builder home screen or relevant components.
- When creating a page collection, you must select the component type (Tab or Viewport) and the Controller to manage data passing.
- Data binding from the parent page to the page collection is required to ensure necessary information is available.
- Routing to specific pages within a collection is necessary when displaying content in viewports.
- Page collections are ideal for replicating pages across multiple user groups and enhancing existing topics with additional, modular information.
What You Can Expect
By leveraging page collections, ServiceNow customers can efficiently reuse and maintain consistent pages across diverse experiences. This capability supports improved user engagement through modular content presentation, reduces redundancy in page creation, and empowers users to interact with complex information via modals or tabs without navigating away from their current context.
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.