Forms
In Airflows, all the data is stored as forms (entities) composed of fields.
Forms can reference other forms.
Fields can be organized in tabs & groups.
The following parameters can be defined for a form (entity):
Parameter name | Description | Example value |
---|---|---|
Name of the application | The name of the application. | Demo |
Name of the form | The name of the form (entity). | Product |
Documentation | The documentation of the form (entity). | This form stores information about products. |
Appears in the menu | It indicates if a direct link to manage the entity data will appear on the admin tool menu. | True |
Order number | The order in which it will appear in the admin tool menu. | 2 |
Menu icon | The icon that will appear in the admin tool menu. | widgets |
Translations | The labels that represent this form (entity) in different languages. | Product |
Fields
A form (entity) is composed of fields.
The following parameters can be defined for a field:
Parameter name | Description | Example value |
---|---|---|
Form | The form that owns the field. | Demo, Product |
Field name | The name of the field. | barcode |
Content type | The content type of the field. | Barcode |
Default value | The default value. If the field type is TIME, TIMESTAMP or DATE, the value "now()" can be specified also. | 8480000146397 |
It is mandatory | It indicates if the field is required. | False |
It is used as a label to represent the item | It indicates if this field is used as a label to represent the form (entity). | False |
Appears in the listings | It indicates if this field appears on the table view of the entity. | False |
Appears in the forms | It indicates if this field appears on the view or edit mode of the form (entity). | True |
Used as a basic filter | It indicates if this field is used as a basic filter. | True |
The field is calculated (not modifiable) | It indicates if this field is calculated using a function. | False |
Documentation | The documentation of the field. | The barcode of the product. |
Translations | The labels that represent this field in different languages. | Barcode |
Additional parameters can be specified in order to position the field in the admin tool user interface.
The following parameters can be defined:
Parameter name | Description | Example value |
---|---|---|
Order number | The order number of the field in the form. | 9 |
Tab in which the field is displayed | The tab in which the field is displayed or none. | General info |
Group of fields in which the field is displayed | The group of fields in which the field is displayed or none. | General data |
Number of columns on small screens (in a grid of 12) | The width in number of columns that the field occupies in small screens. | 12 |
Number of columns on medium or large screens | The width in number of columns that the field occupies in medium or large screens. | 12 |
It is the last field in the row | It indicates if this field is the last in the form row. | True |
Depending on the field data type, several of the following additional parameters can be specified:
Parameter name | Description | Example value |
---|---|---|
Maximum length | The maximum length of the value. | 200 |
Validation regular expression | The regular expression that must match the value in order to be valid. | [A-Za-z0-9]+ |
List of values | The list of values that defines the valid values. | Demo, CommentType |
Supports multiple values | It indicates if the field supports multiple values. | False |
It's a password field | It indicates if the field is a password. | False |
The field is an icon | It indicates if the field is an icon. | False |
The field is a color | It indicates if the field is a color. | False |
It's multi-line | It indicates if the field supports multiple lines. | False |
Accuracy (total number of digits) | The maximum total number of digits. | 10 |
Prefix | The prefix that must be visible before the value. | $ |
Suffix | The suffix that must be visible after the value. | € |
Scale (total number of decimal digits) | The maximum total number of decimal digits. | 2 |
Minimum value | The minimum valid value. | 0 |
Maximum value | The maximum valid value. | 1000000 |
Resolution | The resolution of the number (i.e. 0.02). | 0.02 |
The field is the beginning of an event in the calendar | It indicates if the field is the beginning of an event, and if the calendar view will be available. | False |
The field is the end of an event in the calendar | It indicates if the field is the end of an event, and if the calendar view will be available. | False |
Types of accepted files | It indicates the accepted type of files. | application/zip, application/x-compressed, application/x-zip-compressed, multipart/x-zip |
The field is an image in the gallery view | It indicates if the field is an image, and if the gallery view will be available. | False |
Enable browsing on Zip files | It indicates if zip browsing will be activated for this field. | False |
The field is a point on the map | It indicates if the field is a point in a map, and if the map view will be available. | False |
Type of barcode | The type of barcode. | EAN-13 |
Indices & References
Parameter name | Description | Example value |
---|---|---|
Form | The form that owns the index. | Demo, Product |
Name of the application | The name of the application. | Demo |
Name of the index | The name of the index. | Product_pkey |
You can not repeat (unique) | It indicates if the index is unique. | True |
Used to search in texts | It indicates if the index is used for free-text search. | False |
It is a primary key | It indicates if the index is a primary key used to reference the form from others forms. | True |
Documentation | The documentation of the index. | Product primary key |
Fields | The fields that compose the index. | Demo, Product, id |
Parameter name | Description | Example value |
---|---|---|
Form | The form that owns the reference. | Demo, Product |
Name of the reference | The name of the reference. | category |
Index referenced | The referenced index by the reference. | Demo, category, category_pkey |
Additional filter | TBW | |
Documentation | The documentation of the index. | |
Appears in the listings | It indicates if this reference appears on the table view of the entity. | False |
Appears in the forms | It indicates if this reference appears on the view or edit mode of the form (entity). | True |
It appears as a table in the forms | It indicates if this form appears as a table in the view or edit modes of the referenced entity. | True |
It is used as a label to represent the item | It indicates if this reference is used as a label to represent the form (entity). | False |
Option to filter when the list is empty | It indicates if an option must be available to filter forms with empty children. | False |
Used as a basic filter | It indicates if this reference is used as a basic filter. | True |
Related data will be deleted in cascade | It indicates if when the reference entity is deleted, all its children should be deleted also. | False |
Order number | The order number of this reference in the form. | 3 |
Order number of the table | The order number of this entity when it appears as a table inside view or edit view of the referenced entity. | 10 |
Tab in which the field is displayed | The tab in which the reference is displayed | |
Tab in which the table is displayed | The tab in which the table is displayed when it appears in the view or edit mode of the referenced entity. | 3 |
Group of fields in which the field is displayed | The group in which the reference is displayed. | |
Group of fields in which the table is displayed | The group in which the table is displayed when it appears in the view or edit mode of the reference entity. | |
Number of columns on small screens (in a grid of 12) | The width in number of columns that the reference occupies in small screens. | |
Number of columns in the table on small screens | The width in number of columns that the table occupies in small screens when it appears as a table inside view or edit mode of the referenced entity. | |
Number of columns on medium or large screens | The width in number of columns that the reference occupies in medium or large screens. | |
Number of columns in the table on medium or large screens | The width in number of columns that the table occupies in medium or large screens when it appears as a table inside view or edit mode of the referenced entity. | |
Fields | The fields that reference the referenced key. |
User interface
Parameter name | Description | Example value |
---|---|---|
Form | The form that owns the tab. | |
Name of the tab | The name of the tab. | |
Order number | The order of the tab. | |
Translations | The labels that represent the tab in the different supported languages. |
Parameter name | Description | Example value |
---|---|---|
Form | The form that owns the group of fields. | |
Name of the group of fields | The name of the group of fields. | |
Order number | The order of the group of fields. | |
Translations | The labels that represent the group of fields in the different supported languages. |
Forms relationships diagram
This view can be used to see a whole view of the model entities.
Also, it can be used to define references between entities dragging from the field that references to the referenced id.
In order to select a reference in the diagram, CAPS key must be pressed while clicking on it.