Fields

Using fields in form designer.

Fields are directly linked to the read ReST API data source configured for the form.

Each field is an essential part of the form CRUD mechanism, both displaying data and allowing the end-user to change it.

Fields appear in the form designer toolbar when the form is linked to a read ReST API data source and can be dragged and dropped into panels as shown:

Once the field has been dragged and dropped into a panel, its properties can be set by simply clicking on it. This will open the field properties configurator.

This modal popup dialogue has 4 tabs to control the behaviour of the field.

Details

This is the where the field must be associated with a custom variable, as well as setting important visual properties.

Custom Variable

The field must be associated with a custom variable in order to facilitate the mapping from the data entry form into the data source request. This property is a drop down combo showing the list of all client-side custom variables.

Label Text

At run-time, the field will have a label displayed to its left or above it, for example:

The text of this label can be specified here.

Label Visible

Set whether the label is visible or not.

Label Position

The label can be positioned to the left of the field, or above it.

Read-Only

The field can be set to be non-editable or editable.

Decimal Places

For numeric integer or float fields, this property specifies how many decimal places are displayed.

Styles

This tab allows the styling properties of the field to be overridden. Web applications use cascading style sheets (CSS) to control styles. These properties are are easy to set. Note that if a setting is 0 or blank, then the default styling remains.

Border Radius

Each of the four corners of the field can be curved if required.

Border Width

The field can be shown with a border of any size.

Maximum Height

The fields maximum height can be set. Typically for images, the source image could be very large, so this setting creates a 'thumbnail' i.e. a smaller image for display.

Minimum Height

The fields minimum height can be set. Typically for images, the source image could be very small, so this setting creates a potentially enlarged image for display.

Maximum Width

The fields maximum width can be set. Typically for images, the source image could be very large, so this setting creates a 'thumbnail' i.e. a smaller image for display.

Minimum Width

The fields minimum width can be set. Typically for images, the source image could be very small, so this setting creates a potentially enlarged image for display.

Title

This is the tooltip which hover over the field when the mouse is over the field. Setting this can add clarity to end-users who need more information about a specific field.

Alternate Title

Web applications showing images should have another title which is displayed if the underlying image cannot be rendered e.g. missing. This is displayed instead of the missing image.

Data Sources

This tab is where a single 'Read' data source request can be added to pull data from a ReST API to populate a lookup combo for this field on the form.

For data entry forms with ReST API data sources already assigned, this is not necessary, however for lookup forms where fields have been added to filter data sets, then assigning a ReST API data source to populate a lookup combo is necessary.

Add

This button opens the Select Data Source Request modal popup to choose a ReST API data source request to link to populate the field data.

Once the data source request is selected, it will be displayed in this tab:

Having selected the data source request, the Data Field and the Display Field drop down combos will be populated with the available fields.

Data Field

This is the data source request field which the form field maps to. Often ReST API's return foreign keys i.e. pointers to numbers of strings which should be displayed in human readable form. Thus the data field could be one of these so it is important to understand the ReST API data before mapping this.

Display Field

This is the data source request field which the form field should display. Often ReST API's return foreign keys i.e. pointers to numbers of strings which should be displayed in human readable form. Thus the display field could be one of these so it is important to understand the ReST API data before mapping this.

An example may be when the field on your form is a lookup combo for a nationality. You display the names of all the nationalities, however your field passes the nationality ID to the ReST API to lookup the data.

Sort Alphabetically

When using a display field, sorting the data alphabetically is recommended, allowing end-users to use their keyboard to quickly locate strings.

Developer Configuration

This tab is reserved for developers wishing to override custom behaviours.