Dashboard component properties

  • Release version: Zurich
  • Updated July 31, 2025
  • 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

    This documentation explains the configurable properties of dashboard components in ServiceNow, enabling you to control user interactions and display behaviors in dashboards within your workspace. These properties help tailor the dashboard experience by enabling or disabling features like editing, sharing, tab visibility, and data fetching methods.

    Show full answer Show less

    Key Properties and Their Practical Uses

    • Tab Sys Id [tabSysId]: Display a specific tab of an existing dashboard by specifying its SysID along with the default dashboard. This can be set statically or dynamically to focus the dashboard view.
    • Use default redirections [defaultDrilldowns]: Controls whether clicking on data visualization segments triggers default drilldowns. Disable to implement custom drilldowns via event handlers.
    • Disable the whole header [hideHeader]: Hides the dashboard header from viewers, showing only dashboard content for a cleaner display.
    • Hide dashboard picker [hideDashboardPicker]: Removes the dashboard picker from all dashboards in the workspace to restrict dashboard switching.
    • Disable sharing and editing buttons [hideShareButton, hideEditButton]: Hide Share and Edit buttons on dashboards to control user permissions on dashboard sharing and modifications.
    • Disable dashboard creation [hideCreateNewButton]: Prevents creating new dashboards from the Dashboard page context menu while allowing creation through other parts like Analytics Center.
    • Use as embedded [useAsEmbedded]: Enables embedding the dashboard component in custom pages independent of URL parameters, giving developers full control over dashboard rendering. Note that URL copying options are disabled.
    • Default dashboard [defaultDashboard]: Select an existing dashboard to display within the component. The chosen dashboard must include the workspace in its visibility settings and can be selected dynamically.
    • Shareable Filter SysID [filterId]: Use to apply a persisted filter set to the dashboard, enabling consistent filter application across sessions.
    • Global filters [globalFilters]: Apply filters across all relevant visualizations in the dashboard by passing encoded queries and PAR filters, allowing centralized data filtering control.
    • Drilldown to Core UI [drilldownToCoreUI]: Toggles whether drilldowns on table data open the Core UI list or a Simple List component, affecting navigation behavior when interacting with data.
    • Use data broker to fetch data [useDataBroker]: When enabled, dashboard metadata and static JavaScript are prefetched via a data broker for optimized data retrieval. This is automatically enabled by the Dashboard data broker preset.
    • Data broker response for the dashboard [data]: Holds the JSON response from the data broker. This can be overridden manually if needed without enabling the preset.

    Why This Matters

    By configuring these properties, ServiceNow customers can finely tune dashboard behavior and user experience. You can restrict user actions such as editing or sharing, control the visibility of dashboard components, apply consistent filtering, and optimize data loading. This leads to more secure, streamlined, and performant dashboards tailored to your organizational needs.

    Expected Results

    • Improved control over dashboard access and capabilities for different user roles.
    • Customizable navigation and drilldown experiences aligned with your workflows.
    • Consistent application of filters and dashboard content visibility.
    • Optimized loading and rendering of dashboards through data broker usage.
    • Flexibility to embed dashboards in custom pages with controlled behavior.

    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 New Dashboard option in the context menu of the Dashboard page. Users can still create dashboards from the Analytics Center or the dashboards library (Dashboard Overview component).

    When false:

    Context menu of dashboards when Disable dashboard creation is off.

    When true:

    Context 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
    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.