Skip to main content

Formula field properties: QBL v0.5

Important

QBL version 0.5 is only supported for these APIs:

It is not supported when updating solutions, or listing solution changes.

This article contains information about QBL objects. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties.

The following tables list information about the properties of each object.

See general information about fields as QBL objects.

In this article

Checkbox - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
Label True - Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True - Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False -  
DefaultValue False Unchecked One of: Unchecked, Checked
ShowAsCheckmark False True true or false
DoesTotal False False true or false

Currency - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True - Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False False true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False False true or false
SnapshotSourceLookupField   True - Reference to Field
SharedWith   False [] Array of items of type: Any string
RolePermissions   False -  
Units   False "" Any string
Width   False 10 Any integer
DoesTotal   False True true or false
DoesAverage   False False true or false
TreatBlankAsZero   False True true or false
DefaultValue   False "" One of: "", Any string
DecimalPlaces Leave blank for floating point False 2 One of: FloatingPoint, "", Any integer
DefaultSortOrder   False Ascending One of: Ascending, Descending
SeparatorStart   False 3 One of: 3, 4
NumberFormat   False    
SeparatorStyle Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces). False CommaGroupingPeriodDecimal One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal
SeparatorPlaces   False 3 One of: none, 2, 3
CurrencySymbol   False $ Any string
CurrencySymbolPosition   False Between

One of: Before, Between, After

Date - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True - Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True - Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False -  
ShowMonthAsAlpha False False true or false
HideCurrentYear False False true or false
ShowDayOfWeek False False true or false
DefaultIsToday False False true or false
DefaultSortOrder False Ascending One of: Ascending, Descending
UseFormulaBuilder False False true or false
FiveDayWorkWeek False False true or false

Date/time - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
ShowMonthAsAlpha False False true or false
HideCurrentYear False False true or false
ShowDayOfWeek False False true or false
ShowTimeZone False False true or false
ShowTime False True true or false
DefaultIsNow False False true or false
DefaultSortOrder False Ascending One of: Ascending, Descending

Duration - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True   Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False False true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False False true or false
SnapshotSourceLookupField   True   Reference to Field
SharedWith   False [] Array of items of type: Any string
RolePermissions   False    
TreatBlankAsZero Treat blank as zero in calculations False True true or false
DoesTotal Display a total of this field in reports False False true or false
DoesAverage Display an average of this field in reports False True true or false
DefaultValue   False "" Any string
DecimalPlaces Leave blank for floating point False FloatingPoint One of: FloatingPoint, ""
Any integer
DisplayUnits   False Smart Units One of: HH::MM, HH:MM:SS, :MM, :MM:SS, Smart Units, Weeks, Days, Hours, Minutes, Seconds
AddFieldToAllNewReports Add this field to all new reports False True true or false

Email - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
Comments False "" Any string
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type:
Any string
RolePermissions False    
DefaultValue False "" Any string
DefaultDomain False "" Any string
SortByDomain False False true or false
EnableEmailAll False False true or false
LinkText False "" Any string
DisplayAs False FullEmailAddress One of: FullEmailAddress, OmitDomain, OmitAfterUnderscore

Formula - fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false

List user - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
Choices* False   - 
UserSet False Default One of: Default
Array of items of type: Any string
AllowCreateChoices False False true or false
AllowInviteExternalUser False False true or false
DefaultValue False "" One of: CurrentUser

*If you have "from list" and the list contains users that are not registered in the realm you are creating/updating, the unregistered users will disappear from the list of choices.

Multi-select text - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    

Numeric - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True   Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False False true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False False true or false
SnapshotSourceLookupField   True   Reference to Field
SharedWith   False [] Array of items of type: Any string
RolePermissions   False    
Units   False "" Any string
Width   False 10 Any integer
DoesTotal   False True true or false
DoesAverage   False False true or false
TreatBlankAsZero   False True true or false
DefaultValue   False "" One of: "", Any string
DecimalPlaces Leave blank for floating point False FloatingPoint One of: FloatingPoint, "", Any integer
DefaultSortOrder   False Ascending One of: Ascending, Descending
SeparatorStart   False 4 One of: 3, 4
NumberFormat   False    
SeparatorStyle Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces). False CommaGroupingPeriodDecimal One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal
SeparatorPlaces   False 3 One of: none, 2, 3

Percent - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True   Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False False true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False False true or false
SnapshotSourceLookupField   True  

