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

    Interface ReferenceVariableType<RefTable, Type>

    Configuration type for reference variables

    interface ReferenceVariableType<
        RefTable extends TableName = TableName,
        Type extends
            Record<RefTable> | ExplicitKey | string =
            | Record<RefTable>
            | ExplicitKey
            | string,
    > {
        __type__?: Type;
        active?: boolean;
        alwaysExpand?: boolean;
        attributes?: string;
        category?: string;
        conversationalLabel?: string;
        createRoles?: (string | Role)[];
        defaultValue?: string | Type;
        deliveryPlan?: string;
        dependentQuestion?: string;
        description?: string;
        disableInitialSlotFill?: boolean;
        dotWalkPath?: string;
        dynamicRefQual?: string | Record<"sys_filter_option_dynamic">;
        exampleText?: string;
        field?: string;
        global?: boolean;
        helpTag?: string;
        helpText?: string;
        hidden?: boolean;
        instructions?: string;
        layout?: "normal" | "2across" | "2down";
        mandatory?: boolean;
        mapToField?: boolean;
        order?: number;
        postInsertScript?: string;
        pricingDetails?: PricingDetail[];
        pricingImplications?: boolean;
        question: string;
        readOnly?: boolean;
        readRoles?: (string | Role)[];
        readScript?: string;
        referenceQual?: string;
        referenceQualCondition?: string;
        referenceTable: RefTable;
        removeFromConversationalInterfaces?: boolean;
        showHelp?: boolean;
        tooltip?: string;
        unique?: boolean;
        useDynamicDefault?: boolean;
        useReferenceQualifier?: "simple" | "dynamic" | "advanced";
        visibility?: "Bundle" | "Always" | "Standalone";
        visibleBundle?: boolean;
        visibleGuide?: boolean;
        visibleStandalone?: boolean;
        visibleSummary?: boolean;
        width?: 100 | 50 | 25 | 75;
        writeRoles?: (string | Role)[];
    }

    Type Parameters

    Index

    Properties

    __type__? active? alwaysExpand? attributes? category? conversationalLabel? createRoles? defaultValue? deliveryPlan? dependentQuestion? description? disableInitialSlotFill? dotWalkPath? dynamicRefQual? exampleText? field? global? helpTag? helpText? hidden? instructions? layout? mandatory? mapToField? order? postInsertScript? pricingDetails? pricingImplications? question readOnly? readRoles? readScript? referenceQual? referenceQualCondition? referenceTable removeFromConversationalInterfaces? showHelp? tooltip? unique? useDynamicDefault? useReferenceQualifier? visibility? visibleBundle? visibleGuide? visibleStandalone? visibleSummary? width? writeRoles?

    Properties

    Optional Readonly__type__

    __type__?: Type
    active?: boolean
    alwaysExpand?: boolean

    Always expand

    attributes?: string

    Attributes of the variable

    category?: string

    Category

    conversationalLabel?: string
    createRoles?: (string | Role)[]
    defaultValue?: string | Type
    deliveryPlan?: string

    Delivery plan

    dependentQuestion?: string

    Dependent question for dynamic default value

    description?: string

    Description

    disableInitialSlotFill?: boolean
    dotWalkPath?: string

    Dot walk path for dynamic default value

    dynamicRefQual?: string | Record<"sys_filter_option_dynamic">

    Dynamic reference qualifier (use with useReferenceQualifier='dynamic'). Mutually exclusive with referenceQualCondition and referenceQual.

    exampleText?: string
    field?: string

    Field to map (required when mapToField is true)

    global?: boolean

    Global

    helpTag?: string
    helpText?: string
    hidden?: boolean

    Indicates whether the field is hidden. Cannot be true when mandatory is true.

    instructions?: string
    layout?: "normal" | "2across" | "2down"

    Layout style for the container

    mandatory?: boolean

    Indicates whether the field must contain a value. Cannot be true when hidden or readOnly is true.

    mapToField?: boolean

    Map to field

    order?: number

    Order in which the variable appears

    postInsertScript?: string

    Post insert script

    pricingDetails?: PricingDetail[]

    Pricing details

    pricingImplications?: boolean

    Pricing implications

    question: string
    readOnly?: boolean

    Indicates whether the field is read-only. Cannot be true when mandatory is true.

    readRoles?: (string | Role)[]
    readScript?: string

    Read script

    referenceQual?: string

    Advanced reference qualifier (use with useReferenceQualifier='advanced'). Mutually exclusive with referenceQualCondition and dynamicRefQual.

    referenceQualCondition?: string

    Filter reference based on a filter condition (use without useReferenceQualifier or with 'simple'). Mutually exclusive with dynamicRefQual and referenceQual.

    referenceTable: RefTable

    Table that is being referenced by this variable

    removeFromConversationalInterfaces?: boolean

    Remove from Conversational Interfaces

    showHelp?: boolean
    tooltip?: string
    unique?: boolean

    Unique value

    useDynamicDefault?: boolean

    Use dynamic default

    useReferenceQualifier?: "simple" | "dynamic" | "advanced"

    Type of reference qualifier. Determines which qualifier field to use.

    visibility?: "Bundle" | "Always" | "Standalone"

    Visibility

    visibleBundle?: boolean
    visibleGuide?: boolean

    Indicates whether the variable is visible in guides

    visibleStandalone?: boolean

    Indicates whether the variable is visible when standalone

    visibleSummary?: boolean

    Indicates whether the variable is visible in summaries

    width?: 100 | 50 | 25 | 75

    Width of the variable

    writeRoles?: (string | Role)[]

    Settings

    Member Visibility

    On This Page

    Properties