Dictionary Creator

2023-02-15T21:35:23Z

Jeff: /* Default Search Field */

[[Main_Page|Main Page]]
__FORCETOC__
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.
[[File:DC_MainPage.png|thumb|upright=3|none]]
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 '''(selecting the option of "-----" from the drop-down list will reset the Dictionary Creator for you)'''.

 
=Dictionary Settings=
[[File:DC_DictOptions.png|thumb|none]]
===Saving Changes===
When you load an existing dictionary you will have both a <code>Duplicate/Create New</code> button and a <code>Save Changes</code> button. The ''Duplicate/Create New'' works like ''save as'' and will create a new dictionary with whatever name you have entered in the ''Dictionary Name'' box. ''Save Changes'' will save your changes to the existing dictionary.
[[File:DC_UpdateOrNew.png|thumb|none]]
If you have started from the blank template click the <code>Create New Dictionary</code> button after assigning a name (and sub-folder if desired) to create the dictionary.
[[File:DC_CreateNew.png|thumb|none]]
===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===
The mobile app user has an option to search the existing collected records right from the device. While any field can be used for the search, the administrator has the option to set the default field for the search. To make things more efficient the most common search field can be set here (i.e. Pole Number).
[[File:DC DictOptions.png|thumb|none]]

A second use of this setting is for the map labels on the mobile app. Common fields used for this are the pole number or circuit number.

If this setting is left blank (in the Dictionary Creator) simple map pins will be used.
[[File:AppMapStyles.jpg|thumb|none]]

