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

    Interface DatabaseViewConfig<Tables>

    interface DatabaseViewConfig<
        Tables extends readonly DatabaseViewTable[] = DatabaseViewTable[],
    > {
        $override?: Record<string, string | number | boolean>;
        description?: string;
        label?: string;
        name: string;
        plural?: string;
        protectionPolicy?: "read" | "protected";
        tables: DatabaseViewTables<Tables>;
    }

    Type Parameters

    Index

    Properties

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

    Set properties not directly supported by this API.

    description?: string

    Free-text description of the view's purpose. Defaults to empty.

    label?: string

    Display label shown for this view in admin views and reporting UIs. Defaults to empty.

    name: string

    Name of the database view. This is the record's identity key: the platform enforces uniqueness of the normalized name across all database views, so DatabaseView intentionally omits a top-level $id. The platform silently normalizes this value (lowercase, non-alphanumeric characters replaced with _) before storing it, and this is also the key used to identify the record across rebuilds — supply an already-normalized name to avoid a duplicate view being created on the next build.

    plural?: string

    Plural form of the label, used where the platform needs a plural noun (e.g. list titles). Defaults to empty.

    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.

    The tables joined into this view, in join order. May be empty — ServiceNow allows database views with no joined tables.