Dictionary Creator

From Golden Retriever Wiki
Jump to navigationJump to search
Note: This page is under development and as such is not yet complete.

Dictionary Creator

Collection dictionaries are made by account administrators from the Admin Portal in the Dictionary Creator main menu item. Here you can create, view and edit what data is collected and how it is collected.

DC MainPage.png

When you first navigate to the Dictionary Creator window you will see a drop-down menu which contains all of your collection dictionaries as well as an empty collection dictionary form. You can either start a new dictionary from scratch by typing in a name and adding new fields or modify an existing one by selecting it from the list. When you load an existing dictionary you will have both a Create Dictionary and an Update Dictionary button. The Create Dictionary works like save as and will create a new dictionary with whatever name you have entered in the Dictionary Nam box. Update Dictionary will save your changes to the existing dictionary.

DC Create-Update.png


Dictionary Settings

DC DictOptions.png
Dictionary Name

Each dictionary needs a name. It is suggested to name each dictionary with the customer name and year. Where multiple dictionaries are used for the same customer those line or circuit names can be used as well.

Sub Folder

Sub Folders are a great way to organize your collection dictionaries in the mobile app. This is optional and if not set here the dictionary will be shown in the main dictionary directory.

Dictionary Order

By default all dictionaries will be shown in the mobile app in alphabetical order. Normally this works but if you wish to specify the order manually the number you enter here will dictate the order shown when selecting a dictionary in the app.

Default Search Field

When searching online records the user has the option of which field to search. Any of the dictionary fields may be set as the default search field. To make things more efficient the most common search field can be set here (i.e. Pole Number).

Field for Device Map

In the [Databases Summary Page] it is possible to view on a map, the most recent record's GPS location for each device. By setting an inspector name instead of the id of the device, any change in phone/tablet will not effect this maps functionality.

Duplicate Records Allowed

By default saving changes as duplicate records is allowed. This is to avoid data loss due to editing mistakes. However, this does create more administration work later on to edit and consolidate these duplicates. By selecting this option no duplicates will be allowed by the mobile app for map markers once they turn from red to green. This is when working from a map of data supplied by the utility as this is location specific (Pole Number, etc makes no difference.

Photo Required

If a photo is required for every inspection record select this check-box to force a photo before the app will save a new record.



Dictionary Fields

AddField.png
Automatic Fields

Golden Retriever uses several fields for every dictionary which are automatically completed by the system. These fields are shown in the Database view. They are:

  • RecordNo - the record number assigned by the database when the record is uploaded
  • Latitude - the latitude of the GPS location
  • Longitude - the longitude of the GPS location
  • Date - An automatic timestamp when the record is saved in the mobile app
  • Device - The unique device id as supplied by the mobile device.
DC AutoFields.png
Add Field

To add a new dictionary field click on the green Add field here button at the location you wish to add the field.

Move Field

The fields will appear on the mobile app collection form according to the order they are in the Dictionary Creator. They can be moved by using the up/down arrow buttons to the right of the field.

Delete Field

To delete a field click on the red X by the field.

Defining Fields

First, select the field type from the drop-down list. The available field types are:

  • Altered Data
  • Attachment
  • Comment
  • Custom GPS
  • Date Picker
  • Elevation
  • Picklist
  • Picklist - Multiple Selection
  • RUS Deduction
  • Signature
  • Spacer
  • Strength Calc - ANSI Tables
  • Text
  • Weather


Once you have selected the field type, all of it's options will be displayed. Assign a name to it and complete any field options. Most fields have four basic options.

DC FieldOptions.png
Required Field

If required, this field must be completed for the record to save

Hidden Field

Is the field visible on the mobile app

Lock From Search

Not every field is very searchable so this can be used to de-clutter the search fields list

Force Default

Text and Single select Picklists can have default values assigned. If the Force Default is selected the default value is pre-populated in the collection form (i.e. a blank value). Otherwise whatever has been entered in the previous record will copy to the new record - this is good for fields such as line or circuit number which do not change often.

Show/Hide Field
DC ShowHidePhoto.png

To keep collection forms easier to navigate hiding certain fields if unneeded can be beneficial. For example, different collection data is required for poles than for meters if both are being inspected. For this to work all possible combinations must be defined - if the picklist you are referencing has five different options then all five must be accounted for. When you are setting this up there is an option everything else which can be used to save time. Once the dictionary is saved this will be filled out long hand and show all combinations.

DC ShowHideExample.png
Note: Failure to account for all options will lead to inconsistent results.


Require Photo

Sometimes a photo is required only when a certain condition is met. This can be set here.

Field Type Descriptions

Altered Data

This is a hidden field from the mobile app user and will record any changes made to the original utility supplied data (as seen by the app users in the map or online search function).

Attachment
Comment
Custom GPS
Date Picker

The Date Picker field will open up a calendar screen where the user can select a date. This is different from the automatic timestamp field for each record.

Elevation

Elevation is a hidden field (hidden from the mobile app user) and is automatically populated during the inspection. It can be set to Metric (metres) or Imperial (feet).

Picklist

This is used to allow a mobile app user to select from a predefined list of options (i.e. height, class, original treatment, etc)

Picklist - Multiple Selection

A multiple-selection picklist allows for multiple choices. This is used for deficiency fields where you need to record multiple things if they exist. This data is stored in a text field similar to a notes field and can not be used for any show/hide rules.

RUS Deduction
Signature

The signature field allows for signature collection using the device's touchscreen. This is most useful when customizing a collection dictionary as for Tailgate safety meetings and for other administrative tasks. Due to crews being spread out it can be difficult to distribute forms to the crews and to receive the completed forms back. Golden Retriever can be used as a tool to aid in this by creating specific dictionaries.

Spacer

The spacer is not a data field but a horizontal line which is displayed in the mobile app to visually separate different categories of fields in the collection form. Use of this is completely voluntary.

Strength Calc - ANSI Tables
Text
Weather

When a user taps this field in the mobile app, while conducting the inspection, the current weather conditions will be recorded in the inspection record. Golden Retriever is also often used by vegetation control companies to record their herbicide mixing and application - in which weather plays a large role.

Upload Supplied Data

When asset location and other details are supplied by the utility this information can be uploaded into the collection dictionary to give a map of the assets to be inspected.

Note: the file must be a CSV (comma delimited and enclosed with double quotes), any coordinates must be in WGS84 format (EPSG:4326), and the column names must match the columns in the dictionary for them to be used by the program.
DC UploadCSV1.png
DC UploadCSV2.png

Assign Dictionary

For Administrators working with multiple Golden Retriever accounts you may assign/unassign collection dictionaries as needed. Select the checkbox beside the account(s) you wish to have access to the dictionary - both on mobile app and in the [Dictionary Summary] page of the Admin Portal.

DC Assign.png