Add Forms and Fields to Collect Template

<< Click to Display Table of Contents >>

Navigation:  Collect > Collect Enterprise > Template Designer Page > Forms and Fields >

Add Forms and Fields to Collect Template

On the right side of the Form Template Layout page, forms can be built within the template based on the selected format. After the new template is saved, build forms by selecting the + New Form button on right side of the page.

Enabling building of fields

The Form Setup page opens.

Field Setup

To create the form and add fields, enter the Form Setup details in the left pane. Note that the Red Bold* details are required fields.

Form Name – The name of the form. Once saved, the form name cannot be changed because this name is referenced when building formulas. For instance, if aggregate functions are being used in formulas and the name of the form was changed, the references would break making the form and Collect unusable.

Description – Although this field is not required, providing a clear and concise description is recommended as the form description will be displayed on the mobile device rather than the form name. If no description is given, then the form name will be displayed instead. This field remains editable.

Header Field – The form cannot be saved unless the header field is defined. This header will be visible on the mobile device in a number of places:

The name of the form record (if Grid View is not in use).

The label for a form's pin on the Collect Map Form Viewer.

 

Tip: Designate a field of type = Formula in the form's Header Field. This can allow for dynamic names for form records. For example, the header field could show different text when certain fields on the form have been completed. An example of this kind of formula follows:

 

CONCAT('Well ID: ',[loc_name],' Sample ID:',[sys_sample_code],' Type: ',[sampleType],IF(NOT(ISEMPTY([StartDate],[SampleDate])),' ✔',IF(NOT(ISEMPTY([StartDate])),' - In Progress','')))

 

 

The Sort, Map Setup, Grid, Logger Setup, Data Sets, and Data Mapping buttons allow for customization of how the form will appear on the mobile device. Any button on the Form Setup page that can accept customization will change to blue when changed from the default properties.

Sort – By default, forms sort by the header (e.g., the Well ID). The Sort attribute allows the user to choose a different field from the form to provide the sort order displayed on the mobile device.

Map Setup – The Map Setup button allows the user to set properties for how locations will be displayed on the map view in Collect Mobile. See the Map Setup article for more detail.

Grid – The Grid feature allows specified fields to be selected and displayed in a Grid view on the mobile device. See the Grid View article for more detail.

Logger Setup – Use the Logger Setup option to allow a form to connect to a data logger in the field. See the Logger Integration article for details.

Data Sets – Provides a method of further constraining form requirements and maintaining uniqueness in the data as well as facilitating the automation of index or interval generation. See the Data Sets article for more detail.

Data Mapping – Mapping to the database is provided by default (depending on the format used), but can also be customized. See the Data Mapping article for more detail.

 

The Fields section provides a means to add fields and control field features. Within this portion of the page, manage the columns/fields available within the selected table(s) and the form itself as represented by a selection of fields. Also available from the Fields section of the Form Setup page are the following action buttons:

Add Group – This feature allows fields to be grouped together within a form. See the Add Group article for more detail.

Combine Fields – This feature allows fields to be united, easily viewed, and have data entered together. Grouped fields will be displayed on the Collect Mobile app under the Group Name and will appear as a form field. See the Combine Fields article for more detail.

 

 

Fields

 

Each form is configured based on the addition of fields. Fields can be added from columns in tables pertinent to the selected format or by adding custom fields that do not reference any format. If a format is selected, clicking in the Table field will display a list of all sections (tables) in the format. Select the desired section. The selection can be expedited by typing the name of the desired section in the Search box located at the top of the Table dialog.

Available sections and tables

Filtered field

Once a format section is selected, the fields belonging to the section become available.

Selecting columns

Fields can be added to a form in two ways. Clicking on a field will add the specified field to the bottom of the form. Fields can also be selected and dragged to a specified location within the form. Fields can be dragged and placed into the form itself, or into groups and/or combined fields within the form.

 

Note: To reduce loading time of format fields, any fields in the format with lookup values do not retain the lookup values. The field will be added to the form as a string. The lookup values can be added by changing the field type to selector and populating the options.

 

 

When any field from a format sectiom is added to the form, the key/required fields from that section are automatically added, grouped together and highlighted in red.

Col-Fields-AddKey

Col-Fields-Added

Any other field can be incorporated into the form, as designed by the user. Fields added to the form will be displayed green. The last added field will be dark green and bold.

 

Note: Once saved, the field name cannot be changed because this name is referenced when building formulas. For instance, if aggregate functions are being used in formulas and the name of the field was changed, the references would break making the form and Collect unusable.

 

There are two ways to move fields within a form. The first method is to click and drag the field from the current location to the desired location and then release. This allows fields to be moved easily on the form as well as to and from within grouped and/or combined fields. However, dragging and dropping fields to the desired position can be cumbersome in long forms with many fields.

 

The second method to move fields is the up-down arrow icon on the far-right side of the field. Clicking on the up-down arrow icon will open a dialog for moving the desired field. The dialog has a drop-down for choosing another form field as a corresponding position and radio buttons for placement "Before" or "After" the selected drop-down form field. Once a form field is selected in the drop-down and Before or After is chosen, clicking OK will move the field to the position specified. If the form field from the drop-down is within a field grouping or combined field group, the field being moved will adopt the same grouping relationship as the drop-down field.

Col-Field-Move-Arrows-Example

Col-Field-Move-Arrows-Example_Dialog

Col-Field-Move-Arrows-Example_Dialog2

 

To access and edit field attributes, select the field and click the Edit Col-Field_Edit_Icon icon. See the Field Attributes article for a detailed discussion of assigning field attributes. If the field attribute being changed is also existent in other parts of the templates (mapping, pre-population, select/multiselect, etc.), a warning message will be displayed to advise the user. The warning message does not prevent the change and is intended to inform the user of the possible consequences of performing the change.

Editing Field Atributes

To see how the field will be displayed on the mobile device, select the field and click on the Preview Col-Field_Preview_Icon icon.

Editing Field Atributes

A field on the form can be copied by selecting the field and clicking on the Copy Col-Field_Copy_Icon icon. A Copy As dialog will be displayed. By default, the existing field name will be appended with "_Copy". Rename the field as desired and click OK. Edit the field as needed.

Editing Field Atributes

To remove a field from the form, select the field and click on the Delete Col-Delete_Icon icon. The user will be prompted for confirmation prior to deletion. If the field is being used in formulas, a warning message will be displayed denoting the occurrences of the field in the template.

Col-Field-Delete-Example

Once the desired fields are added and edited, save the form by clicking the Save button on the upper right portion of the Form Setup page.

 

Note: When editing a template, EQuIS Collect will autosave every five minutes to prevent loss of work in case of internet connection disruption. Thus, EarthSoft recommends making a copy of a template if the user is uncertain whether he or she will want to retain any changes.