Bluestep JS Documentation
    Preparing search index...

    Interface CreateFieldProperties

    Common properties for creating a field on a Relate form.

    interface CreateFieldProperties {
        columnName: string;
        deprecated?: boolean;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        frozen?: boolean;
        hiddenFromSupers?: boolean;
        label?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    columnName deprecated? fieldControlType? frozen? hiddenFromSupers? label? userUpdateable?

    Properties

    columnName: string

    Database column name.

    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

    frozen?: boolean

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

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    label?: string

    Display label shown to users on the form

    userUpdateable?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties