Bluestep JS Documentation
    Preparing search index...

    Interface CreateDsm5LookupFieldProperties

    Properties for creating a dsm5 lookup field.

    interface CreateDsm5LookupFieldProperties {
        advancedOptions?: string;
        allowOther?: boolean;
        autoCopy?: boolean;
        columnSpan?: number;
        defaultValue?: any;
        defaultValueAsString?: string;
        deprecated?: boolean;
        fieldControlFieldTopId?: string;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        fieldControlView?: "READONLY"
        | "HIDDEN";
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        keyStringFuzzyEquals?: boolean;
        label?: string;
        longLabel?: boolean;
        name: string;
        neverHideHelpText?: boolean;
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        subFormatType?: string;
        textDefaultValueType?:
            | "SPECIFIC_VALUE"
            | "CREATOR_NAME"
            | "CREATOR_IP"
            | "UUID";
        textFormatType: "DSM5";
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index
    advancedOptions? allowOther? autoCopy? columnSpan? defaultValue? defaultValueAsString? deprecated? fieldControlFieldTopId? fieldControlType? fieldControlValue? fieldControlView? formula? formulaId? frozen? helpText? hiddenFromSupers? keyStringFuzzyEquals? label? longLabel? name neverHideHelpText? placeholder? popupHint? reportLabel? required? styleClass? subFormatType? textDefaultValueType? textFormatType typeScriptDeclarations? userUpdateable? width?
    advancedOptions?: string

    Advanced configuration options as a key-value string

    allowOther?: boolean

    Whether to show an 'Other' option that allows free-text entry

    autoCopy?: boolean

    Whether to automatically copy this field's value when cloning a record

    columnSpan?: number

    How many of its row's columns this field spans: 0 for the whole row, 1-4 for that many columns. An explicit null clears it, leaving the field type's default placement. Read by layout clients; legacy form pages do not apply it.

    defaultValue?: any

    Default value pre-populated when creating new records.

    defaultValueAsString?: string

    Default text value for new records

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    fieldControlFieldTopId?: string

    ID of the field a CUSTOM fieldControlType watches: another checkbox, radio, signature or single-select field on the same form. Null or an empty ID removes it.

    fieldControlType?:
        | "NORMAL"
        | "HIDDEN_DEFAULT"
        | "READONLY_DEFAULT"
        | "SMART_HIDE"
        | "READONLY_WHEN_COMPLETED"
        | "CUSTOM"

    Visibility/editability control mode for this field

    fieldControlValue?: string

    The watched field's value at which a CUSTOM fieldControlType applies: true or false for a checkbox or radio, signed or unsigned for a signature, one of its option IDs for a single-select (an empty string, accepted for legacy compatibility, stores no value).

    fieldControlView?: "READONLY" | "HIDDEN"

    What a CUSTOM fieldControlType does to this field while its condition holds. A header, spacer, static content or merge report field can only be HIDDEN, which writing its condition stores.

    formula?: string

    BlueStep formula expression for computed field values

    formulaId?: string

    Optional script/merge variable name (the 'Field Identifier' in the admin UI) used to reference this field from formula, endpoint, and merge-report code. Leave unset for a data-entry-only field that is not referenced from code — like the UI, it is not required.

    frozen?: boolean

    Whether this field is locked from editing by non-admin users

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    keyStringFuzzyEquals?: boolean

    Whether to use fuzzy matching when comparing key string values

    label?: string

    Display label shown to users on the form

    longLabel?: boolean

    Whether the label spans the full width above the field instead of beside it

    name: string

    Field name.

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    placeholder?: string

    Placeholder text shown in the empty input field

    popupHint?: boolean

    Whether to show help text as a popup tooltip instead of inline

    reportLabel?: string

    Alternate label used in reports and exports

    required?: boolean

    Whether this field must have a value before the record can be saved

    styleClass?: string

    CSS class name(s) applied to the field for custom styling

    subFormatType?: string

    Sub-format configuration for specialized text display

    textDefaultValueType?: "SPECIFIC_VALUE" | "CREATOR_NAME" | "CREATOR_IP" | "UUID"

    Which source supplies the default for a new record. SPECIFIC_VALUE uses the stored default (defaultValue / defaultValueAsString); CREATOR_NAME, CREATOR_IP and UUID synthesise one per record, leave the stored default unread, and are only accepted while textFormatType is NONE.

    textFormatType: "DSM5"

    Format type discriminant.

    typeScriptDeclarations?: string

    Type script declarations

    userUpdateable?: boolean

    Whether end users can edit this field value (false = system-managed)

    width?: number

    Display width in columns. An explicit null clears the stored width.

    Settings
    Member Visibility

    On This Page
    Properties