UI Layouts

  • Release version: Xanadu
  • Updated August 1, 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 UI Layouts

    UI Layouts define the properties and components used when an activity renders as a card in a Playbook Experience within ServiceNow. When creating an activity definition, selecting the appropriate UI Layout determines the sections and fields available for configuration. These configurations directly influence how activity data is presented and interacted with during runtime in a Playbook.

    Show full answer Show less

    Playbooks include several default UI Layouts to accommodate different activity types, each offering specific configurations suited to their purpose.

    Key UI Layouts and Their Configuration Sections

    • Create Record: Enables configuration of associated records, status, record details (such as tagline, icon, title, and description), forms, attachments, and features like SLA, checklist visibility, and automation status. This layout is used by the default Create Record activity.
    • Questionnaire: Similar to Create Record but tailored for questionnaire activities with fields for associated records, experience status, record details, forms, attachments, and features.
    • Instructional: Focuses on displaying instructional content, including associated record info, status, record details, footer, and automation feature.
    • Knowledge: Designed for knowledge-based activities, featuring associated record info, knowledge tables and records, record details, footer, and automation flag.
    • List: Supports list-based activities with fields for associated records, status, record and list details (including table, query, UI view, columns, and row count), and automation.
    • Record: Offers comprehensive configuration including associated record, experience status, record details, form, attachments, and features such as SLA, checklist, and automation.
    • Record generator: Automates record creation during runtime and redirects users to the newly created record. Configuration includes template fields, process definition scoped name, associated table, and form view.
    • Guided Decision: Available with App Engine or Customer Service Management subscriptions, supporting decision tree execution and related tasks.

    Practical Application and Benefits

    By choosing the appropriate UI Layout for your activity definition, you tailor the Playbook Experience to fit the activity’s function and user interaction requirements. This ensures that users see relevant information and controls during playbook execution, enhancing usability and efficiency.

    All UI Layouts except Record generator display an Associated Record section, facilitating linkage to relevant records. The variety of layouts supports diverse use cases—from creating records, presenting questionnaires, delivering instructional content, managing knowledge, to automating record generation and decision-making processes.

    Configurations made in Workflow Studio under the UI Layouts tab directly impact how activities appear and behave in running Playbooks, ensuring consistency between design and runtime experience.

    A UI Layout describes what properties and components to use when an activity renders as a card in a Playbook Experience.

    When creating an activity definition, you must select an UI Layout to associate your activity definition with. Playbooks come with the following UI Layouts that are available in your instance by default:
    • Create Record
    • Questionnaire
    • Instructional
    • Knowledge
    • List
    • Record
    • Record generator
    Depending on the UI Layout associated with the activity, different sections and fields appear under the activity definition's Activity Experience. These sections and fields let you set up the activity data that renders during the runtime Playbook Experience.
    Note:
    All UI Layouts, except for Record generator, display an Associated Record section. For information on how to set up or edit the Associated Record section in an activity definition, see Create an activity definition.

    Create Record

    If you choose the Create Record UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Details
    Displays the following fields:
    • Tagline
    • Icon
    • Title
    • Description
    • Pending State Title
    • Pending State Description
    • Record fields
    • Footer
    Form
    Displays the following fields:
    • Form View
    • Form fields
    • Template Fields
    Attachments
    Displays the following fields:
    • Attachment source
    • Attachments read only
    Features
    Displays the following fields:
    • Show SLA
    • Show Checklist
    • Is Automated
    The Create Record activity that comes with the application uses this UI Layout.
    Figure 1. In an activity definition
    UI Layout fields in an activity definition that uses the Create Record UI Layout
    In Workflow Studio, the fields are configured on the UI Layouts tab of the side panel:
    Figure 2. In Workflow Studio
    UI Layout fields in the side panel of an activity that uses an activity definition that uses the Create Record UI Layout, in Workflow Studio
    Note:
    To learn more about configuring out-of-the-box activities in Workflow Studio, find activity reference documentation in Playbooks reference.
    In a running playbook, your configurations are reflected:
    Figure 3. In a running playbook, also called a Playbook Experience
    An activity for creating a record in a running playbook, also called the Playbook Experience, as configured in the UI Layout fields in Workflow Studio

    Questionnaire

    If you choose the Questionnaire UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Details
    Displays the following fields:
    • Tagline
    • Icon
    • Title
    • Description
    • Pending State Title
    • Pending State Description
    • Record fields
    • Footer
    Form
    Displays the following fields:
    • Form View
    • Form fields
    Attachments
    Displays the following fields:
    • Attachment source
    • Attachments read only
    Features
    Displays the following fields:
    • Show SLA
    • Show Checklist
    • Is Automated

    Instructional

    If you choose the Instructional UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Details
    Displays the following fields:
    • Tagline
    • Icon
    • Title
    • Description
    • Footer
    Features
    Displays the following field: Is Automated

    Knowledge

    If you choose the Knowledge UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Knowledge
    Displays the following fields:
    • Knowledge Table
    • Knowledge Record
    Details
    Displays the following fields:
    • Title
    • Footer
    Features
    Displays the following field: Is Automated

    List

    If you choose the List UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Details
    Displays the following fields:
    • Tagline
    • Icon
    • Title
    • Description
    • Record fields
    List Details
    Displays the following fields:
    • List Title
    • Table
    • List Query
    • UI View
    • Columns
    • Max Columns
    • Row Count
    Features
    Displays the following field: Is Automated

    Record

    If you choose the Record UI Layout, the following sections appear in the Activity Experience section for your activity definition:

    Associated Record
    Displays the following fields:
    • Associated table
    • Associated record
    • Experience Status Table
    • Experience Status Record
    Details
    Displays the following fields:
    • Tagline
    • Icon
    • Title
    • Description
    • Pending State Title
    • Pending State Description
    • Record fields
    • Footer
    Form
    Displays the following fields:
    • Form View
    • Form fields
    Attachments
    Displays the following fields:
    • Attachment source
    • Attachments read only
    Features
    Displays the following fields:
    • Show SLA
    • Show Checklist
    • Is Automated

    Record generator

    Activities with a Record generator UI Layout create a record during runtime, and redirect users to the record. For example, in this activity, after an agent selects the Continue button, a record is created and they are taken to that new record.
    Record generator activity during runtime
    If you choose the Record generator UI Layout, the following sections appear in the Activity Experience section for your activity definition:
    • Template Fields
    • Process Definition Scoped Name
    • Associated Table
    • Form View

    Guided Decision

    Note:
    The Guided Decision UI Layout is available with a subscription to App Engine or Customer Service Management (CSM). For more information on how to enable this activity for use in Playbooks, see Activate Playbooks for Customer Service Management (CSM).
    If you choose the Guided Decision UI Layout, the following fields appear in the Activity Experience section for your activity definition:
    • Decision Tree Execution
    • Decision Tree