Bluestep JS Documentation
    Preparing search index...

    Interface UpdateDateFieldProperties

    Properties for updating a date field.

    interface UpdateDateFieldProperties {
        autoCopy?: boolean;
        dateFormatType: "DATE";
        defaultValue?: any;
        deprecated?: boolean;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        longLabel?: boolean;
        maximumValue?: string;
        minimumValue?: string;
        neverHideHelpText?: boolean;
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index
    autoCopy? dateFormatType defaultValue? deprecated? fieldControlType? fieldControlValue? formula? formulaId? frozen? helpText? hiddenFromSupers? label? longLabel? maximumValue? minimumValue? neverHideHelpText? placeholder? popupHint? reportLabel? required? styleClass? typeScriptDeclarations? userUpdateable?
    autoCopy?: boolean

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

    dateFormatType: "DATE"

    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

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

    Visibility/editability control mode for this field

    fieldControlValue?: string

    Custom expression for CUSTOM field control type

    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

    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

    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