===Field for Device Map===
In the [[https://wiki.goldenretrieverapp.com/index.php?title=Data_Management#Databases_Summary_Page 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=
[[File:AddField.png|none]]
==Default Dictionary 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.
[[File:DC_AutoFields.png|none]]
 

==Optional Dictionary Fields==
In addition to the basic fields, you can define as many other fields as you wish. These custom fields will all be placed after the automatic fields.
===Add Field===
To add a new dictionary field click on the green <code>Add field here</code> button at the location you wish to add the field.
[[File:AddField.png|none]]

===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 entering the desired position number in the box to the right of the green field box and clicking the <code>Move</code> button. The Dictionary Creator will automatically adjust all subsequent fields so there is no worry of overwriting a field.
[[File:DC_MoveField.png|thumb|none]]

===Delete Field===
To delete a field click on the red '''X''' by the field. You will be asked to confirm before deletion. Once this is done it is final; there is no 'undo' option.

===Define Fields===
Several data collection field types are available. Once you add a new field, you first need to select the field type from the drop-down list.
[[File:DC_NewField.png|none]]
====Define Field Type====
The first step is to select the field type from the dropdown list.
====Field Name====
This is the name which will be visible in the collection form on the mobile app. It will also be the column name in the online spreadsheet.
====Field Description====
This field description can be used to give more information for the end user (Mobile App user) as well as for anyone with a shared map link. This is an optional field attribute and may not be useful for all fields.
[[File:DC_FieldNaming.png|none]]
The field types are grouped into categories and are as follows:
 
=====Classic Fields=====
======Comment======
This is a text field which always defaults to a blank value. Instructions may be added which show up when entering a new record (on the mobile app). This text does not show up in the final data.
[[File:Field_Comment.png|none]]

======Picklist======
A drop-down list of values for the user to select. Click the <code>Add Picklist Option</code> as many times as necessary and type in the options you would like available to your users. Any unneeded picklist options may be deleted by clicking the red X to the right of the picklist option.
[[File:Field_Picklist.png|none]]
By default, the mobile app users may only select from the list. If desired you may allow custom entries by specifying a ''Length of Custom Entries'' value. The length value represents the maximum amount of characters they can use when creating a new picklist options. User-added picklist itmes will be recurring on the user's device (until they next refresh their dictionaries) but ''will not'' transfer to the dictionary or other devices.
[[File:Field_Picklist_useredit.jpg|thumb|none]]
Be careful what you wish for when opening up picklists to users. Whatever is inputted by the user will end up in the data. These entries will very easily include typo's and are bound to differ from user to user.

======Text======
This is one of the most common field types to use and while this is a 'simple text' field, there are several options available and some must be defined before your dictionary can be saved.
*Default Value - You may set a default value here. As users are entering records, the previous value will be transferred to the new record unless the ''Force Default'' checkbox is selected.
*Max Length - A maximum length must be set. A standard length length for text is 15 but can be shorter or longer. For a numeric field this number is how many characters are left of the decimal - the ''Number of Decimals Allowed'' setting will add to the maximum length.
*Min Length - An optional minimum length may also be set here.
*Max Value - A maximum value may be specified for numeric fields. For example, you may wish to disallow any pole year greater than the current year to minimize data entry errors.
*Min Value - A minimum value may be specified for numeric fields. For example, you may wish to disallow any pole year older than 1940.
*Number of Decimals Allowed - For numeric fields you may set the maximum number of decimals allowed. This is optional and may be left blank.
*Alphanumeric - You can set this to ''All Characters'' (including special characters), ''Letters and Numbers'', ''Numbers Only'' or ''Letters Only''.
*GPS Data - In addition to the default GPS fields which Golden Retriever automatically collects you may specify GPS coordinate fields for navigation. When defining these fields set this option to either ''longitude'' or ''latitude''. Without defining this option Golden Retriever will not recognize this field as containing GPS coordinates and will not plot the pole locations on the navigation map.
*Capitalize - When an ''Alphanumeric'' option containing letters has been selected you may choose to have Golden Retriever automatically capitalize either the first letter of each word or all letters. This avoids inconsistent data in the final data. This option is not shown when ''Numbers Only'' is the selected ''Alphanumeric'' option.
*Increment - When you have selected ''Numbers Only'' as the ''Alphanumeric'' option you may set this number to increment up or increment down. This option is not shown when ''Numbers Only'' is not the selected ''Alphanumeric'' option.
*Barcode Scanning - Select this option to enable barcode scanning as the input method for this field.
*Make This A TimeStamp -
*Always Locked - This prevents this field from being edited by the user.
[[File:Field_Text.png|none]]
 

=====Modern Fields=====
======Attachment======
With Golden Retriever you are able to add pdf documents to the collection dictionary. This can give the mobile app user quick access to Safety Data Sheets, Product Labels, Instructions, etc. through a clickable link from within the collection record.
======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.
======Formula======
With the formula field you can enter an equation string that is evaluated in the app. To reference another field in the dictionary use the format <code>~~Field Name~~</code>.

{| class="wikitable" style="margin:auto"
|+ Operator Precedence
|-
! Operator !! Associativity !! Description
|-
| (...) || None || Grouping
|-
| f(), x.y, a[i] || Left || Function call, property access, array indexing
|-
| ! || Left || Factorial
|-
| ^ || Right || Exponentiation
|-
| +, -, not, sqrt, etc. || Right || Unary prefix operators (see below for the full list)
|-
| *, /, % || Left || Multiplication, division, remainder
|-
| +, - || Left || Addition, subtraction
|-
| ==, !=, >=, <=, >, <, in || Left || Equals, not equals, etc. "in" means "is the left operand included in the right array operand?"
|-
| and || Left || Logical AND
|-
| or || Left || Logical OR
|-
| x ? y : z || Right || Ternary conditional (if x then y else z)
|-
| = || Right || Variable assignment
|-
| ; || Left || Expression separator
|}

{| class="wikitable" style="margin:auto"
|+ Unary operators
|-
! Operator !! Description
|-
| -x || Negation
|-
| +x || Unary plus. This converts it's operand to a number, but has no other effect.
|-
| x! || Factorial (x * (x-1) * (x-2) * … * 2 * 1). gamma(x + 1) for non-integers.
|-
|abs x || Absolute value (magnitude) of x
|-
| acos x || Arc cosine of x (in radians)
|-
| acosh x || Hyperbolic arc cosine of x (in radians)
|-
| asin x || Arc sine of x (in radians)
|-
| asinh x || Hyperbolic arc sine of x (in radians)
|-
| atan x || Arc tangent of x (in radians)
|-
|atanh x || Hyperbolic arc tangent of x (in radians)
|-
| cbrt x || Cube root of x
|-
| ceil x || Ceiling of x — the smallest integer that’s >= x
|-
| cos x || Cosine of x (x is in radians)
|-
| cosh x || Hyperbolic cosine of x (x is in radians)
|-
| exp x || e^x (exponential/antilogarithm function with base e)
|-
| expm1 x || e^x - 1
|-
| floor x || Floor of x — the largest integer that’s <= x
|-
| length x || String or array length of x
|-
| ln x || Natural logarithm of x
|-
| log x || Natural logarithm of x (synonym for ln, not base-10)
|-
| log10 x || Base-10 logarithm of x
|-
| log2 x || Base-2 logarithm of x
|-
| log1p x || Natural logarithm of (1 + x)
|-
| not x || Logical NOT operator
|-
| round x || X, rounded to the nearest integer, using "grade-school rounding"
|-
| sign x || Sign of x (-1, 0, or 1 for negative, zero, or positive respectively)
|-
| sin x || Sine of x (x is in radians)
|-
| sinh x || Hyperbolic sine of x (x is in radians)
|-
| sqrt x || Square root of x. Result is NaN (Not a Number) if x is negative.
|-
| tan x || Tangent of x (x is in radians)
|-
| tanh x || Hyperbolic tangent of x (x is in radians)
|-
| trunc x || Integral part of a X, looks like floor(x) unless for negative number
|}

{| class="wikitable" style="margin:auto"
|+ Pre-defined functions
|-
! Function !! Description
|-
| random(n) || Get a random number in the range [0, n). If n is zero, or not provided, it defaults to 1.
|-
| fac(n) || n! (factorial of n: "n * (n-1) * (n-2) * … * 2 * 1") Deprecated. Use the ! operator instead.
|-
| min(a,b,…) || Get the smallest (minimum) number in the list.
|-
| max(a,b,…) || Get the largest (maximum) number in the list.
|-
| hypot(a,b) || Hypotenuse, i.e. the square root of the sum of squares of its arguments.
|-
| pyt(a, b) || Alias for hypot.
|-
| pow(x, y) || Equivalent to x^y
|-
| atan2(y, x) || Arc tangent of x/y. i.e. the angle between (0, 0) and (x, y) in radians.
|-
| roundTo(x, n) || Rounds x to n places after the decimal point.
|-
| map(f, a) || Array map: Pass each element of <code>a</code> the function <code>f</code>, and return an array of the results.
|-
| fold(f, y, a) || Array fold: Fold/reduce array <code>a</code> into a single value, <code>y</code> by setting <code>y = f(y, x, index)</code> for each element <code>x</code> of the array.
|-
| filter(f, a) || Array filter: Return an array containing only the values from <code>a</code> where <code>f(x, index)</code> is <code>true</code>.
|-
| indexOf(x, a) || Return the first index of string or array <code>a</code> matching the value <code>x</code>, or <code>-1</code> if not found.
|-
| join(sep, a) || Concatenate the elements of <code>a</code>, separated by <code>sep</code>.
|-
| if(c, a, b) || Function form of c ? a : b. Note: This always evaluates both <code>a</code> and <code>b</code>, regardless of whether <code>c</code> is true or not. Use <code>c ? a : b</code> instead if there are side effects, or if evaluating the branches could be expensive.
|}

{| class="wikitable" style="margin:auto"
|+ Constants
|-
! Constant !! Description
|-
| E || The value of E
|-
| PI || The value of PI
|-
| true || Logical true value
|-
| false || Logical false value
|}
 

======Picklist - Multiple Selection======
A multiple-selection picklist allows for multiple choices. This is used for dictionary 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.
======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.
======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.
 
=====Calculator Fields=====
Golden Retriever has two pole strength calculator fields available. One based on the RUS Tables and one on the ANSI remaining strength tables. These can be used by field personnel to help determine pole integrity. Both calculator fields allow the author of the dictionary to set fields to pull data from as well as fields to record the results.
======RUS Deduction - RUS Tables======
======Strength Calc - ANSI Tables======
 
Golden Retriever has remaining strength calculations for symmetrical decay (internal and external) based on the ANSI tables. This field can be set up to pull information from other fields as well as record all data used for the calculations in a comment or text field. The image below shows assigned fields for most of the required information.
[[File:Field_StrCalc.png|none]]
Any information not automatically imported into the calculation will need to be added when the calculation popup is shown. Once the user taps the <code>CALCULATE</code> button the remaining strength values are recorded into the ''Remaining Strength'' field as well as the data used for the calculation into an assigned field.
{|
|-
| [[File:Field_StrCalc_Calc.jpg|thumb|none]] || [[File:Field_StrCalc_Record.jpg|thumb|none]]
|}
 This information can be accessed later by engineering staff either through the Admin Portal or from downloaded data.
 
 '''Online View'''
[[File:StregthCalc_OnlineData.png|none|border]]
 
'''Spreadsheet View'''
[[File:StrengthCalc_Data.png|none|border]]

=====Monitoring Fields=====
======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).
======Custom GPS======
Normally, if the mobile device is unable to obtain a GPS lock the user will be presented with a pop-up stating ''Could not get a GPS lock. Do you wish to wait?''. With this field, which is hidden from the collection screen, the user will be given the option to manually enter the GPS coordinates in addition to waiting.
======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).
 
