Configure dynamic related records

  • Release version: Zurich
  • Updated July 31, 2025
  • 5 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 Configure dynamic related records

    ServiceNow system administrators can configure thedynamic related recordsfeature to display contextually relevant records in the Related Records tab within the Customer Service Management (CSM) Configurable Workspace. These related records dynamically update based on the current record or playbook activity, providing agents with timely and pertinent information to enhance case resolution and workflow efficiency.

    Show full answer Show less

    Key Concepts and Components

    • Related Record Context: Defines the scenario or context (such as a customer service case or playbook activity) where related records should appear. It includes the record’s table, specific conditions to evaluate at runtime, and the types of related records to display.
    • Related Record Definition: Specifies the particular data type to retrieve and display (e.g., SLAs, emails, escalations). Multiple definitions can be associated with a single context.
    • Context Related Record Definition: Links context records to their associated related record definitions, controlling which related data is shown depending on the active context and conditions.
    • At runtime, the system evaluates the current record or activity against defined contexts and conditions, dynamically retrieving and displaying the appropriate related records.

    Configuration Tasks

    Administrators configure dynamic related records through these main tasks:

    • Set up related record contexts and definitions to identify which related records should be shown for various cases or playbook activities.
    • Customize the card layout of related records using Entity View Action Mapper (EVAM), which standardizes display of different data types in cards and lists by using view configurations and JSON-based view templates.
    • Define the maximum number of related records displayed to optimize workspace usability.

    Use of EVAM for Display

    The Related Records tab displays information using EVAM, a ServiceNow AI Platform application. EVAM allows administrators to:

    • Modify existing view configurations or create new ones to select which fields appear on cards.
    • Leverage the dynamicrelatedrecordsbundle configuration bundle included with the plugin, which contains predefined view configurations and templates for dynamic related records.

    Included Related Record Definitions

    The Dynamic Related Records for Configurable Workspace plugin provides several predefined related record definitions for case records, such as:

    • SLAs: Shows SLA details like stage, start time, and business time left.
    • Emails: Displays case-related emails with subject, recipient, notification type, and date created.
    • Escalations: Displays escalations linked to the case, account, or contact, including state and severity.
    • Blocked By: Lists blocking tasks affecting the case.
    • Child Cases: Shows related child cases with key information like number and short description.

    Administrators can make these definitions available to agents by adding them to the related records shared page in UI Builder.

    Benefits for ServiceNow Customers

    • Enables dynamic, context-aware display of related records, improving agent productivity and decision-making.
    • Customizable configurations allow tailoring the related information to specific business processes and playbook activities.
    • Standardized card-based display via EVAM ensures consistent and user-friendly presentation of related data.

    System administrators can configure the dynamic related records feature to display related records in the contextual side panel in CSM Configurable Workspace. These records dynamically change based on the context of the current record or playbook activity.

    Configuring the dynamic related records feature involves several types of records. See the following table for details about these record types.
    • Related record contexts
    • Related record definitions
    • Context related record definitions
    Table 1. Dynamic related record types
    Record type Description
    Related record context
    Defines the context in which related records appear in the Related Records tab. You can create a related record context for the following types of records:
    • A source record, such as a customer service case
    • A playbook activity, such as adding additional members to an onboarding case
    A context record identifies the following information:
    • The table that contains the type of record for which related records are being configured.
    • Additional conditions that apply to the selected table. These conditions determine if the related record definitions for the selected table are executed at runtime.
    • The types of related records to display, such as SLAs or emails.
    Related record definition

    Identifies one specific type of data to be retrieved, such as SLAs or active contracts.

    You can create a related record definition for each type of data to include in the Related Records tab and then associate one or more definitions with a context record.
    Context related record definition

    Defines the relationship between a context record and its associated definition records.

    When you open a context record, you can see the associated definition records in the Context Related Record Definitions related list.
    For more information about these tables, including field descriptions, see Dynamic related record tables.

    How the context and definition records work

    The context record defines the context in which related records appear in the Related Records tab. This includes conditions to apply to the selected record type. For example, to create a context record for an onboarding playbook activity:
    1. Select the table that stores the activity: Activity Execution [sys_pd_activity_context].
    2. Define additional conditions that apply to the selected table:
      • [Activity.Process definition] [is] [Onboarding playbook]
      • [Activity] [is] [Add additional members]
      These conditions determine if the related record definitions for the selected table are executed at runtime. If the conditions evaluate to true, the definitions are executed. If false, the definitions are ignored. If a context has no conditions, this evaluates to true.
    3. Select the related record definitions to execute: Additional Members
    At runtime, the system checks to see if there are related record contexts that match the current record or playbook activity.
    • When it finds a match, the system evaluates the conditions defined in the context.
    • If the conditions evaluate to true, the system executes the related record definitions for the context.
    To continue with the example above, an agent using the Case Playbook for Onboarding is currently working on the activity to add additional members. The system performs the following actions to display the correct related records:
    • Checks the active contexts and finds Onboarding Additional Members.
    • Evaluates the conditions in the context and determines that they evaluate to true.
    • Executes the Additional Members related record definition.
    • Retrieves and displays the correct set of records from the table identified in the Additional Members related record definition. In this case, the Related Party [sn_customerservice_related_party] table.

    The definition record uses a script to define which related records are retrieved based on the context. This record also includes the table where the related record data is stored. At runtime, the script evaluates the context of the current record or playbook activity, along with any conditions, and dynamically displays the related record data.

    Dynamic related record configuration tasks

    Configuring the dynamic related records feature includes the following tasks:
    • Configure the related record contexts and definitions to identify which related records to display in the Related Records tab.
    • Configure the card layout for the records displayed in the Related Records tab.
    • Configure the maximum number of related records to display.

    Related Records list card layout

    Records appear in the Related Records tab in a card format. This format is created with Entity View Action Mapper (EVAM), a ServiceNow AI Platform application that standardizes how different data sources display in cards and lists.

    EVAM uses view configurations and view templates to determine how information for each type of related record is displayed.
    • EVAM view configuration: Combines conditions, the table and table fields, and declarative actions with an associated view template.
    • EVAM view template: Contains the JSON used to give the necessary information for the card display and use.

    EVAM view configurations can be grouped together to create configuration bundles. The Dynamic Related Records for Configurable Workspace plugin includes a configuration bundle, dynamic_related_records_bundle, which contains view configurations and view templates for the dynamic related records feature.

    The system administrator can modify the view configurations in the dynamic_related_records_bundle or create new view configurations. This includes selecting the fields that are displayed on the card for each type of record. For more information, see:

    Related record definitions included with the plugin

    The Dynamic Related Records for Configurable Workspace plugin includes several related record definitions for case records. To view a list of definitions, navigate to Dynamic Related Record > Related Record Definitions.

    The system administrator can make any of these definitions available to agents by adding them to the related records shared page in UI Builder.
    Table 2. Related Record Definitions table
    Related record definition Description
    SLAs Displays SLAs for a case, including information from the following fields:
    • Stage
    • SLA definition
    • Start time
    • Business time left
    Emails Displays emails for a case, including information from the following fields:
    • Notification type
    • Subject
    • Recipient
    • Date created
    Escalations Displays escalations for a case or for the account and contact or consumer, including information from the following fields:
    • State
    • Number
    • Escalation severity
    • Source record
    Blocked By Displays blocking tasks for a case, including information from the following fields:
    • Blocking task
    • Blocking reason
    Child Cases Displays child cases related to a case, including information from the following fields:
    • Number
    • Short description
    • Account and contact
    • Consumer