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

    Interface CatalogUiPolicyProps

    Type representing the properties of a Catalog UI Policy with ID.

    interface CatalogUiPolicyProps {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        actions?: CatalogUiPolicyAction[];
        active?: boolean;
        appliesOnCatalogItemView?: boolean;
        appliesOnCatalogTasks?: boolean;
        appliesOnRequestedItems?: boolean;
        appliesOnTargetRecord?: boolean;
        appliesTo?: "item" | "set";
        catalogCondition?: string;
        catalogItem?: string | CatalogItem;
        description?: string;
        executeIfFalse?: string;
        executeIfTrue?: string;
        global?: boolean;
        isolateScript?: boolean;
        onLoad?: boolean;
        order?: number;
        protectionPolicy?: "read" | "protected";
        reverseIfFalse?: boolean;
        runScripts?: boolean;
        runScriptsInUiType?: CatalogUiPolicyUIType;
        shortDescription: string;
        variableSet?: string | VariableSet;
        vaSupported?: boolean;
    }
    Index

    Properties

    $id $override? actions? active? appliesOnCatalogItemView? appliesOnCatalogTasks? appliesOnRequestedItems? appliesOnTargetRecord? appliesTo? catalogCondition? catalogItem? description? executeIfFalse? executeIfTrue? global? isolateScript? onLoad? order? protectionPolicy? reverseIfFalse? runScripts? runScriptsInUiType? shortDescription variableSet? vaSupported?

    Properties

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

    Set properties not directly supported by this API.

    actions?: CatalogUiPolicyAction[]

    Actions to take when the policy is triggered

    active?: boolean

    Whether the UI policy is active

    appliesOnCatalogItemView?: boolean

    Whether the policy applies when viewing the catalog item

    appliesOnCatalogTasks?: boolean

    Whether the policy applies on catalog tasks

    appliesOnRequestedItems?: boolean

    Whether the policy applies on requested items

    appliesOnTargetRecord?: boolean

    Whether the policy applies on the target record

    appliesTo?: "item" | "set"

    The applies to the policy.

    catalogCondition?: string

    Condition to determine when the policy applies to the catalog

    catalogItem?: string | CatalogItem

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

    description?: string

    Detailed description of the UI policy

    executeIfFalse?: string

    Script to execute when the policy condition is false

    executeIfTrue?: string

    Script to execute when the policy condition is true

    global?: boolean

    Whether the UI policy applies globally

    isolateScript?: boolean

    Whether to isolate the script execution context

    onLoad?: boolean

    Whether the UI policy runs on page load

    order?: number

    Order in which the policy should be evaluated

    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.
    reverseIfFalse?: boolean

    Whether to reverse the policy condition logic

    runScripts?: boolean

    Whether the UI policy runs scripts

    runScriptsInUiType?: CatalogUiPolicyUIType

    UI type(s) where the policy should run

    shortDescription: string

    Short description of the UI policy

    variableSet?: string | VariableSet

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

    vaSupported?: boolean

    Whether the policy is supported for virtual agents

    Settings

    Member Visibility

    On This Page

    Properties