=====Utility Pole Fields=====
For convenience Golden Retriever has some predefined pick lists for common utility pole inspection fields.
======Class======
A picklist of pole classes (1-10 and H1-H6). Once selected the list may be modified for your specific use by adding, deleting or editing any of the picklist items.
======Height======
A picklist of pole heights (lengths) from 15 to 120 in increments of five. Once selected the list may be modified for your specific use by adding, deleting or editing any of the picklist items.
======Manufacturer======
A very extensive picklist of current and historical pole manufacturers. Once selected the list may be modified for your specific use by adding, deleting or editing any of the picklist items.
======Species======
A picklist of common utility pole species. These are the common abbreviations for the species names (ie. WC - Western Cedar, SP - Southern Yellow Pine). Once selected the list may be modified for your specific use by adding, deleting or editing any of the picklist items.
 

==Field Options==
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.
[[File:DC_FieldOptions.png|thumb|none]]
===Required Field===
If the required checkbox is selected, this field must be completed for the record to save.
===Hidden Field===
Is the field visible on the mobile app. Sometimes it makes sense to pass data through to the final reports without cluttering up the field user's screen.
===Lock From Search===
If this is a field that will contain utility supplied data that the mobile app should never need to change, select this option. If the mobile app user doesn't need to see the data, use a Hidden Field instead.

