Creating pages and page variants

  • Release version: Washingtondc
  • Updated April 18, 2024
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Creating pages and page variants

    This guide provides instructions on creating and customizing pages and page variants in the UI Builder for CSM Configurable Workspace. You can build pages from scratch, use templates, or duplicate existing variants to tailor experiences for specific audiences.

    Show full answer Show less

    UI Builder Terminology

    • Workspace experience: A collection of web pages with settings and routes that users interact with, defined by a unique URL.
    • Page: A layout and component collection displaying information, each with a unique name and URL.
    • Page variant: A version of a page with distinct settings for different audiences, accessible via the same URL.
    • Page template: A base structure that accelerates page creation and maintains consistency.

    Methods for Creating Pages and Page Variants

    • Create a page from scratch: Begin with a blank page and customize layouts and components.
    • Create a page from a template: Use a predefined structure to speed up development; the page becomes active immediately with basic settings.
    • Create a page variant: Duplicate an existing page to create a targeted experience with specific audience conditions and display rules.

    Determining Which Page to Use

    CSM Configurable Workspace displays the active record page with the lowest order number by default. Page settings prioritize conditions and audience roles, determining visibility and access. If no user roles are assigned to a variant, it is accessible to all users.

    You can create new pages or customize existing pages in UI Builder to display table and record information in CSM Configurable Workspace.

    When you create a page in UI Builder, you have the option to create a page from scratch, create a page from a template, or you can duplicate and modify a page variant.

    UI Builder terminology

    The following table describes the UI Builder terminology around workspace experiences, pages and page variants, and page templates.
    Table 1. UI Builder terminology
    Term Description
    Workspace experience A workspace experience in UI Builder is a collection of web pages. Users use these pages to interact with an application.

    A workspace experience includes experience settings, routes, page variants, and the audience and conditions required for each variant.

    A workspace experience resides at a specific URL. When an admin creates a workspace experience, they define the web address for the experience and the homepage that the experience uses.
    Page A page is a collection of layouts and components that display information in a workspace.
    • A page has a unique name.
    • A page has a unique URL. The page contains content that resides at this URL.
    • A page includes components that display data from tables and records.
    Page variant A page variant is a version of a page that has unique settings, including audience, conditions, and order.
    • Admins can create variants of pages to target experiences for different audiences at the same URL.
    • When a user opens a page URL, the variant that they see is based on these settings.

    You can create a page variant if you want to use the same page and make minor changes for a different audience. For example, you can create a landing page for customer service agents and a variant of that landing page for customer service managers.
    Page template A page template provides a base structure for a page that you can customize to meet your needs.

    Using a page template can help you create pages faster and keep pages consistent within an experience.

    Page templates can include components, data resources, and a layout.

    Methods for creating pages and page variants

    There are different ways to create pages and page variants in UI Builder.
    Table 2. Methods for creating pages and page variants
    Method Description
    Create a page from scratch When you create a page from scratch, you start with a blank page and select layouts and components that guide a user through an experience.

    Components are like building blocks that you can add to the page and then customize to build the page functionality.
    Create a page from a template When you create a page from a template, you start with a base structure, including layouts and components. From this starting point, you can customize the page to meet your needs.
    When you create a page from a template:
    • The page is automatically active.
    • The page includes basic settings.
    • The first variant of the page is also created. You can add settings such as conditions and audience to the variant.

    For example, when you create a page from the Front-line case page template, the page includes only basic settings. It does not include the same settings as the Front-line case page variant that is provided out of box.
    Create a page variant When you create a page variant, you create a variation of a page that exists at the same path.

    When you create a page by duplicating a variant, the new page inherits the variant settings.

    By creating a page variant, you can target an experience for a specific audience and add conditions that determine when the variant is shown.
    • The audience determines who uses the page variant. For example, you can limit the audience to a specific user role.
    • The conditions determine when a page is shown. For example, you can add a condition for records from a specific table, such as the Case table.
    For more information about customizing record pages, see Manage UI Builder pages and page variants.

    Determining which page to use

    Each record page has an order number. CSM Configurable Workspace uses the active record page with the lowest order number as the default page. When the system displays a record in CSM Configurable Workspace, it uses this default page to display the record information.

    Additionally, the system looks at the page settings in this order:
    1. Conditions (i.e., table)
    2. Audience (the user roles that have access to the page)

    If a page variant has no assigned user roles, then every role can access it.

    For more information, see Set record page order.