iFormBuilder Reference ID

---

What's covered:

• What is a Reference ID?
• Page Level: Reference ID 1
• Page Level: Reference ID 2
• Page Level: Reference ID 4
• Option List Reference ID
• Element Reference ID
• Form Menu Reference ID: Reference ID 5

---

What is a Reference ID?

Reference ID's leverage special functions built into the platform such as determining which fields are displayed in a record view, segmenting an Option List and deciding which elements show on your email and PDF reports.

Page Level: Reference ID 1

• PAGETYPE_DAILYSUBMISSION

Using this Reference ID, only one record can be submitted for that specific date. If a user submits a record on 9/26/17 11:59 PM then they would be able to submit the next record on 9/27/17 12:01 AM.

• PAGETYPE_TIMEAWARE=9:00-19:00

Using this Reference ID, a form is only available on the device during this timeframe.

• PAGETYPE_SINGLESUBMISSION

With this Reference ID, a user can 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 with that particular device.

• PAGETYPE_NEWFROMLASTRECORD

This Reference ID allows you to prepopulate field data from the last submitted record into a new record. The user will need to have a local record on the device to create the copy from. Delete on Upload should be turned off in the device settings.

• PDF_SUBFORM_NEW_PAGE

Using this Reference ID, the user can create a new page for subform(s) in PDF report.

• PAGETYPE_DWINDLINGOL=element_index

This Reference ID removes options from an Option List after they have been selected locally and synced. The options will still be viewable on the server option list manager. 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. To restore values, you will need to create a copy of the option list and assign the copy to the form.

PLEASE NOTE: When using this feature with a segmented option list (condition value in the option list), you will need to add a condition value to every option. Otherwise, the option you choose plus the other options with the same condition value segment will disappear.

• PAGETYPE_INFO

No new record is created for the form and no data is uploaded from the device. This is mainly used with forms that provide information only.

 

Page Level: Reference ID 2

• 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.

PLEASE 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 to view data in Record View. 

If an element is disabled, the index will SKIP those elements and continue with the next element. For example, if "Element sort order: 1" is disabled, then "Element sort order: 2" will have an index of 1.

• 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. 

PLEASE NOTE: If you'd like to sort the records in ascending or descending order, simply put an A or D after the index values. For example:

SORTFIELD=3A,2D

A represents ascending while D represents descending.

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.

Page Level: Reference ID 4

• 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.

PLEASE NOTE: This will ensure every record created on this form is deleted when the device syncs the record. And this only works with iOS devices currently.

Option List Reference ID

• OPTIONLISTTYPE_SEGMENTED_LIST

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 may be assigned to more than one form, given the column names for the elements and logic requirements are the same. This will only work if you are referencing the index value/sort order (not ZCDisplayKey or ZCDisplayValue) in the condition value.

PLEASE NOTE: Once you have your lists set up, you need to make an "Edit" and "Save Changes" in FormBuilder (not just option list) 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. You can read more about this reference ID here.

Element Reference ID

• ELEMENT_SKIP_REPORT

The element will not show up on your reports PDF, Excel, etc. These are great to use for dividers.

• ELEMENT_REPORT

Using this in the Element Reference ID will allow you to print Label Elements on PDF and E-mail reports.

PLEASE NOTE: Using HTML tags in the Label Name of the element will show up in email reports but not in PDF reports (ex. <b>This is my label</b>)

• ELEMENT_SKIP_EMAIL_PDF

The 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. 

• 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.

• PHOTO_LIBRARY_DISABLED

This Reference ID will keep users from being able to use images in their device library when interacting with the Image Element.

• CAMERA_DISABLED

This Reference ID will force users to use only images already stored on their device and keep them from taking pictures with the Image Element.

• LOCATION_CHANGE_ENABLED

This Reference ID allows you to move the location element. You can learn more about it in our video here.

• DISABLE_PICKLIST_CLOSE

The Pick List element no longer requires the user to choose "done" after selecting an option. You can disable this feature through this Reference ID.

Form Menu Reference ID: Reference ID 5

• FORMBRANDING_FORMLABELCOLOR={hexvalue};

This Reference ID changes the color of the form label.

• FORMBRANDING_RECORDSTATUSCOLOR={hexvalue};

Using this Reference ID changes the color of the status icons along the top of the form label.

• FORMBRANDING_INFOTEXTCOLOR={hexvalue};

Changes the color of the bottom bar and the area surrounding the  icon.

• FORMBRANDING_BORDERCOLOR={hexvalue};

Changes the color of the border around the form and the area surrounding the  icon.