===Force Default===
''Text'' and ''Single select Picklists'' can have default values assigned. If the ''Force Default'' is selected, whatever is in the default value box (can be left blank) is pre-populated in the collection form . 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===
[[File:DC_ShowHidePhoto.png|none]]
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.
[[File:DC_ShowHideExample.png|none]]
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.

==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 (if GPS locations are included in the data) and/or simply provide a local database of data that can be searched using the magnifying glass button in the app.
When uploading data into a dictionary it is important that the required field names match. Keep these things in mind:
*Latitude field ''should'' be named Y and must be set to the GPS Data type of 'Latitude'
*Longitude field ''should'' be named X and must be set to the GPS Data type of 'Longitude'
[[File:DC_LatField.png|thumb|none]]
*Field names are ''not'' case sensitive. As well, spaces and special characters are also ignored.
i.e. ''Pole Number'', ''POLE NUMBER'', ''pole number'', ''Pole_Number'', ''PoleNumber'' are all exactly the same and therefore considered duplicates
*Do not include these field names as they are reserved by the system
**RecordNo
**Latitude
**Longitude
**Date
**Device

*By default, Golden Retriever sets all supplied coordinates to a Red map marker and completed ones as Green. You may alternately set other colors by defining them (by number) in a '''MapColr''' field in your csv file. Green is 'reserved' for completed records. Red, Blue, Purple, Yellow and Orange are currently the other colors available for the 'TO DO' map markers. These are set in the csv which contains the utility supplied data. To accomplish this, add a field (csv only and ''not'' in the Dictionary Creator) called '''MapColor''' and identify the requested color by its number:
** '''0''' - Red
** '''1''' - Green (It is not recommended to use green markers)
** '''2''' - Blue
** '''3''' - Purple
** '''4''' - Yellow
** '''5''' - Orange
[[File:GR MapMarkerColors2.jpg|none|thumb]]

Note: The colors do not show the same on iOS and Android - the colors shown here are how they display on Android.

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.
[[File:DC_UploadCSV1.png|thumb|none]]
Once the file has successfully been uploaded the Local Database will show is ''Database Uploaded''. The csv can be removed at any time by clicking the red ''click to unassign'' link.
You can verify all fields with data by looking for the ''Note: field exists in uploaded database'' (in red) statement, located immediately under the Field Name.
[[File:DC_CSVUploaded.png|thumb|none]]
 
