UI Layouts

  • Release version: Washingtondc
  • Updated February 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 in Process Automation Designer

    A UI Layout defines the properties and components displayed when an activity is rendered as a card in a Playbook Experience. Selecting an appropriate UI Layout is essential when creating an activity definition, as it determines the sections and fields available for setting up activity data during runtime.

    Show full answer Show less

    Key Features

    • Create Record: Displays fields for associated records, record details, form information, attachments, and features like SLA and checklist options.
    • Guided Decision: Available with a subscription, includes fields for decision tree execution and instructional content.
    • Instructional: Focuses on associated records and features a simplified activity experience.
    • Knowledge: Provides sections for knowledge records along with associated record fields.
    • List: Organizes data into lists with customizable details and features.
    • Record: Similar to Create Record, includes additional record-specific fields.
    • Record Generator: Automatically creates a record during runtime and redirects users to that new record.

    Key Outcomes

    By correctly associating a UI Layout with your activity definition, you can streamline the user experience in the Playbook. Each layout enhances the functionality and presentation of your activities, ensuring that users have access to the necessary information and actions required to complete their tasks effectively.

    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
    • 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

    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

    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