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

    Interface CatalogClientScriptProps<E>

    interface CatalogClientScriptProps<E extends CatalogClientScriptEvents> {
        $id: string | number | ExplicitKey<string>;
        $meta?: {
            installMethod?: "first install" | "demo" | "once";
            useEsLatest?: boolean;
        };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        appliesOnCatalogItemView?: boolean;
        appliesOnCatalogTasks?: boolean;
        appliesOnRequestedItems?: boolean;
        appliesOnTargetRecord?: boolean;
        appliesTo?: "item" | "set";
        catalogItem?: string | CatalogItem | CatalogItemRecordProducer;
        global?: boolean;
        isolateScript?: boolean;
        name: string;
        order?: number;
        protectionPolicy?: "read" | "protected";
        publishedRef?: string;
        script: string;
        type?: E;
        uiType?: CatalogClientScriptUIType;
        variableName?: string | AnyVariable;
        variableSet?: string | VariableSet;
        vaSupported?: boolean;
    }

    Type Parameters

    Index

    Properties

    $id $meta? $override? active? appliesOnCatalogItemView? appliesOnCatalogTasks? appliesOnRequestedItems? appliesOnTargetRecord? appliesTo? catalogItem? global? isolateScript? name order? protectionPolicy? publishedRef? script type? uiType? variableName? variableSet? vaSupported?

    Properties

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

    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)

    • OptionaluseEsLatest?: boolean

      Controls whether this record's server-side script field(s) run with the latest supported ECMAScript version rather than the application's default. Omit to leave the sys_app/now.config default in place. This setting applies to all fields defined for this entity

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

    Set properties not directly supported by this API.

    active?: boolean

    Whether the script is active.

    appliesOnCatalogItemView?: boolean

    Whether the script is applies on catalog item view.

    appliesOnCatalogTasks?: boolean

    Whether the script is applies on catalog tasks.

    appliesOnRequestedItems?: boolean

    Whether the script is applies on requested items.

    appliesOnTargetRecord?: boolean

    Whether the script is applies on target record.

    appliesTo?: "item" | "set"

    The applies to the script.

    catalogItem?: string | CatalogItem | CatalogItemRecordProducer

    The catalog item the script applies to. Mutually exclusive with variableSet.

    global?: boolean

    Whether the script is global.

    isolateScript?: boolean

    Whether the script is isolated.

    name: string

    The name of the client script.

    order?: number

    The execution order of the client script (lower numbers execute first).

    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.
    publishedRef?: string

    The published ref of the client script.

    script: string

    The script to run.

    type?: E

    The type of the client script.

    uiType?: CatalogClientScriptUIType

    The ui type of the client script.

    variableName?: string | AnyVariable

    The catalog variable that triggers the script. This property applies only when the type property is set to onChange.

    variableSet?: string | VariableSet

    The variable set the script applies to. Mutually exclusive with catalogItem.

    vaSupported?: boolean

    Whether the script is VA supported.

    Settings

    Member Visibility

    On This Page

    Properties