Insites Docs Instance LocatorLocator Custom Fields

Locator Custom Fields

Last updated on January 08, 2025.

Use custom fields to create any data model for your locations. This article discusses the following topics:

  • Creating a custom field
  • Field type and UI element glossary
  • Viewing custom fields
  • Updating a custom field
  • Deleting a custom field

Creating a custom field

To create a custom field:

  1. Navigate to the Locator from the main menu.
  2. Select Custom Fields.
  3. Navigate to the tab corresponding to the locator entity to which you want to add a custom field.
  4. Select ADD CUSTOM FIELD.
  5. Fill out the form for creating a custom field.
  6. Select SAVE FIELD. You can select ADD CUSTOM FIELD again to create more fields.
  7. Select SAVE to finalize the creation of your custom field(s).

The table below displays the input requirements and descriptions for creating a custom field:

Input LabelTypeRequiredDescription
Field Name Text Field Yes Name/label of the field. Insites cleans this field label automatically to follow internal database standards. For example, 'Sample Field' becomes 'sample_field' in the database.
Column Name Display Field No Displays the name used internally by Insites.
Field Type Dropdown Field Yes

Type of field. Some examples are:

  • Array
  • Date
  • Integer
  • Media
UI Element Dropdown Field Yes UI element used by the field. The range of inputs depends on the field type you have chosen. See the next section, 'Field Type and UI Element Glossary' for details.

Field type and UI element glossary

How to read this table:

Choosing a field type (column 1) gives you an array of available UI element options (column 2). Some UI elements (marked out with an asterisk) provide additional options (column 3). The input choices in column 3 are then outlined in column 4.

The field type, its associated UI element(s), and subsequent UI actions are outlined in the table below:

Field TypeUI ElementUI Element Fields (Options)Additional Option(s)Notes
Array
  • Checkbox*
  • File (Multiple)
  • Input (Multiple)
  • Select (Multiple)*
  • Checkbox: Options
  • Select (Multiple): Options
 -

Selecting 'Checkbox' or 'Select (Multiple)' displays additional fields outlined in the 3rd column.

This enables you to provide users with a checkbox or list of options.
Boolean Toggle - - Display a toggle.
Date Date Enables users to input a date.
DateTime Date and Time - - Allow users to input the date and time.
Data Source Select* Data Source (lists databases you can connect to) Display Field (available fields from the database in column 3)

The Data Source field allows you to select a separate database containing ONE value you want to display, a.k.a foreign key pairing.

For example, a user can choose one value, such as 'Large,' from one field called 'Sizes' when filling out this field.
Data Source (Multiple) Select (Multiple)* Data Source (lists databases you can connect to) Display Field (available fields from the database in column 3)

The Data Source (Multiple) field allows you to select a separate database containing MULTIPLE values you want to display, a.k.a foreign key pairings.

For example, a user can choose multiple values such as 'Large,' 'Medium,' and 'Small' from a field labeled 'Sizes.'
GeoJSON Code - - Enables users to input GeoJSON information for maps.
Float Decimal - - Allows users to input decimal values.
Media
  • Media - Image
  • Media - File
 - - Enables users to upload media such as files or images.
Integer Number - - Allows users to provide an integer input.
String
  • Colour
  • Code
  • Select*
  • HTML
  • Link
  • Radio*
  • Markdown
  • Multi-line
  • Phone
  • Input
  • Select: Options
  • Radio: Options
 -

The values 'Select' or 'Radio' in column 2 display an additional field labeled 'Options.'

This field can present users with a dropdown list or a radio group of input options.
Time Time - - Allows users to provide a time input.

Viewing custom fields

To view all available custom fields in the locator:

  1. Navigate to the Locator from the main menu.
  2. Select Custom Fields.
  3. Navigate to the tab corresponding to the locator entity containing the custom fields you want to view.

Updating a custom field

To update a custom field:

  1. Navigate to the Locator from the main menu.
  2. Select Custom Fields.
  3. Navigate to the tab corresponding to the locator entity containing the custom fields you want to update.
  4. Select EDIT CUSTOM FIELDS.
  5. Select the custom field you want to update.
  6. Make your changes.
  7. Select SAVE FIELD.
  8. Select SAVE.
Note

Please take note of the following system behaviors:

  • You can change the Field Name as it appears on the UI. However, the column name Insites uses in the database stays unchanged to preserve data integrity.
  • The Field Type cannot be changed.

Deleting a custom field

To delete a custom field:

  1. Navigate to the Locator from the main menu.
  2. Select Custom Fields.
  3. Navigate to the tab corresponding to the locator entity containing the custom field you want to delete.
  4. Select EDIT CUSTOM FIELDS.
  5. Select the custom field you want to delete.
  6. Select DELETE FIELD.
  7. Select SAVE.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.