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

    Interface CustomWithLabelVariableType<MacroRefTable, SummaryRefTable, WidgetRefTable, MacroponentRefTable, TopicRefTable, Type>

    Configuration type for custom with label variables (macro)

    interface CustomWithLabelVariableType<
        MacroRefTable extends TableName = "sys_ui_macro",
        SummaryRefTable extends TableName = "sys_ui_macro",
        WidgetRefTable extends TableName = "sp_widget",
        MacroponentRefTable extends TableName = "sys_ux_macroponent",
        TopicRefTable extends TableName = "sys_cs_topic",
        Type extends
        
                | Record<MacroRefTable>
                | Record<SummaryRefTable>
                | Record<WidgetRefTable>
                | Record<MacroponentRefTable>
                | Record<TopicRefTable>
                | ExplicitKey
                | string =
            | Record<MacroRefTable>
            | Record<SummaryRefTable>
            | Record<WidgetRefTable>
            | Record<MacroponentRefTable>
            | Record<TopicRefTable>
            | 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;
        exampleText?: string;
        field?: string;
        global?: boolean;
        helpTag?: string;
        helpText?: string;
        instructions?: string;
        layout?: "normal" | "2across" | "2down";
        macro?: string | Record<MacroRefTable>;
        macroponent?: string | Record<MacroponentRefTable>;
        mapToField?: boolean;
        order?: number;
        postInsertScript?: string;
        pricingDetails?: PricingDetail[];
        pricingImplications?: boolean;
        question: string;
        readRoles?: (string | Role)[];
        readScript?: string;
        removeFromConversationalInterfaces?: boolean;
        showHelp?: boolean;
        summaryMacro?: string | Record<SummaryRefTable>;
        tooltip?: string;
        topicBlock?: string | Record<TopicRefTable>;
        unique?: boolean;
        useDynamicDefault?: boolean;
        visibility?: "Bundle" | "Always" | "Standalone";
        visibleBundle?: boolean;
        visibleGuide?: boolean;
        visibleStandalone?: boolean;
        visibleSummary?: boolean;
        widget?: string | Record<WidgetRefTable>;
        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? exampleText? field? global? helpTag? helpText? instructions? layout? macro? macroponent? mapToField? order? postInsertScript? pricingDetails? pricingImplications? question readRoles? readScript? removeFromConversationalInterfaces? showHelp? summaryMacro? tooltip? topicBlock? unique? useDynamicDefault? visibility? visibleBundle? visibleGuide? visibleStandalone? visibleSummary? widget? 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

    exampleText?: string
    field?: string

    Field to map (required when mapToField is true)

    global?: boolean

    Global

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

    Layout style for the container

    macro?: string | Record<MacroRefTable>

    Reference to a sys_ui_macro record

    macroponent?: string | Record<MacroponentRefTable>

    Reference to a sys_ux_macroponent record

    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
    readRoles?: (string | Role)[]
    readScript?: string

    Read script

    removeFromConversationalInterfaces?: boolean

    Remove from Conversational Interfaces

    showHelp?: boolean
    summaryMacro?: string | Record<SummaryRefTable>

    Reference to a sys_ui_macro record for summary

    tooltip?: string
    topicBlock?: string | Record<TopicRefTable>

    Reference to a sys_cs_topic record

    unique?: boolean

    Unique value

    useDynamicDefault?: boolean

    Use dynamic default

    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

    widget?: string | Record<WidgetRefTable>

    Reference to a sp_widget record

    width?: 100 | 50 | 25 | 75

    Width of the variable

    writeRoles?: (string | Role)[]

    Settings

    Member Visibility

    On This Page

    Properties