golden · 2017-08-30 · if golden retriever is unable to get a gps reading it will also give the...

40
Golden Retriever Manual Version 2.3 1

Upload: others

Post on 20-Jul-2020

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

Golden

Retriever

Manual Version 2.3

1

Page 2: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

Contents1 Installation and Activation of Golden Retriever Page 3

2 Selecting a Collection Dictionary Page 8

3 Searching for an Asset Page 11

4 Collecting Asset Information Page 17

5 Editing Collected Asset Information Page 22

6 Viewing the Assets on a Map Page 24

7 Menu Options Page 27

8 Special Fields Page 29

9 Integrated Bluetooth GPS Page 32

10 Viewing Data Uploaded to the Sample Asset Collection Dictionary Page 34

11 Hosting the Data Page 35

12 Downloading the Data Page 36

13 License Keys Page 39

14 New Add-Ons Page 40

15 Languages Page 40

16 Some Upcoming Updates/Features Page 40

2

Page 3: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

1. Installation and Activation of Golden Retriever1. Download Golden Retriever from the Google Play Store [http://goo.gl/lXL7ei]

3

Page 4: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

2. When you open Golden Retriever for the first time it will ask you to scan a license key. For the purposes of this guide we will be using the public license key. If you have you have been provided a key you can scan it instead.

4

Page 5: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. The last Screen shot on the Play Store listing is a copy of the license key. You may either scan the key from there or scan the image provided below. You will need to have a barcode scanning app installed on your device. I recommend “Barcode Scanner” by Zxing [http://goo.gl/aBEyXh] NOTE: You must have an internet connection to activate Golden Retriever.

5

Page 6: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

4. If activation is successful Golden Retriever will begin downloading all the dictionaries as well as any offline databases available to your license key. The public key is assigned 1 dictionary that has 200 searchable offline records.

6

Page 7: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

5. Once alerted that all databases have been updated we have to select a collection dictionary.

7

Page 8: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

2. Selecting a Collection Dictionary1. Click on the three dots in the upper left hand corner of the screen. This will bring up the

menu.

2. Click on the menu item titled “Change Dictionary”

8

Page 9: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. You will be presented with a list of all the collection dictionaries tied to your license key. For our demonstration select the one titled “Sample Asset Collection Dictionary”

9

Page 10: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

4. You will be brought back to the main screen but the main title will now show the selected dictionary as well you have a button to begin entering a new asset collection. If your dictionary has searching enabled, you will see a magnifying glass in the top right corner of the screen.

10

Page 11: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. Searching for an Asset1. If your selected dictionary has searching enabled click on the magnifying glass in the top

right-hand corner of the screen.

2. From the drop-down list select the field you would like to search. (NOTE: a default search field can be set when the administrator creates the dictionary)

11

Page 12: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. In the text entry box enter the value you would like to search for. Golden Retriever accepts wildcards for this search. For example, if you wanted all records simply enter a * in the search field. For all values that end with a 5, enter *5. For all values that have the phrase “danger” enter *danger*. You can also use the camera button beside the text entry field to scan a barcode.

12

Page 13: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

4. If the keyboard is still visible on the screen, minimize it to make the search button visible. Or if you are using the default Android keyboard the “Enter” key will be replaced with a search button like in the image above.

5. Click the search button on the bottom of the screen to begin your search. The sample dictionary has both offline and online searching capabilities. If you are connected to the internet Golden Retriever will pull down any matching search results from previous collections you entered already. The online sample database is erased nightly.

13

Page 14: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

6. If Golden Retriever finds results offline and online your screen will have two tabs at the top.Otherwise you will just be provided one list.

14

Page 15: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

7. Scroll down the list until you find the record you wish to view and click on it. You will be shown the information for that record. At the bottom of the screen is a button to “Enter NewRecord Based On This Asset”. Clicking on this button will start a new collection but will pre-fill any matching fields. In this particular example we also have four GPS fields. Clicking on these will bring up Google Navigation directly to the asset.

15

Page 16: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

8. All of the pre-filled fields will be locked for the new collection unless the user clicks the “Alter Original Data” button at the top of the screen. The exception is with pre-filled fields that are blank. These are left unlocked for the user to fill in.

16

Page 17: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

4. Collecting Asset Information

1. From the main screen click the button on the bottom titled “Enter Asset”.

2. When the dictionary is designed the administrator will define certain parameters for each field. Such as:1. Drop-down list or Text entry2. Is the field a required field3. Min and max length of text fields4. Min and max values for number fields5. Allowed number of decimal places for number fields6. Default values for the field

17

Page 18: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

7. Whether the text entry can contain:1. All characters2. Alphanumeric Only 3. Numbers Only4. Letters Only

8. If the field is to always be locked when coming from a search. Even clicking the “Alter Original Data” button will not unlock this field. The field is therefore only editable if entering a new record using the “Enter Asset” button.

9. If the default value should always be forced. In other words, ignore the “Auto-Populate Fields” setting.

3. At the bottom of the screen the user is given three buttons.1. Trash Can : Cancel current collection2. Camera : Take a Picture3. Floppy Disk : Save collection record

4. If you wish to add a photo to this collection record click on the camera button on the bottombar. Golden Retriever will send the user to the camera app. Please note that high resolution pictures can be bandwidth expensive. I suggest turning down the resolution of your camera to VGA. Once you have taken the picture you can hit the “X” to cancel saving the picture orclick the checkmark to save the picture. You will be brought back to your ongoing collection. There is no limit on the amount of pictures that can be assigned to a collection record.

18

Page 19: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

5. Once finished click on the Floppy Disk icon to save the collection. If there are any data entry errors Golden Retriever will give you a pop-up with any corrections that are needed before you can save the record.

19

Page 20: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

6. Golden Retriever will quickly flash a pop-up on the screen when it obtains a GPS coordinate along with information pertaining to the collected coordinate. If the user has set arequired accuracy Golden Retriever will keep rejecting coordinates until it is able to receive one that meets the set value.

20

Page 21: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

7. If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if they would rather just enter zeros for the reading. If the user chooses to wait they will need to click on the save button again ata later time.

8. Golden Retriever is programmed to attempt to upload data and photos in the background while open. To deactivate this feature change the “Auto-Upload Setting” in the Menu.

21

Page 22: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

5. Editing Collected Asset Information

If you have deactivated the Auto-Upload feature of Golden Retriever from the menu you will be able toedit any saved records still residing on your phone. Note that you will need to eventually select ManualUpload from the menu to upload your saved data at a later time.

1. Clicking on the Edit Assets menu item will change Golden Retriever into Edit mode. You will be presented with a list of all the stored records for the selected dictionary.

22

Page 23: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

2. Clicking on a record will allow you to Edit the values stored. You are also able delete the record(and all accompanying photos) by clicking on the “X”.

23

Page 24: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

6. Viewing the Assets on a Map

If the offline database for your selected dictionary contains GPS coordinates you will see a Google Map icon displayed on the main page. Clicking on the icon will bring up a Google Map of the points. Ifthe device is able to get your current location the map will auto-zoom to your current location otherwise you will have to zoom it in yourself.

24

Page 25: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

Clicking on an asset will provide the same result as if you had searched for that asset directly. You are the able to click on the “Enter New Record Based On This Asset” button.

25

Page 26: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

If you have “Online Search” set to “On” in the menu Golden Retriever will also query the Golden Retriever servers as you navigate the map to discover if an asset has an online record. If so it will highlight the asset in green rather than red. To re-sync the map simply hold down anywhere on the mapto clear all the green icons and have Golden Retriever begin to re-query the servers for matching onlinerecords. Or, if you would like to re-sync all the assets in the entire dictionary you can select "Manual Refresh/Sync" from the menu.

26

Page 27: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

7. Menu Options1. Edit Assets: If Auto-Upload is

deactivated Golden Retriever willallow you to edit any records you havestored on the device. [more info insection 5]

2. Change Dictionary : Choose from alist of collection dictionaries availableto the activated license key.

3. Refresh Dictionary List : Update yourlist of collection dictionaries to thecurrent version on the servers.

4. Manual Upload : Immediately startuploading data. Ignores the “Auto-Upload Setting” preference.

5. Manual Refresh/Sync: This will clearall the green colored assets from themap and manually re-check each andevery asset in the database for anonline record.

6. Connect/Disconnect to the userspecified Bluetooth GPS Device.[more info in section 8]

7. Open the Blutooth GPS device optionscreen. [more info in section 8]

8. Change License Key : Removes alldictionaries on the unit and deactivatesGolden Retriever so that a new licensecan be applied.

9. Send Feedback : Email me any comments or suggestions10.Auto-Upload Setting : Define how Golden Retriever should handle background uploading.

Options are: Data and Photos, Data Only, or Off.11.Upload Delay: This allows you to have your device auto-upload based on the "Auto-Upload

Setting" but do so at the set delay (in hours). For example, if you wanted to maintain the last2 hours worth of data on the device so that the user can go back and correct errors but after two hours of not being modified you want the device to upload the data.

27

Page 28: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

12.Online Search Setting : Whenworking with limited internetconnectivity it can be beneficial toturn off online searching. This wayGolden Retriever will only query theoffline database for searches.

13.Auto-Populate Fields : GoldenRetriever can either pre-populate thecollection fields with the defaultvalues defined in the dictionary orinstead pre-populate the fields withthe last submitted data.

14. Required GPS Accuracy : Using thissub-menu you can force GoldenRetriever to only accept GPScoordinates that meet the accuracy you set. For example, if you require sub-meter accuracy this is where you set that requirement.

28

Page 29: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

8. Special Fields1. If you have fields marked “Latitude” and “Longitude” in your data Golden Retriever will

change those fields to be colored blue. Clicking on the blue words will bring up Google Navigation directly from your current location to the coordinates. You can test out this feature by entering an asset collection in the public collection database and then searching online for your entry. The search results for that record will contain coordinates from when you entered the collection.

29

Page 30: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

2. StrengthCalc : This dictionary field is used in conjunction with the Wood Strength Calculator Add-on [http://goo.gl/5EDaTP]. Clicking on the blue text will bring up the WoodStrength Calculator add-on where the user can enter external and/or internal rot and be given the section modulus remaining, section inertia remaining, and the section area remaining. If ANSI information is entered it will also give these values in regards to the ANSI standard.

3. Elevation : Adding this hidden field to your dictionary will allow you to have Golden Retriever collect the elevation of the asset. Elevation can be collected in either Imperial or Metric units.

4. Auto-incrementing : If a text entry field is defined to allow only numbers a special flag can be added to convert it into an auto-incrementing (or auto-decrementing) field. The field name will appear in blue and when clicked will allow the user to switch between:

1. “Up” - If the value has not been pre-filled with search data, use the last value enteredincremented by 1

2. “Down” - If the value has not been pre-filled with search data, use the last value entered decremented by 1

3. “None” - Do not increment or decrement the value. Act like a regular text entry field.

4. “Blank” - If the value has not been pre-filled with search data, blank the field.5. CustomGPS : Adding this hidden field to your dictionary will allow the user the option to

manually fill in GPS coordinates in the event the device cannot get a GPS reading6. AlteredData : Adding this hidden field to your dictionary will keep track if the user has

clicked the “Alter Original Data” button. This field will default to True if there were blank fields in the search data as these fields are by default not locked for editing.

7. Comment : This is a special text entry field that will always default to blank on a new record. The field is also clickable. When clicked it will display to the user a list of notes (as specified when the dictionary was created) such as the acronyms to utilize in their comments.

30

Page 31: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

8. Datepicker: This is a clickable field that will open a date screen for the user.

9. Weather Conditions: When clicked, this field will utilize the current location of the device toquery https://forecast.io for the current weather, current wind, temperature, humidity, and visibility conditions.

31

Page 32: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

9. Integrated Bluetooth GPSIf you wish to utilize an external Bluetooth GPS device Golden Retriever can now communicate with the devices through an add-on. To install the add-on simply click on one of the menu options pertainingto Bluetooth GPS and Golden Retriever will offer to send you to the Google Play store to download theadd-on. To begin using the integrated GPS click on the menu option titled “ Bluetooth GPS Options” and you will be forwarded to the add-on's configuration page. If you have Bluetooth or mock locations disabled the add-on will forward you to the correct place to enable these options.

1. In the GPS Option menu you need to click on “Choose Bluetooth GPS” to select the GPS device you will be using. You can also click on “Rename GPS Device” to give the GPS devices easier to remember names. Once you have selected a device click back to return to Golden Retriever.

2. Open the Golden Retriever menu and click on “Bluetooth GPS” to connect to the device. This is also the same button to use to disconnect from the device.

32

Page 33: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. Golden Retriever will alert you that it is connecting to the device and there will now be a GPS icon in the notification bar. You are good to go to collect asset data. [Note: If you are having issues connecting to your Bluetooth GPS device we have noticed that some devices such as the SXBlue seem to require they establish a GPS connection before allowing a Bluetooth connection. We suggest that when turning on the device for the first time you allow it to establish a GPS connection, then attempt to pair it via Bluetooth]

33

Page 34: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

10.Viewing Data Uploaded to the Sample Asset Collection Dictionary1. Open the web page at https://goldenretrieverapp.com/public/ to view new data being

uploaded to the Sample Asset Collection Dictionary. The page will automatically refresh when new data is uploaded and provide you the last ten records uploaded. The GPS coordinates for each record are also clickable. Clicking on them will open a new tab with a Google map to the asset.

2. The most recent photo uploaded can also be viewed. This page will also refresh automatically when a new picture has been uploaded to the Sample Asset Collection Dictionary. https://goldenretrieverapp.com/public/photo/

34

Page 35: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

11.Hosting the Data1. Golden Retriever is designed to allow two options for hosting the uploaded data. 1. We host the data on our servers and you are able to log into our admin website and

download your data at any time. We cover the server costs and bandwidth.2. The data uploads directly to your servers. You upload a small PHP script onto your

servers and Golden Retriever will send all it's data and perform all it's searches through your databases. This can be very beneficial if privacy is of utmost importance or your program requires a very large amount of data transfer.

2. There are also two ways to have your offline databases hosted.1. We upload the offline database file to our servers and whenever a device requires the

offline database it downloads the file from the server and inserts the database onto the device.

2. We create the offline database file for you and you instead copy it onto the devices. When the device refreshes it's dictionaries it will find the file and ask if you wish to use it instead of downloading the file from our servers. This can be beneficial from a privacystandpoint as well as for bandwidth consumption.

35

Page 36: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

12. Downloading the Data1. When you purchase a license key for Golden Retriever and have your data hosted with us

you will also be given log-in credentials to the administrator website. We can also create multiple credentials for your account.

2. When you log-in you will be shown a list of all the databases currently tied to your company along with basic information about the data in each.. You have the option of downloading all data, downloading all uploaded data and photos between a set time frame, as well as the option to download all new data since the last time you downloaded. Other options available for each download are:

1. Include Photos : Whether you wish to include uploaded photos in the current download.

2. Include Data : Whether you wish to include the data in the current download.3. Capitalize Data : Selecting this option will automatically capitalize all text in the

uploaded data.4. Template : If you require your data to be formatted in different ways, for different

departments, we can create custom download templates for you. You can even set how the photos will be named and whether the photos must maintain a specified resolution and/or file size. In the future, you will be able to create/modify these templates yourself.

36

Page 37: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

3. If your account has been set as an Administrator you can select “License Keys” from the Menu at the top of the screen.

In the resulting table you can view all the license keys currently purchased by your company. You can click on any of the License Keys to view the corresponding QR code, set a human readable name under“Assigned Name” as well as deactivate license keys from particular devices so you can use them key on another device.

37

Page 38: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

4. To view the data click on the name of the database, in this example “public_sample”. This will open an online spreadsheet of all the data in the database.

The right most column contains links to view any photos attached to the records.

The very bottom left of the spread sheet contains ways to manipulate the data. If the user account has been given editing permissions you will be able to:

1. Delete Records 2. Add Records3. Edit Records

In addition to the default of being able to filter the records. Also, once you have sorted and filtered the records you can click on “Export” to download your formatted data as a spreadsheet.

Clicking on the magnifying glass icon will allow you to filter the data.

38

Page 39: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

13. License Keys1. As part of the administrator website you will also be able to deactivate any of your license

keys. Once a key has been deactivated you will be able to assign it to a new device. Golden Retriever is programmed to check if its license key is valid before it allows any new data to be uploaded to your database. If you are using this feature to deactivate a disgruntled employee's device you can rest assure they will not be able to harm your data.

2. To purchase more license keys simple navigate to the "License Keys" page on the Golden Retriever Admin website. At the bottom of the page select the amount of keys you wish to add to your account and we will adjust your subscription accordingly.

All payments are handled through an integrated https://stripe.com shopping cart so we neversee your credit card information. The addition and cancellation of license keys mid-month are prorated onto your next monthly invoice. There are also discounts available based on thequantity of license keys you have active:

Individual License Plan(1 license key)

$25 / monthand $25 for each additional user

Small License Plan(5 license keys)

$95 / monthand $19 for each additional user

Medium License Plan(25 license keys)

$375 / monthand $15 for each additional user

Large License Plan(50 license keys)

$700 / monthand $14 for each additional user

39

Page 40: Golden · 2017-08-30 · If Golden Retriever is unable to get a GPS reading it will also give the user a pop-up to ask if they would like to return to the collection screen or if

14. New Add-Ons1. Our main goal is to keep the base Golden Retriever program versatile so it can be used for

collection on any type of asset. If you require industry specific features that the base app does not provide please let me know. If it is something deemed beneficial for a large customer base we will develop it for you at no cost but will market the add-on to others to recoup development costs. If it is too specific of a feature we are happy to still move forward with developing it but we would then have to negotiate a rate to help offset our development costs.

15. LanguagesCurrently Golden Retriever is available in English and Spanish. To access a different language you must change the default language on your Android device

16. Some Upcoming Updates/Features1. Search and view photos from the Golden Retriever app.2. Dictionary creation software so that clients can add and remove their own collection

dictionarys.3. Customizable loading charts to be added to the Wood Strength Calculator add-on

40