Work with the Entity View Action Mapper for UI Builder

  • Release version: Xanadu
  • Updated August 1, 2024
  • 4 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 Work with the Entity View Action Mapper for UI Builder

    The Entity View Action Mapper (EVAM) is an application within ServiceNow's UI Builder that standardizes the presentation of various data sources in components. It enables displaying information as card grids or lists, with an optional toggle for users to switch views. EVAM maps data entities to generic fields and associates actions that can be triggered directly from the card or list views, streamlining how data like community posts or users are shown and interacted with.

    Show full answer Show less

    Key Features

    • Entity: Represents the data source you want to display, such as a user or a post.
    • View: Defines how data is visually rendered on cards and lists.
    • Actions: Specifies operations users can perform from the card (e.g., activating a user).
    • Map: Links data fields from the source to the card layout and connects associated actions.

    Additionally, EVAM supports multi-table data configurations as an alternative for users preferring easier data presentation control directly within UI Builder.

    Using EVAM Data Sources in UI Builder

    EVAM data sources are added and configured within UI Builder to bind data to components. Different EVAM data resources support various use cases:

    • EVAM Data Resource: Composite type evaluated immediately or on invocation, supporting pagination and filter preferences. It allows previewing the EVAM definition script for validation.
    • Fetch EVAM Data: GraphQL type to retrieve data with pagination controls and event handlers for data fetch lifecycle events.
    • Fetch EVAM Metadata: GraphQL type focused on metadata retrieval, with similar evaluation and event handler options.
    • Search EVAM Data Resource: Composite type enabling search with configurable filters, search terms, spell checking, and pagination tokens.

    Each data resource type provides configuration fields to specify when evaluation occurs, EVAM definitions, filters, pagination, and event handling for fetch initiation, success, or failure.

    Practical Application

    ServiceNow customers can add EVAM data resources to their UI Builder pages to ensure consistent and standardized display of data across components. This enhances user experience by providing flexible views (card or list) and actionable elements directly on the UI. Understanding EVAM’s configuration options enables customers to tailor data retrieval, presentation, and interaction according to their application needs.

    With UI Builder, you can use the Entity View Action Mapper (EVAM) application to standardize how the data sources in your components are displayed in your cards and lists.

    EVAM Overview

    Entity View Action Mapper (EVAM) is an application that standardizes how different data sources are displayed in cards and lists. UI Builder uses EVAM data sources to show information in a component as a card grid view or as a list of information. You can add a toggle to your component to let users switch between card grid and list views.

    EVAM consists of the following components:
    • Entity (data source). Associated data that you intend to display, such as a community post or a user.
    • View. How a card displays data and actions.
    • Actions. Action that it performs on the card. For example, you can activate a user into your system.
    • Map. A process that maps the data source to generic fields that are displayed on the card. You can also associate actions that trigger from the card view.

    EVAM and Multi-table data configuration

    The EVAM is an option for users who understand and are comfortable working with JSON. The multi-table data configuration option is an alternative that gives you greater control over the presentation of data, makes it easier to configure the data, and enables you to remain in UI Builder. Use the option that you prefer. For more information, see Multi-table data configuration.

    EVAM data sources

    You add EVAM data sources in UI Builder and bind them to a component.
    Figure 1. EVAM data resources
    EVAM data resources in the select a data resource modal.
    Table 1. EVAM data sources
    EVAM data source Description
    EVAM Data Resource Add an EVAM definition and other information about the data source.
    • Type: Composite.
    • When to evaluate: In the When to evaluate this data resource, select Immediately to have the EVAM data resource instance evaluated on page load or select Only when invoked to use an event handler to evaluate the EVAM data resource.
    • EVAM definition: In the EVAM Definition field, add the EVAM definition record that is associated with the data resource.
    • Page cursor: In the Page Cursor field, add a page cursor for the EVAM definition.
    • Page size: In the Page Size field, add a size for the EVAM pagination.
    • Page number: In the Page Number field, add the page number for the EVAM pagination.
    • EVAM Filter Preference: In the EVAM Filter Preference field, enter the sys_ids for the EVAM data filter.

    To add an event handler for when that data fetch is initiated, succeeded, or failed, select Events.

    In the Now Code Editor section, which is next to the Configuration pane, preview the EVAM definition script.

    Figure 2. EVAM Data Resource configuration
    EVAM Data Resource Configuration.
    Fetch EVAM Data To add an EVAM definition and other information about the data source, select Configuration.
    • Type: GRAPHQL.
    • When to evaluate: To have the EVAM data resource instance evaluated on a page load, select Immediately. To use an event handler to evaluate the EVAM data resource, select Only when invoked.
    • EVAM definition: In the EVAM Definition field, enter the EVAM definition record that is associated with the data resource.
    • Page cursor: In the Page Cursor field, enter a page cursor for the EVAM definition.
    • Page size: In the Page Size field, enter a size for the EVAM pagination.
    • Page number: In the Page Number field, enter the page number for the EVAM pagination.
    • EVAM Filter Preference: In the EVAM Filter Preference field, enter the sys_ids for the EVAM data filter.

    To add an event handler for when that data fetch is initiated, succeeded, or failed, select Events.

    Preview the EVAM definition script in the Now Code Editor to the right of the Configuration pane.

    Fetch EVAM Data source configuration.
    Fetch EVAM Metadata To select when to evaluate the EVAM data resource and add an EVAM definition, select Configuration.
    • Type: GRAPHQL.
    • When to evaluate: To have the EVAM data resource instance evaluated on a page load, select Immediately. To use an event handler to evaluate the EVAM data resource, select Only when invoked.
    • EVAM definition: In the EVAM Definition field, enter the EVAM definition record that is associated with the data resource.

    To add an event handler for when that data fetch is initiated, succeeded, or failed, select Events.

    Preview the EVAM definition script in the Now Code Editor to the right of the Configuration pane.

    Fetch EVAM Metadata configuration.
    Search EVAM Data Resource To add an EVAM definition, and other information about the data source, select Configuration.
    • Type: Composite.
    • When to evaluate: To have the EVAM data resource instance evaluated on a page load. select Immediately. To use an event handler to evaluate the EVAM data resource, select Only when invoked.
    • EVAM Config ID: In the EVAM Config ID field, add the EVAM Config ID that is associated with the data record.
    • Search Context Config ID: In the Search Context Config ID field, add the Search Context Config ID that you are searching for.
    • Search Term: In the Search Term field, add the search terms that you are searching for.
    • Facet Filters: In the Facet filters field, add any facet filters to help define your search.
    • Search Filters: In the Search Filters field, add any search filters to help define your search.
    • Disable Spell Checking: In the Disable Spell Checking field, select if you desire spell checking to be on or off during your search.
    • Pagination Token: In the Pagination Token field, enter a pagination token if needed.

    To add an event handler for when that data fetch is initiated, succeeded, or failed, select Events.

    Preview the EVAM definition script in the Now Code Editor to the right of the Configuration pane.

    Search EVAM Data resource configuration.