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

    Interface Workspace

    interface Workspace {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        defaultRecordOverrides?: { [record: string]: { [key: string]: unknown } };
        landingPath?: string;
        listConfig?: string | UxListMenuConfig;
        order?: number;
        path: string;
        protectionPolicy?: "read" | "protected";
        tables?: (keyof Tables)[];
        title: string;
    }
    Index

    Properties

    $id $meta? $override? active? defaultRecordOverrides? landingPath? listConfig? order? path protectionPolicy? tables? title

    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 this workspace is currently active

    defaultRecordOverrides?: { [record: string]: { [key: string]: unknown } }

    When records that are not tracked by the plugin are modified on instance, they are tracked here

    landingPath?: string

    The default landing path for the workspace

    listConfig?: string | UxListMenuConfig

    The List Config for this workspace

    order?: number

    The order the workspace is displayed in the unified nav

    path: string

    The URL path or route associated with this workspace

    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.
    tables?: (keyof Tables)[]

    The tables associated with this workspace

    title: string

    The display name of the workspace

    Settings

    Member Visibility

    On This Page

    Properties