[[File:DC_UploadCSV2.png|none]]
Note: For instructions on how to extract pole data from a Utility supplied ''shapefile'' and other QGIS specific functions [[QGIS#Exporting_a_csv_for_Golden_Retriever_from_utility_supplied_shapefile|follow these instructions]].

Once you have uploaded the csv file and saved the dictionary, the data will be available on the mobile app once dictionaries are refreshed.
''If the poles do not show up in the expected location on the mobile app's map it is most likely due to incompatible GPS coordinates. Confirm that they have been supplied to Golden Retriever in EPSG:4326, WGS 84.''

=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 [[https://wiki.goldenretrieverapp.com/index.php?title=Data_Management#Databases_Summary_Page Dictionary Summary]] page of the Admin Portal.
[[File:DC_Assign.png|thumb|none]]

2022-04-27T20:39:34Z

Jeff: /* Map Markers */

[[Main_Page|Main Page]]
__FORCETOC__
===First Time Setup===
''This page is still under construction and is very incomplete.''
====Navigating Golden Retriever====
The main menu in the Golden Retriever app is in the top-left corner of the screen. All settings and maintenance actions are here ''scroll down to see the entire menu''.
{|
|-
| [[File:GR_Menu_1b.jpg|none|thumb]] || [[File:GR_Menu_2.jpg|none|thumb]]
|}

====First Time Setup====
Once you have installed the mobile app from either the [https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=1448948989&mt=8 iOS] or [https://play.google.com/store/apps/details?id=genics.umrysh.gr Android] app stores you will need to scan your activation key to access your account's collection dictionaries.
The first time you open the Golden Retriever app (any time you open it without login credentials) you will be presented with the login screen as shown below. You can also get to the login screen by selecting ''Change login code'' from the main menu.
[[File:GR_Login.jpg|thumb|none]]
There are two ways to enter the login code - scanning a QR Code or by entering the code manually. These are obtained from the [[License_Keys|License Keys]] menu item in the ''Admin Portal'' by your account administrator.
*'''Scan''' - Tap the ''Scan it'' link to use your device camera to scan the QR Code obtained from the Admin Portal (you will need to give permission for Golden Retriever to access the camera).
*'''Manually''' - The activation codes are quite long so normally the code would be copied (from the text or email it was sent in) and then pasted into the entry line. Because the login codes can contain special characters such as dashes '-' it is important to ensure that you copy the entire code. Once the code is entered, click the <code>Submit</code> button.
Once the code has been accepted by the system the available dictionaries will be downloaded and a map (centered on your current location) will appear.
#Set your device name in the ''Change device name'' to your full name. If you do not set it now you will be prompted for this information the next time you open the app.
#Select ''Refresh dictionary list'' to load all of your account's active collection dictionaries (if you just scanned a license key this will be done for you). Refreshing dictionaries will need to be done any time an Administrator makes changes to the collection dictionary. After confirming that you would like to proceed (any unsaved record you may be working on will be discarded) you have the option to update every dictionary on your device or just the one you are currently in. In order to obtain new dictionaries you will need to select ''All'' at this point.
#Select the desired collection dictionary from the ''Change dictionary'' menu item. Once loaded you will enter a map view centered on your current location (as provided by your device's GPS location).

====Mapping Options====
=====Map View=====
You can turn the map feature on/off in the ''Mapping'' menu item.
* '''Enabled''' - map centered on your location
* '''Disabled''' - black screen with a white paw print

=====Map Type=====
You can toggle between a street map and satellite map in the ''Type of Map'' menu item.
=====Map Markers=====
When working from a pre-populated map you will see the existing data points in red (or some other color other than green). As they have been completed they will turn to green. Due to limitations a maximum number of markers are ''drawn'' on the screen at any given time and priority is given to red ('to-do') markers. To ensure that no markers are missed it can be helpful to toggle the ''Green markers on map'' to the '''off''' setting.
[[File:GR app GreenPurpleMarkers.jpg|none|thumb]]

Green is reserved for completed records. Red, Blue, Purple, Yellow and Orange are currently the other colors available for the 'TO DO' map markers. These are set in the csv which contains the utility supplied data. To accomplish this, add a field (csv only and ''not'' in the Dictionary Creator) called '''MapColor''' and identify the requested color by its number:
* '''0''' - Red
* '''1''' - Green (It is not recommended to use green markers)
* '''2''' - Blue
* '''3''' - Purple
* '''4''' - Yellow
* '''5''' - Orange
[[File:GR MapMarkerColors2.jpg|none|thumb]]

Note: The colors do not show the same on iOS and Android - the colors shown here are how they display on Android.

When you originally select to show the green markers (completed records) there will be an expected delay. The reason for this is to avoid delays when working in larger dictionaries with thousands of coordinates to check. Golden Retriever first starts in the immediate area and slowly expands from there, checking points further away. This works by comparing the map points to all uploaded data. In time this will be up to date. To prioritize this step simply choose <code>Manual refresh/sync</code> from the main menu. You will then need to wait until all map points are checked.

====Feedback====
You can provide feedback to the Golden Retriever development team at any time by selecting 'Send feedback' and providing any comments or suggestions you may have.

File:GR MapMarkerColors2.jpg

2022-04-27T20:25:50Z

Jeff:

File:GR app GreenPurpleMarkers.jpg

2022-04-27T17:41:59Z

Jeff:

Upload Data

2022-02-17T15:14:30Z

Jeff:

[[Main_Page|Main Page]]
NOTE: This module is deactivated by default due to its potential for permanent damage to your data. Please contact us at ''info@goldenretrieverapp.com'' if you would like to discuss activating this module for your account or any of your users.
[[File:Uploads.png|thumb|none]]
For large amounts of data it is sometimes advantageous to download your data for editing in a spreadsheet program (on a computer) and then uploading the edited records into the database. The Uploads→Database Modifications option allows you to upload changes to your database.
''This module can seriously mess up your data. You take on all risk by utilizing this module. The Golden Retriever team will not be responsible if the data you upload detrimentally effects your users. However, the Golden Retriever team will assist you in anyway we can if something should go wrong. We advise you to download a copy of all data in the selected database prior to making any changes with this module.'' See [https://wiki.goldenretrieverapp.com/index.php?title=Data_Management#Downloading_Records_in_CSV_File Downloading Records in CSV File] for directions.
Steps
#From the '''Admin Portal''' download and backup a copy of your database on your computer.
#Open the <code>.csv</code> file in your spreadsheet program (LibreOffice, MS Office, etc.).
#Delete the ''Date'' column as Excel will change the date format (which will cause data loss and break functionality in the Admin Portal).
#Delete all columns which you do not wish to update with the exception of the ''RecordNo'' column. Without the ''RecordNo'' column all rows will be inserted into the database as '''new''' records. Note: The RecordNo column must be included - without values records will be inserted as new records; with values the records will be updated with the modified data.
#Review your data and make necessary changes.
#Save file in a <code>.csv</code> format with an easy to remember file name
#Back in the '''Admin Portal''' select Database Modifications.[[File:Modifications1.png|thumb|none]]
#Select the database to upload to .
#Select the modified <code>.csv</code> file.[[File:Modifications2.png|thumb|none]]
#Click <code>Update Database</code> to upload your changes.
 
As mentioned above in step 4, it is also possible to insert new records into your database. To do this simply ensure that the ''record number'' field is empty.

''NOTE: This module can seriously mess up your data. You take on all risk by utilizing this module. The Golden Retriever team will not be responsible if the data you upload detrimentally effects your users. However, the Golden Retriever team will assist you in anyway we can if something should go wrong. We advise you to download a copy of all data in the selected database prior to making any changes with this module.'''

Data Management

2022-02-16T17:39:21Z

Jeff: /* Export as a Shapefile */

[[Main_Page|Main Page]]
__FORCETOC__
===Data Management===
The purpose of Golden Retriever is to collect data so that it can be used for analysis and action. Tools have been and will continue to be developed to aid in this . This section describes these tools.
''Please feel free to send the Golden Retriever development team any suggestions or requests that you may have.''
 
====Databases Summary Page====
The Database Summary Page is the first thing you'll see when you log in to Golden Retriever. Here you will be able to find your data. When you click on the <code>Databases</code> menu item you will get a table showing all your account's active databases. You can toggle between active and archived by clicking on whichever of "Active databases" or "Archived databases" is in blue. Golden Retriever automatically archives any dictionary/database where the newest record is older than six months.
 This table gives you basic statistics of what data (total records, etc.)
is in each dictionary.
[[File:DatabasesTable.png|none|Caption:Table showing all Active databases]]
=====Name=====
The dictionary/database name
=====Group=====
The subfolder on the mobile app which contains the dictionary. This is set in the Dictionary Creator.
=====Total Records=====
The total number of records in the database. For example, if you have 100 pole records and 100 meter records in your database then your total count will read 200 records.

=====Total Photos=====
The total number of photos in the database.
=====Size=====
The total amount of storage memory.
=====Last Record Uploaded=====
Shows the most recent record uploaded. Clicking on the date will bring up a map showing the most recent record's GPS location.
[[File:LastRecordUploaded.png|thumb|none|Caption:Follow link to map of record's location]]
In addition to the timestamp of the last upload record, one other field may be shown (set in the ''Dictionary Creator'') such as crew name or inspector name. This can assist with keeping track of where your crews are currently working. By default the unique device id will be shown but any other field in the dictionary may be used - '''''Refer to the Dictionary Creator instructions on this'''''.
[[File:LastLocationMap.png|thumb|none]]

=====Records Today=====
The total number of records uploaded today.
=====Photos Today=====
The total number of photos uploaded today.
=====Hidden=====
Shows 'yes' if the dictionary hidden from the mobile app. Normally collection dictionaries are hidden from the mobile app before and after they are required in the field, to keep the mobile system cleaner.

=====Total data used=====
This is the total amount of storage used by all of your databases combined (including photos). This shows you where your account is in regards to any additional storage fees.

 

====Database View====
By clicking on a database name you will be taken to a screen showing:
*All Data (Records) in the Database
*Download and Export Options
*Option to Delete Both the Database and Dictionary (''available to Admin's only'')
 [[File:SortingRecords.png|none|frame]] 
======Viewing and Sorting Records======
Columns can be moved and resized as required. clicking on a heading will sort the current list by the data in that column (database field).
======Search Records======
At the bottom of the online spreadsheet are options to view, sort, search, add, edit and delete records.
[[File:SearchRecords.png|none|frame|Caption:Click <code>Find</code> to view for all records from February 14th by the inspector Bob]]
Clicking on the search button (magnifying glass icon) will bring up the search window where you can search by multiple criteria.

======Editing Records======
To edit a record click on the record to edit. It will turn yellow when selected. Click the edit button (pen icon) to enter 'edit' mode.
[[File:EditRow.png|thumb|none]]
This will open the record for editing. When finished click the save button to update the record or cancel
to discard changes.
[[File:SaveChanges.png|none|thumb]]
[[File:CancelEdit.png|none|thumb]]
E''diting this data is forever. It is suggested to first download a copy of the data as a backup before editing.''

======Exporting Current View======
Once you have the data sorted the way you want you can click the <code>Export</code> button in the bottom-left corner of the spreadsheet to download a csv file of exactly what is currently shown. The csv file can then be opened in a spreadsheet program such as Excel or Libreoffice Calc.

======Viewing the Record's GPS Location======
Clicking on either the <code>Latitude</code> or <code>Longitude</code> will open a new tab with a Google Map of that record's GPS location.
======Viewing Photos======
The photos are located in the far right-hand column of the spreadsheet.
[[File:OS_Photos1.png|none]]
*Click on the photo names to open them in a new browser tab.
*To delete photos click <code>Del</code> beside the photo name.
*Additional photos can be uploaded into the record by clicking the <code>+Add</code> button
 
Photos can be downloaded individually by saving them when they are opened in a browser tab. To download photos in batches, use the steps shown below in [[Data_Management#Downloading_Records|Downloading Records]] and select "Include photos".
Note: Photos and records can be downloaded together or separately depending on the checkboxes.
 

=====Downloading Records=====
The records in the database may be download either in a <code>csv</code> (comma-separated values) file or in an <code>xlsx</code> file. This is the most common way to get your data.
[[File:DownloadOptions.png|thumb|none]]
The available options are:
*All Data - every record in the database
*Incremental - only records added since your last download date
*Data Between - choose and date range to download data from
*Include photos - a checkbox selection to include the photos
*Include data - a checkbox selection to include the data
*Capitalize data - a checkbox selection to capitalize all text in the data
*Export as xlsx instead of csv - csv is the default file format
*Custom Report - if available you may select a custom report for the data
Click the <code>Start Download</code> button when ready. Once the Golden Retriever system has the data ready your browser's download dialog will open.

=====Export as a Shapefile=====
Golden Retriever gives you the option to download a shapefile of your data. This shapefile makes it easy for your utility customer to import the collected data directly into their GIS system. You can export the entire database or just a portion of it. To limit the records exported, first filter the data in the online spreadsheet to only show the required records (by date, circuit, inspection type, etc.).
[[file:OS_ExportShapefile1.png|border]] 
There are many GPS coordinate formats available. For simplicity sake Golden Retriever system has a select few options - contact us if you require additional formats and we will add them to the list. First, select the desired 'Projection' for your GPS coordinates.
[[file:OS_ExportShapefile2.png|thumb|none]] 
Next you will need to confirm which fields containing the ''latitude'' and ''longitude'' coordinates and set a name for the shapefile. By default Latitude and Longitude are selected as these fields contain the coordinates collected by the Golden Retriever app.

'''''Note: If you have performed any data filtering in the above online spreadsheet those filters will be reflected in the created shapefile.'''''

There is a text entry box labelled "''Shapefile column template''". By default the shapefile will be created with each column being defined as a "String" without any defined precision on the field. Most of the time this will be more than fine however you may find the GIS you plan to add the shapefile to has certain column requirements. Such as a particular column needing to be of type "Integer" with a precision(length) of 10 digits. When you try to add the shapefile your GIS throws an error that the column is not in the correct format. In such cases you are able to paste a string into this text entry box to tell the shapefile creator to uses your specified column types and precision.

You must make sure your column template string is in the following format:

<pre>{"types":"ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTReal,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString","pres": [50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,1,50,50,50,50,50,50,50,50,50,50,50,50,50]}</pre>

'''Technical Description'''
<div class="toccolours mw-collapsible mw-collapsed">
Expand to show detailed instructions on the required format. ''Please contact the GR team if you require any help with this.''
<div class="mw-collapsible-content">
which is a minified version of the following JSON:

<pre>
{
"types": "ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTReal,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString,ogr.OFTString",
"pres": [
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
1,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50,
50
]
}
</pre>

The above is fairly self explanatory but what you are doing is defining the type and the precision of every column in the shapefile.

The types that are currently available for user are:

* ogr.OFTInteger
* ogr.OFTString
* ogr.OFTReal
* ogr.OFTBinary
* ogr.OFTDate
* ogr.OFTTime
* ogr.OFTDateTime
* ogr.OFTInteger64

One thing to remember is you '''must define a type and precision for every column in your shapefile'''. If you don't you may encounter errors.
</div></div>

 
Once you are ready simply click the <code>Generate Shapefile</code> button and the system will get to work on it. You will receive an email once your shapefile is ready for download - the download link will be valid for three hours.
======Step by Step Instructions======
#Navigate to the desired database.
#Sort data by any required criteria (''i.e. date range, inspection type'').
#If applicable, select a custom report.
#Select a specific Projection if required or leave the default.
#Select the correct Longitude and Latitude fields. ''This should default correctly unless a custom report is being used.''
#Paste the ''Column Template'' into the Shapefile Column Template box.
#Enter your desired file name.
#Click <code>Generate Shapefile</code>
#Monitor your email for download link or error messages.
'''''Note: To select a date range for a shapefile this must be done in the online spreadsheet filters.'''''
 

=====Send data to ArcGIS=====
For users who have a paid ArcGIS account you may enter your account information and then send your data to that account to make an online map available to you and any of your customers who need it. Instructions are [[Export_to_ArcGIS|here]].
Click the <code>Send to ArcGIS</code> to send the data to ArcGIS.
 
=====Deleting Dictionaries=====
If a collection dictionary '''''and''''' it's associated data are no longer required (housekeeping or storage costs) you may delete them here. At the very bottom of each database page is a <code>Delete</code> button in red font. This will delete your collection dictionary and all data in it. Once you have deleted the dictionary and database your ''Total data used'' will be adjusted.
[[File:DeleteDictionary.png|thumb|none]]
Note: This will delete '''''both''''' your collection dictionary '''''and''''' all of the data currently in this database.
[[File:DeleteDictionaryConfirm.png|thumb|none]]

File:OS ExportShapefile2.png

2022-02-16T17:16:56Z

Jeff:

2021-09-29T20:59:55Z

Jeff: Jeff uploaded a new version of File:ShareMap View.png

Share Maps

2021-09-29T20:52:59Z

Jeff: Created page with "===Shareable Maps=== Golden Retriever allows you to share maps with their respective data. This is useful for reasons as specific as keeping an up-to-date map of ''Priority Re..."

===Shareable Maps===
Golden Retriever allows you to share maps with their respective data. This is useful for reasons as specific as keeping an up-to-date map of ''Priority Rejects'' or simply to share the collected inspection data.
When your customer (or you) use the shared map link (custom url) you will be presented with a Golden Retriever map page. From here they can zoom in on the individual poles, click on the pole icons to see the attributes, view any photos attached as well as download the data.
[[File:ShareMap_View.png|none|Caption:Using the shareable link you are presented with a zoomed-out map]]
 
====Viewing Data - Map View====
Currently in the beta stage of development, the Golden Retriever mapping is accessed from the online spreadsheet view of a dictionary/database. All filtering of data in the spreadsheet is reflected on the map - for example, if you search for all ''Priority Rejects'' both the spreadsheet and the map will only show the records matching that criteria. See [[Data_Management#Search_Records|Search Records]] for information on this.

====Creating Share Link====

====Managing Shared Maps====

File:ShareMap View.png

2021-09-29T20:34:03Z

Jeff: Jeff uploaded a new version of File:ShareMap View.png

File:ShareMap View.png

2021-09-29T20:30:49Z

Jeff:

Admin Portal

2021-09-29T20:30:16Z

Jeff: /* Admin Portal */

===Admin Portal===
The Admin Portal (https://goldenretrieverapp.com/admin) is the place for all account administration and data management.

[[File:MainMenu_WithMapping.png|none|frame|Caption:https://goldenretrieverapp.com/admin]] 
Here you can:
* [[Data_Management|View/Edit/Download Collected Data]]
* [[Share_Maps|Share Maps and Data]]
* Get to this documentation wiki
* [[License_Keys|Purchase/Cancel License Keys]]
* [[Update_Sleep_Status|Update Sleep Status]]
* [[Update_Payment_Settings|Update Payment Settings]]
* [[Export_to_ArcGIS|Manage ArcGIS Settings]]
* [[Manage_Users|Add/Edit/Delete User Accounts]]
* [[Manage_Users|Manage Account Settings]]
* [[Upload_Data|Upload Data Directly Into Databases]]
* [[Dictionary_Creator|Create/Edit/Delete Collection Dictionaries]]
 
Admin Portal access is not only for your account administrator(s) but also for any user who needs to access inspection records. Users of your account will see only the dictionaries which they have been given access to.

Admin Portal

2021-09-29T20:05:19Z

Jeff: /* Admin Portal */

===Admin Portal===
The Admin Portal (https://goldenretrieverapp.com/admin) is the place for all account administration and data management.

[[File:MainMenu_WithMapping.png|none|frame|Caption:https://goldenretrieverapp.com/admin]] 
Here you can:
* [[Data_Management|View/Edit/Download Collected Data]]
* Get to this documentation wiki
* [[License_Keys|Purchase/Cancel License Keys]]
* [[Update_Sleep_Status|Update Sleep Status]]
* [[Update_Payment_Settings|Update Payment Settings]]
* [[Export_to_ArcGIS|Manage ArcGIS Settings]]
* [[Manage_Users|Add/Edit/Delete User Accounts]]
* [[Manage_Users|Manage Account Settings]]
* [[Upload_Data|Upload Data Directly Into Databases]]
* [[Dictionary_Creator|Create/Edit/Delete Collection Dictionaries]]
 
Admin Portal access is not only for your account administrator(s) but also for any user who needs to access inspection records. Users of your account will see only the dictionaries which they have been given access to.

File:MainMenu WithMapping.png

2021-09-29T20:05:03Z

Jeff: