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

    Type Alias UiPolicyAction<T>

    Type representing the action to be performed on a field by a UI Policy. Action properties use ServiceNow string format ('true', 'false', 'ignore').

    type UiPolicyAction<T extends TableName> = {
        cleared?: boolean;
        field: TableSchemaDotWalk<T> | string & {};
        fieldMessage?: string;
        fieldMessageType?: fieldMessageType;
        mandatory?: boolean | "ignore";
        readOnly?: boolean | "ignore";
        table?: T;
        value?: string;
        valueAction?: string;
        visible?: boolean | "ignore";
    }

    Type Parameters

    Index

    Properties

    cleared? field fieldMessage? fieldMessageType? mandatory? readOnly? table? value? valueAction? visible?

    Properties

    cleared?: boolean

    Whether the field should be cleared when the condition is met

    field: TableSchemaDotWalk<T> | string & {}

    The field to which the action applies

    fieldMessage?: string

    Message to display for the field

    fieldMessageType?: fieldMessageType

    Type of field message (e.g., 'error', 'info', 'warning')

    mandatory?: boolean | "ignore"

    Whether the field should be mandatory

    readOnly?: boolean | "ignore"

    Whether the field should be read-only (disabled). Note: true means read-only/disabled, false means editable

    table?: T

    The table reference for the action (sys_db_object)

    value?: string

    Value to set for the field

    valueAction?: string

    Action to perform on the field value

    visible?: boolean | "ignore"

    Whether the field should be visible

    Settings

    Member Visibility

    On This Page

    Properties