Dashboard component properties

  • Release version: Australia
  • Updated March 12, 2026
  • 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 Dashboard component properties

    The Dashboard component properties in ServiceNow enable administrators and developers to control the runtime behavior and user interactions of dashboard components within a workspace. These properties allow you to customize visibility, interactivity, navigation, filtering, and data handling to tailor dashboards to specific use cases and user roles.

    Show full answer Show less

    Key Properties and Their Practical Use

    • Tab Sys Id [tabSysId]: Display a specific tab from an existing dashboard by specifying its SysID, useful when focusing on particular content.
    • Use default redirections [defaultDrilldowns]: Automatically add predefined drilldown links on data visualizations. Disable this to implement custom drilldown logic via event handlers.
    • Disable header and UI elements:
      • Disable the whole header [hideHeader]: Hides the dashboard header for viewers, showing only content.
      • Hide dashboard picker [hideDashboardPicker]: Removes dashboard picker from the workspace, streamlining the UI.
      • Disable sharing [hideShareButton]: Removes the Share button from dashboards on the Dashboards page.
      • Disable editing [hideEditButton]: Removes the Edit button on dashboards on the Dashboards page.
      • Disable dashboard creation [hideCreateNewButton]: Removes the Create Dashboard option from the dashboard page menu, though dashboards can still be created elsewhere.
    • Embedding and URL Parameter Control:
      • Use as embedded [useAsEmbedded]: Enables embedding the dashboard isolated from page URL parameters, providing full developer control over rendered content. Note that URL copy options are disabled in this mode.
      • Delegate URL params [delegateUrlParams]: Allows parent UIB pages to handle URL parameter updates instead of the dashboard itself, useful for custom navigation logic or embedded dashboards where URL management is external. Requires the latest Platform Analytics experience app.
    • Default dashboard [defaultDashboard]: Selects which dashboard to display by default in the component. The selected dashboard must be configured to be visible in the current workspace or experience.
    • Filtering:
      • Shareable Filter SysID [filterId]: Specifies a saved filter set to apply persistently on the dashboard.
      • Global filters [globalFilters]: Apply filter criteria across all relevant visualizations in the dashboard using encoded queries and PAR filters, allowing consistent data scoping.
    • Drilldown behavior [drilldownToCoreUI]: Controls whether drilldowns on table data sources redirect to the Core UI list or open a Simple List component in the workspace. This setting does not apply to technical dashboards, which require manual configuration.
    • Data fetching via Data Broker:
      • Use data broker to fetch data [useDataBroker]: When enabled, prefetches dashboard metadata and static JavaScript using a data broker for optimized performance.
      • Data broker response for the dashboard [data]: Holds the JSON response from the data broker; can be overridden if necessary.

    Benefits and Expected Outcomes

    By configuring these properties, ServiceNow customers can create tailored dashboard experiences that improve usability, ensure appropriate access controls, and enable customized navigation and filtering. Embedding options and URL parameter delegation provide flexibility for developers integrating dashboards into complex workspace pages. Leveraging data brokers enhances performance by optimizing data fetching.

    These settings collectively empower administrators to control how dashboards appear and behave to end users, supporting diverse organizational requirements while maintaining a consistent and efficient analytics environment.

    Disable and enable dashboard component runtime user abilities with these properties.

    Field Description
    Tab Sys Id [tabSysId] If you want to display only one tab of an existing dashboard, specify its SysID. Also specify the dashboard in Default dashboard.

    You can select a dashboard statically or dynamically, through a state variable or a script.
    Use default redirections [defaultDrilldowns] When activated, the inline editor adds default pre-configured redirections for when a segment of a data visualization is clicked. To implement a custom drilldown, set this property to false, then add and customize a Dashboard Widget Clicked event handler as described in the Events section.

    Default: true
    Disable the whole header [hideHeader] Viewers do not see the dashboard header, only the content.
    Hide dashboard picker [hideDashboardPicker] When true, hides the dashboard picker on all dashboards in the workspace

    Default: false
    Disable sharing [hideShareButton] Hides the Share button on all dashboards from all users, but applies only to the Dashboards page where this value is set.

    Default: false
    Disable editing [hideEditButton] Hides the Edit button on all dashboards from all users, but applies only to the Dashboards page where this value is set.

    Default: false
    Disable dashboard creation [hideCreateNewButton] Hides the Create Dashboard option in the 3-dot menu of the Dashboard page. Users can still create dashboards from the Analytics Center or the dashboards library (Dashboard Overview component).

    When false:

    3-dot menu of dashboards when Disable dashboard creation is off.

    When true:

    3-dot menu of dashboard page when Disable dashboard creation is on.

    Default: false
    Use as embedded [useAsEmbedded] Set to true when you, as a developer, want to use the dashboard component inside your page in isolation from the page's URL parameters. Meaning, you want full control over what the dashboard renders, regardless of URL parameters. The Copy URL and Copy URL with filter options are not available on such embedded dashboards.

    Default: false
    Delegate URL params [delegateUrlParams] Allows the UIB pages which contains the dashboard to take control of how the Dashboard component handles URL parameter updates. When enabled, instead of the dashboard directly updating the browser URL, it dispatches a DASHBOARD#URL_PARAMS_UPDATE_REQUESTED event containing the parameters that would have been updated. The parent page can then handle navigation using a client script.
    Set this property in these circumstances:
    • The page URL structure does not include dashboard URL parameters (for example, no sys-id in the URL path).
    • The page needs custom navigation logic for dashboard changes.
    • The dashboard is embedded (without isEmbedded turned on) in a workspace where URL management is handled by the parent.

    For more information, see Dashboard URL parameter delegation.

    Note:
    This functionality requires the latest Platform Analytics experience application from the ServiceNow® Store.
    Default dashboard [defaultDashboard] Select an existing dashboard to show in this dashboard component. This other dashboard is usually in the Platform Analytics experience. For that dashboard to be shown, it must include your workspace or experience in the Dashboard Visibility field in its dashboard details, as described in Configure Platform Analytics dashboard details.

    You can select a dashboard statically or dynamically, through a state variable or a script.
    Shareable Filter SysID [filterId] The sysId of the persisted filter set up of a dashboard
    Global filters [globalFilters] Filters for the visualizations within the dashboard. These filters apply to all relevant data visualizations. The format of the value passed to globalFilter is the stringified form of {encodedQueries: 'encoded-queries-string', filters: 'PAR-Filter'}. Both encodedQueries and filters are transformed into PAR filters internally and merged with existing filters in the dashboard.
    Either encodedQueries, filters, or both can be specified. In the following example, equivalent encodedQueries and filters values both filter visualizations that show records from the Incident [incident] table based on a State field value of 1 or 2:
    JSON.stringify({
    encodedQueries: {incident: 'stateIN1,2'},
    parFilters: [{ order: 0, apply_to: ['incident.state'], values: ['1', '2'] }]
})
    Drilldown to Core UI [drilldownToCoreUI] Toggle on for drill down on table data sources to redirect to the Core UI list of table records. When off, drilling down opens a Simple List component of the table records, if the workspace contains a simple list.

    Does not apply to technical dashboards. Data visualizations on technical dashboards have to have their Visualization Clicked event handlers configured for drilldowns.

    Default: off
    Use data broker to fetch data [useDataBroker] When toggled on, the dashboard prefetches static JavaScript, such as dashboard metadata, using a data broker. The Dashboard data broker preset automatically toggles this property on. Without the preset, this property is off by default. For more information, see Configure dashboard data broker.
    Data broker response for the dashboard [data] The response for the data broker when it is used. The Dashboard data broker preset automatically sets a JSON object for this property. You can override this value or set it manually without turning the preset on, if you absolutely need to.