Reference to QB::Field::Lookup
SharedWith   False [] Array of items of type: Any string
RolePermissions   False  

 
Units   False "" Any string
Width   False 10 Any integer
DoesTotal   False True true or false
DoesAverage   False False true or false
TreatBlankAsZero   False True true or false
DefaultValue   False "" One of: ""
Any string
DecimalPlaces Leave blank for floating point False FloatingPoint One of: FloatingPoint, ""
Any integer
DefaultSortOrder   False Ascending One of: Ascending, Descending
SeparatorStart   False 4 One of: 3, 4
NumberFormat   False    
SeparatorStyle Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces). False CommaGroupingPeriodDecimal One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal
SeparatorPlaces   False 3 One of: none, 2, 3

Phone number - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
DefaultValue False "" Any string
HasExtension False True true or false
IsInternational False False true or false
DefaultCountry False US One of: AF, AL, DZ, AS, AD, AO, AI, AG, AR, AM, AW, AC, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, BQ, KY, CF, TD, CL, CN, CX, CC, CO, KM, CD, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW, AX

Rating - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True   Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False True true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False True true or false
SnapshotSourceLookupField   True   Reference to Field
SharedWith   False [] Array of items of type: Any string
RolePermissions   False    
Units   False "" Any string
Width   False 10 Any integer
DoesTotal   False False true or false
DoesAverage   False True true or false
TreatBlankAsZero   False True true or false
DefaultValue   False "" One of: "" or Any string
DecimalPlaces Leave blank for floating point False 1 One of: FloatingPoint, "" or Any integer
DefaultSortOrder   False Ascending One of: Ascending, Descending
SeparatorStart   False 4 One of: 3, 4
NumberFormat   False    
SeparatorStyle Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces). False CommaGroupingPeriodDecimal One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal
SeparatorPlaces   False 3 One of: none, 2, 3

Rich text - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
MaxLength False 0 Any integer
DefaultValue False "" Any string
EditHistory False    
Enable False False true or false
ExpandedHistory False False true or false
PrependHistory False False true or false
UseFullName False True true or false
IncludeTime False False true or false
IncludeTimeZone False False true or false
Width False 40 Any integer

Text - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True - Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True Reference to Field Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
MaxLength False 0 Any integer
DefaultValue False "" Any string
EditHistory False    
Enable False False true or false
ExpandedHistory False False true or false
PrependHistory False False true or false
UseFullName False True true or false
IncludeTime False False true or false
IncludeTimeZone False False true or false

Time of day - formula fields

Property Description Required Default Allowed Values
Formula   False "" Any string
OverrideSubFieldAccess   False False true or false
IsUnique   False False true or false
Label   True   Any string
IsRequired   False False true or false
AllowDataCopy   False True true or false
IsBold   False False true or false
DisplayWithoutWrapping   False False true or false
HelpText   False "" Any string
IsSearchable   False False true or false
AllowedInReports   False True true or false
AddToAllNewReports   False False true or false
SnapshotSourceLookupField   True   Reference to Field
SharedWith   False [] Array of items of type: Any string
RolePermissions   False    
DefaultValue   False "" Any string
DisplayAs   False HH:MM One of: HH:MM, HH:MM:SS
Use24HourClock   False False true or false
ShowTimeZone   False False true or false
DecimalPlaces Leave blank for floating point False FloatingPoint One of: FloatingPoint, ""
Any integer

URL - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True   Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True   Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
LinkText False "" Any string
DefaultValue False "" Any string
Abbreviate False False true or false
DisplayAsButton False False true or false
ButtonColor False default Any string
EmbedAsIframe False False true or false
IframeWidth False default One of: default, Any integer
IframeHeight False default One of: default, Any integer
Target False SamePage One of: SamePage, NewWindow, Popup

User - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
Label True N/A Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True N/A Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
Choices* False    
UserSet False Default One of: Default Array of items of type: Any string
AllowCreateChoices False False true or false
AllowInviteExternalUser False False true or false
DisplayAs False FirstNameLastName One of: FirstNameLastName, LastNameFirstName, UserName

*If you have "from list" and the list contains users that are not registered in the realm you are creating/updating, the unregistered users will disappear from the list of choices.

Work date - formula fields

Property Required Default Allowed Values
Formula False "" Any string
OverrideSubFieldAccess False False true or false
IsUnique False False true or false
Label True N/A Any string
IsRequired False False true or false
AllowDataCopy False True true or false
IsBold False False true or false
DisplayWithoutWrapping False False true or false
HelpText False "" Any string
IsSearchable False False true or false
AllowedInReports False True true or false
AddToAllNewReports False False true or false
SnapshotSourceLookupField True N/A Reference to Field
SharedWith False [] Array of items of type: Any string
RolePermissions False    
ShowMonthAsAlpha False False true or false
HideCurrentYear False False true or false
ShowDayOfWeek False False true or false
DefaultIsToday False False true or false
DefaultSortOrder False Ascending One of: Ascending, Descending
UseFormulaBuilder False False true or false
FiveDayWorkWeek False False true or false

Related articles

Top