@servicenow/sdk - v4.9.0
    Preparing search index...

    Interface Dashboard

    interface Dashboard {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        certified?: boolean;
        description?: string;
        name: string;
        permissions?: DashboardPermission[];
        protectionPolicy?: "read" | "protected";
        tabs?: DashboardTab[];
        topLayout?: DashboardTopLayout;
        visibilities?: DashboardVisibility[];
    }
    Index

    Properties

    $id $meta? $override? active? certified? description? name permissions? protectionPolicy? tabs? topLayout? visibilities?

    Properties

    $id: string | number | ExplicitKey<string>
    $meta?: { installMethod?: "first install" | "demo" | "once" }

    Type Declaration

    • OptionalinstallMethod?: "first install" | "demo" | "once"

      Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)

    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Whether the dashboard is active (defaults to true)

    certified?: boolean

    Marking an item as certified informs the user that it is verified and recommended to use across the company. Defaults to false.

    description?: string

    Descriptive text shown for the dashboard. Omit to leave empty.

    name: string

    Name of the dashboard

    permissions?: DashboardPermission[]

    Array of user permissions for the dashboard

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    tabs?: DashboardTab[]

    Array of tabs in the dashboard

    topLayout?: DashboardTopLayout

    Array of top-level widgets (displayed outside of tabs)

    visibilities?: DashboardVisibility[]

    Array of visibility rules for the dashboard

    Settings

    Member Visibility

    On This Page

    Properties