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
Application guide
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Title | The name of the guide as shown in the Help menu. | False | "" | Any string |
| LinksTo | A URL or internal page the guide points to—can be a Rich Text Page, Code Page, or external link. | True | - | References: 1. QB::CodePage (Scope: QB::Application) 2. QB::RichTextPage (Scope: QB::Application) Any string |
| Description | A brief description of the guide's purpose. | False | "" | Any string |
Code page
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Name | - | True | - | Any string |
| RawCode | - | False | "" | Any string |
Homepage
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Name | - | True | - | Any string |
Homepage widget button
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Url | The URL to navigate to when the link is clicked. | False | - | Any string |
| LinkType | The type of link to create. | False | Page | One of: Url, Report, Page, Record |
| Name | The name of the link, displayed in the UI. | True | - | Any string |
| OpenInNewWindow | Whether to open the link in a new window. | False | True | true or false |
| RedirectUrl | The URL to redirect to after the link is clicked, if applicable. | False | "" | Any string |
Homepage widget button bar
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| Alignment | - | False | Left | One of: Left, Center, Right |
| IsVerticalAligned | - | False | False | true or false |
| Color | - | False | "" | Any string |
Homepage widget field
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| TargetField | Specifies the field that this widget targets or interacts with. | True | - | References: 1. Field (Scope: named_scope) |
| Label | Configures the display of field labels in the search form. 'Label' shows labels. | False | "" | Any string |
| Placeholder | Configures the display of field placeholders in the search form. 'Placeholder' shows placeholder text. | False | "" | Any string |
Homepage widget link
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Url | The URL to navigate to when the link is clicked. | False | - | Any string |
| LinkType | The type of link to create. | False | Page | One of: Url, Report, Page, Record |
| Name | The name of the link, displayed in the UI. | True | - | Any string |
| OpenInNewWindow | Whether to open the link in a new window. | False | True | true or false |
| RedirectUrl | The URL to redirect to after the link is clicked, if applicable. | False | "" | Any string |
Homepage widget link bar
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| Alignment | - | False | Left | One of: Left, Center, Right |
| IsVerticalAligned | - | False | False | true or false |
| LinkSeparator | The separator used between links in the UI. | False | Whitespace | One of: Bullet, Bar, Whitespace |
Homepage widget report
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| MaximumVisibleRows | The number of rows displayed for the report on the page. Values range from 5 to 250. A value of 0 means "Show All Rows". Only applicable to reports that show rows, like Table and Summary reports. |
False | 25 | Any integer |
| Report | The report or chart to be displayed in the widget. | False | None | One of: None |
Homepage widget reports list
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| ShowReportsFrom | Defines whether to show reports from all available tables or from a selected set of tables. | False | AllTables | One of: AllTables, SelectedTables |
| TargetTables | A list of all selected tables to show reports from. | False | Default | One of: Default Array of items of type: Reference to Table, Table |
Homepage widget rich text
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| Content | The rich text content to be displayed on the home page. May include formatting markup. | False | "" | Any string |
Homepage widget search
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| DoExactSearch | Determines whether the search performs exact matching. | False | False | true or false |
| AllowUserDoExactSearch | Controls whether users can toggle between exact and partial matching in the search interface. | False | False | true or false |
| SearchForm | Specifies the type of search form to display. 'FieldList' shows multiple fields, 'SearchText' provides a simple text search, and 'FieldSelect' allows field selection. | False | FieldList | One of: FieldList, SearchText, FieldSelect |
| ResultsView | Controls how search results are displayed. 'InPlace' shows results on the same page, while 'InNewPage' redirects to a dedicated results page. | False | InPlace | One of: InPlace, InNewPage |
| SearchFieldLabel | Configures the display of field labels in the search form. 'Label' shows labels. | False | "" | Any string |
| SearchFieldPlaceholder | Configures the display of field placeholders in the search form. 'Placeholder' shows placeholder text. | False | "" | Any string |
| SearchTarget | Defines which content is searched. 'All' searches across all fields, 'SelectedFields' limits to specified fields, and 'Report' searches within selected report. | False | All | One of: All, SelectedFields, Report |
| SearchTable | Specifies which table to search within. | False | "" | One of: None References: 1. Table (Scope: Solution) |
| SearchReport | Specifies which report to search within. | False | "" | One of: None References: 1. Report (Scope: named_scope) |
Homepage widget web page
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| IsCollapsible | - | False | False | true or false |
| Title | The title of the widget or blank value for the default title | False | "" | Any string |
| ShowTitle | Shows the title of the widget | False | True | true or false |
| Width | The width of the widget in percents of the whole row width | False | 100 | Any string |
| Height | The height of the widget in pixels | False | 400 | Any integer |
| Url | The web address that this widget will link to or display | False | "" | Any string |
Rich text page
| Property | Description | Required | Default | Allowed Values |
|---|---|---|---|---|
| Name | - | True | - | Any string |
| RawText | - | False | "" | Any string |