Reference ID Overview

iFormBuilderReference IDs

Reference ID's leverage special functions built into the platform. To use these functions, load FormBuilder and create a new form, or choose one from the existing library. If you are loading an existing form, hit the "Edit..." button located in the top right corner of the device view. If you are creating a new form, you will see the Form Properties window pop-up where you will enter the form name, label, and choose an icon. At the bottom of the form properties window you will see a section that has Reference ID text fields.

page level reference Id

Reference ID 1:

- (Only one record can be submitted for that specific date. If a user submits a record on 9/26/11 11:59 PM then they would be able submit the next record on 9/27/11 12:01 AM)

PAGETYPE_TIMEAWARE=9:00-19:00

- (Form is only available on the device during this timeframe)

PAGETYPE_SINGLESUBMISSION

- (Only submit one record per form. If this flag is applied to a form that has one or more records collected you will not be able to collect any records from the device. )

PAGETYPE_NEWFROMLASTRECORD

- (Prepopulate field data from last submitted record in new record. Need to have a local record on the device to create copy from. Turn off 'Delete on Upload' in Device Settings)

PDF_SUBFORM_NEW_PAGE

- (Create new page for subform(s) in PDF report

PAGETYPE_DWINDLINGOL=element_index

- This flag removes options from a list after they have been selected. To use, simply define which element should assume this property (defined by the index value). If you have a list composed of options (red, green, blue) and you select "blue" from the list and submit the record to the server, the list will be reprocessed and only show (red, green) as available options for the next record. Because the server has to process the list, the option is only removed after a successful sync with the server. Please keep this in mind during implementation.

PAGETYPE_INFO

- (No new record is created for the form and no data is uploaded from the device. Mainly for use with informative forms. **Requires 4.2 client**)

PAGETYPE_SUBFORM_PAGING (deprecated in 8.5 release)

- (Changes the way a user navigates through a parent - subform structure. Add this reference ID to a container form.)**When using this feature your form must only contain subforms

Once the reference ID has been added you can only add sub-form inputs to this form. Point each sub-form element in the container form to the respective table.

The user will never see the container page since the first sub-form section is loaded when the user opens the form.

When the user syncs they will see forward and backward navigation buttons at the bottom of the App. Use these buttons to navigate through each sub-form section. You can't move forward or backward until you have satisfied all required fields on the active page.)

Reference ID 2:

Is used to customize the elements displayed in the record table.

DISPLAYFIELD=0,1,2

-(Shows data from specified fields in record view. The numbers represent the element index with the first element always beginning with 0)***Note: When using this feature do not reference an element index value larger than the max element index on the form or you will not be able view data in record view.

*To find the element index of an element, select the element in FormBuilder and click on the Info Tab.

SORTFIELD=0,1,2

The primary difference is that SORTFIELD will display and sort the record view of forms (including subforms) according to the element indexes that are defined. If you define more than one element index value then the rows are sorted in that order by the criteria specified. For instance, if an element “first name” has index of 0, and you apply “SORTFIELD=0” in Ref ID2, records will be sorted alphabetically according to the input for “first name” in the record view on the device.

***To get the most out of SORTFIELD make sure to combine DISPLAYFIELD reference ID with it in order to show and sort the proper fields***

Ex.

DISPLAYFIELD=0,1,2;SORTFIELD=0,1,2

You can also put the letters A, for ascending, or D, for descending, after a number in the SORTFIELD. This can be applied to multiple numbers in the SORTFIELD reference ID.

Ex.

DISPLAYFIELD=0,1,2;SORTFIELD=0,1A,2D

Reference ID 4

These reference IDs are used to overide the device setting of delete on upload for the indiviudal form.

RECORD_DELETE_ON_UPLOAD

- This will ensure every record created on this form is deleted when the device syncs the record.

RECORD_NO_DELETE_ON_UPLOAD

- This will save every completed record on this form as a completed record on the device.

option list reference id

OPTIONLISTTYPE_SEGMENTED_LIST

Requirements: Dependent lists that reference index values in the conditional statement of the list.

-(Optional: Used to improve performance for complex smart lists)

This flag should be used in scenarios where you have large (1,000+ option) smart lists broken into many different segments (25+). Lists that leverage this flag should only be used in a hierarchy with their related lists. The "group" of lists if you will may be assigned to more than one form, given the column names for the elements and logic requirements are the same. Once you have your lists setup, you need to select "Edit" and "Save Changes" in FormBuilder to trigger the indexing process. You may also need to do a clean local database on the device to update the list.

When using this flag, the record will take some extra time to load, but the list response will be nearly instant when implemented correctly. No added benefit will be noticed with smaller lists.

element reference id

ELEMENT_SKIP_REPORT

- Element will not show up on your reports PDF, Excel, etc.

- Great to use for dividers.

ELEMENT_REPORT

- Will print "Label" widget on PDF and E-mail reports.

ELEMENT_SKIP_EMAIL_PDF

- Element will not show on PDF Reports and Email Reports but will show in Data Views and Data Feeds.

SUBFORM_BATCH_MODE

- Upon pressing done on a multi-paging subform, it will open up a new subform record. When you are finished adding subform records, press cancel to return to the parent form. PLEASE NOTE: This Reference ID will be available upon the 8.0 release.

DISABLE_LIST

- Using this reference ID will disable the upgrade to Smart Table Search behavior which displays a list of options instead of having the user to key in the exact value they want to search for.