Skip to main content

Legacy dynamic form rules: 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 a QBL (Quickbase language) object. 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. Supported schema may differ by QBL version.

The following table lists information about the properties of this object. 

In this article

To learn more about how QBL handles reference and lookup fields in legacy form rules, read QBL legacy form rules behavior.

Form rule

Property Name Required Default Allowed Values
Disable False False true or false
FireOnlyOnChange False None true or false
TrueWhen False All One of: Any, All
CompactSpaceOnHide False False true or false

Form rule action: Abort save

Property Name Required Default Allowed Values
Message False "" Any string

Form rule action: Change

Property Name Required Default Allowed Values
Target True None Reference to Field
Value False "" Reference to Field
Any string

Form rule action: Display message

Property Name Required Default Allowed Values
Message False "" Any string

Form rule action: Hide

Property Name Required Default Allowed Values
Target True None Reference to Field or QB::Form::Element::Section or QB::Form::Element::Tab

Form rule action: Make editable

Property Name Required Default Allowed Values
Target True None Reference to Field

Form rule action: Make read only

Property Name Required Default Allowed Values
Target True None Reference to Field

Form rule action: Require

Property Name Required Default Allowed Values
Target True None Reference to Field

Form rule action: Show

Property Name Required Default Allowed Values
Target True None Reference to Field or QB::Form::Element::Section or QB::Form::Element::Tab

Form rule action: Unrequire

Property Name Required Default Allowed Values
Target True None Reference to Field

Form rule condition: Field

Property Name Required Default Allowed Values
Field True None Reference to Field
Comparison True None One of: None, IsEqualTo, IsNotEqualTo, IsLessThan, IsLessThanOrEqualTo, IsGreaterThan, IsGreaterThanOrEqualTo
Value False "" Any string, Reference to Field

Form rule condition: Field change

Property Name Required Default Allowed Values
Field True None Reference to Field
Comparison True None One of: Changed, ChangedTo, ChangedFrom
Value False "" Any string, Reference to Field

Form rule condition: Field includes

Property Name Required Default Allowed Values
Field True None Reference to Field
Comparison True None One of: Includes, DoesNotInclude
Value False "" Any string, Reference to Field

Form rule condition: User

Property Name Required Default Allowed Values
Comparison True None One of: IsInRole, IsNotInRole
Value True None Reference to QB::Application::Role

Form rule trigger: Field

Property Name Required Default Allowed Values
Field True None Reference to Field
Comparison True None One of: None, IsEqualTo, IsNotEqualTo, IsLessThan, IsLessThanOrEqualTo, IsGreaterThan, IsGreaterThanOrEqualTo
Value False "" Any string, Reference to Field

Form rule trigger: Field includes

Property Name Required Default Allowed Values
Field True None Reference to Field
Comparison True None One of: Includes, DoesNotInclude
Value False "" Any string, Reference to Field

Form rule trigger: Multiple conditions

Property Name Required Default Allowed Values
IfConditionsAre False True true or false

Form rule trigger: Record state

Property Name Required Default Allowed Values
RecordState False IsSaving One of: IsOpened, IsSaving, IsSavingAfterChecking

Form rule trigger: User

Property Name Required Default Allowed Values
Comparison True None One of: IsInRole, IsNotInRole
Value True None Reference to QB::Application::Role

 

Related articles

Top