Field Attributes

<< Click to Display Table of Contents >>

EQuIS 7  >>  Collect > EQuIS Collect Enterprise > Form Designer Page > Forms and Fields >

Field Attributes

Once a field is added to a form, it can be edited. The role and nature of the respective field is designed by defining field properties and applying field attributes. To access field properties and attributes, identify the field to edit and click on the Edit Col-Edit-Iconicon.

Editing Field Atributes

The Edit Field page opens. Edit the field attributes as desired. The field attribute options vary depending on the type of field selected, but the caption and description will always be available.

 

Caption – Defines the caption of the field.

 

Description – Provides details about the nature/content of the field.

 

Type – Define the type of the field, which depends on the type of data to be captured in the field. The following table provides a brief description for each available data type.

 

Data Type

Field Type

Description

Text

String
LongString

Characters and letters
Increased number of characters and letters

Time

Time
DateTime
Timer

Only time
Date and time
Enabling timer

Number

Integer
Decimal
Counter
Range

Whole number
Fraction whose numerator is expressed by figures placed to the right of a decimal point
Incrementing whole numbers
Difference between the largest and smallest values

Image

Image
MultiImage

One image file
Multiple image files

Drawing

Drawing
Signature

Sketch
Signing

Sound

Sound

Sound file

Map

Geography

Allowing GPS

Selector

Selector
MultiSelector
Group Selector
GroupMultiSelector
 
Boolean

Drop-down list where one value is selected (similar to an enumeration in EDGE)
Drop-down list where multiple values can be selected (similar to an enumeration in EDGE)
Multiselect for a previously defined group of values, one group at a time
Multiselect for a previously defined group of values, multiple groups being allowed
  concomitantly for selection
Logic True or false

Other

Form
Formula
Service
Engineering
Plane Orientation

Field designed to pull/filter data/information from other forms within the same form template
Adding/building advanced logic to specific fields/forms
 
Engineering value is numeric and has a drop-down for unit.
This value has two decimal fields Strike and Dip using right hand rule.
  Strike: Number from 0º to 360º
  Dip: number from 0º to 90º

 

Once the field type is selected, other options may be displayed. The following images and definitions provide a sampling of the field options.

 

Col-Edit_Field-String

 

Mask The mask feature permits string fields to be additionally defined by the type (masking element) and number of characters allowed. More details on the use of masks are available here. This attribute option is displayed only when the field type is a string.

 

Keyboard – Determines whether an alphanumeric or number pad keyboard should be presented when entering data in the field.

 

Maximum Length Defines the maximum field length.

 

Col-Edit_Field-Image

 

Resize – When the field type is image, it is possible to set the size of the image file. This feature aims at reducing file size and server space. Image sizes can be “Small” (25% of the original file size), “Medium” (50% of the original file size), “Large” (75% of the original file size), and “Original”, which keeps both the file size and picture quality of the original image.

 

Col-Edit_Field-Formula

 

Col-Edit_Field-Selector

 

Col-Edit_Field-Engineering

 

Col-Edit_Field-Form

 

Col-Edit_Field-Decimal

 

Show Historical – By checking the Show Historical box, this option will be enabled in the application on the mobile device. A list of historical values will be displayed below the respective field.

 

BarCode Scan – By checking BarCode Scan box, this option will be enabled in the application on the mobile device.

 

Clear Invisible – The Clear Invisible box, when unchecked, prevents values from hidden/non-visible fields being cleared when a record is saved. When the Clear Invisible box is checked, any fields that are hidden will clear their values when a record is saved. By default, the Clear Invisible box is checked. This feature is useful to save the field information from pre-populated forms with hidden/invisible fields when a new record is generated and subsequently saved.

 

Multiselect – The Multiselect box appears when the Form field type is selected. Checking the Multiselect box allows users to select multiple records from another form on the mobile device. The Multiselect default value is unchecked.

 

 

Attributes Tab

 

Field Attributes are formula defined values that control the way fields behave. Different attribute buttons will be displayed for different field types. When hovering the mouse over an attribute button, a tool-tip will display the definition of the specific attribute. If designated, the attribute value or formula will appear in blue in the message section of the Edit Field page (below the Attribute tab).

Attributes

Within the Attributes tab, select each attribute type to define its formula. A description of how each attribute affects the functionality of the field is provided below.

 

Default  Object definition (will be converted to the same type as the field). Logic set in this attribute decides what default value, if any, should be assigned to this field when the form record is first created. The attribute applies only when this field is visible on the form and its value is not empty. Note that persistence is applied before default values are set so if persistence is true and a value was entered in a previous record, then the previous value will be used instead of the default.

 

Editable – Boolean definition. Logic set in this attribute decides whether this field is editable on the form. The True option is set by default. Consequently, the field will be editable on the mobile device if unaltered.

 

Error – Boolean or string definition. Logic set in this attribute determines under what conditions the field value is invalid. If the value is Boolean, then False means that there is no error. If the value is a string, then a non-empty string means that there is no error and the string is displayed to the user as the error message.

 

Formula – Logic set in this attribute returns the value defined by a specified formula.

 

FormFilter – Boolean definition. Logic set in this attribute decides whether the form should be available in the form drop-down menu.

 

FormValue – For any form with the FormFilter value set to True, string value displayed in the form drop-down menu.

 

GridValue If the field will be displayed in Grid View, used to assign how the field value will be displayed. The default value is null.

 

GridHeader If the field will be displayed in Grid View, used to assign the field as a grid header and how the value will be displayed. The default value is null.

 

Minimum – Defines the minimum decimal or string value the start or end of a data set can hold.

 

Maximum – Defines the maximum decimal or string value the start or end of a data set can hold.

 

Persistent  Boolean definition. Logic set in this attribute decides whether this field is persistent; meaning, a value entered in this field on a previous record will persist onto another form record completed later. The default value for this attribute is False.

 

Required  Boolean definition. Logic set in this attribute decides whether this field requires a value to be entered before the user can continue completing the form. The True option is set by default.

 

Visible – Boolean definition (i.e., True or False). Logic set in this attribute decides whether this field is visible on the form. The True option is set by default. Consequently, the field will be visible on the mobile device if unaltered.

 

Warning – Boolean or string definition. Logic set in this attribute decides under what conditions a warning will be displayed to the user. If the value is False or an empty string, then no warning is shown, if the value is True or has a string, then the field is highlighted, and string is displayed as a message.

 

Formula Builder

 

When any of the attribute buttons are selected, the Formula Builder is launched to allow the definition of the function governing the respective attribute value. For all attributes with a Boolean selection, the True option is set by default. The Formula Builder is enabled for editing by clicking on the + button to add a formula component.

Col-Formula_Builder_Visible

A detailed discussion of the Formula Builder is provided here.

 

 

HelpFile Tab

 

For each field on the form, help files can be provided for the Collect Mobile app. Select the HelpFile tab to display the options for help files on the app.

 

HelpFile

 

Create  Create a help document in the interface.

 

Upload  Upload a created help file.

 

Delete  Delete an existing help file.

 

Download  Download an existing help file.