Bluestep JS Documentation
    Preparing search index...

    Interface CreateDateTimeFieldProperties

    Properties for creating a date time field.

    interface CreateDateTimeFieldProperties {
        autoCopy?: boolean;
        columnSpan?: number;
        dateFormatType: "DATE_TIME";
        defaultValue?: any;
        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;
        hasNoFutureValues?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        longLabel?: boolean;
        maximumValue?: string;
        minimumValue?: string;
        name: string;
        neverHideHelpText?: boolean;
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index
    autoCopy? columnSpan? dateFormatType defaultValue? deprecated? fieldControlFieldTopId? fieldControlType? fieldControlValue? fieldControlView? formula? formulaId? frozen? hasNoFutureValues? helpText? hiddenFromSupers? label? longLabel? maximumValue? minimumValue? name neverHideHelpText? placeholder? popupHint? reportLabel? required? styleClass? typeScriptDeclarations? userUpdateable?
    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.

    dateFormatType: "DATE_TIME"

    Format type discriminant.

    defaultValue?: any

    Default value pre-populated when creating new records. The token timeStamp, in any casing, means the current date/time, and an ISO-8601 duration appended directly to it offsets that - timeStampP1D is one day later, timeStamp-P2D two days earlier. Anything else is a literal in this field's own display format (12/31/2026 for date, 3:00PM for time, 12/31/2026 3:00PM for dateTime), and one that does not parse in the format the field ends up with is rejected.

    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

    hasNoFutureValues?: boolean

    Whether the field refuses a value after now. true sets maximumValue to the token TIMESTAMP; false clears it if it is TIMESTAMP (in any casing) and leaves any other maximum alone. Sent with maximumValue, the two must agree.

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    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

    maximumValue?: string

    Maximum allowed value for validation

    minimumValue?: string

    Minimum allowed value for validation

    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

    typeScriptDeclarations?: string

    Type script declarations

    userUpdateable?: boolean

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

    Settings
    Member Visibility

    On This Page
    Properties