Embed Size (px)
Citation preview
Standard Products and Solutions YorSurv iOS App User Guide
Quality Assurance Record Sheet
Project Identifier Standard Products and Solutions
Item Title YorSurv iOS App User Guide
Item Reference YorSurv-001
Current Version 1 Current Revision A
Date of Issue 18/06/2015
Name Position Company Signature
Author A Donnelly App Developer Italik Date:
Checker A Kerry Assistant Product Manager YW
Date:
Approver S Wright Manager of Standard Products and Solutions
YW Date:
Date of last Issue Initial issue
Summary of Changes n/a
Location Z:\AMP6 Delivery\Standard P&D\1. Standard Products\012 YW Survey System\03-Detailed Design\10. Commissioning Plan
Item Type Product / Design Document
Development Phase Phase 3 - Detailed Design
Users All YorSurv users
Standard Products and Solut ions Standard Products and Solut ions
Contents Introduction ........................................................................................................................................ 3
Checks, Tips, and Warnings ............................................................................................................................... 3
Getting Started .................................................................................................................................... 4
Supported Devices ............................................................................................................................................. 4
Setup .................................................................................................................................................................. 4
Connecting to Wi-‐Fi ....................................................................................................................................... 4
WiFi – Livingstone House ............................................................................................................................... 5
Auto-‐Correction ............................................................................................................................................. 5
Get the App ........................................................................................................................................................ 5
YW YorSurv iPads ........................................................................................................................................... 5
All Other Devices ............................................................................................................................................ 5
Using the App ...................................................................................................................................... 7
Opening the App ................................................................................................................................................ 7
Logging In ........................................................................................................................................................... 7
Downloading Work ............................................................................................................................................ 8
Uploading Completed Work .............................................................................................................................. 8
Verifying Uploaded Surveys ............................................................................................................................... 9
Sites .................................................................................................................................................................... 9
Packages ........................................................................................................................................................... 11
Surveys ............................................................................................................................................................. 13
Survey Status ................................................................................................................................................ 13
Creating a Survey ......................................................................................................................................... 14
Types of Question ........................................................................................................................................ 14
Additional Survey Information .................................................................................................................... 16
Completing a Survey .................................................................................................................................... 16
Context Menu .................................................................................................................................................. 16
Using Other Apps .............................................................................................................................. 19
YorSurv iOS User Guide
Page 3 of 19
Introduction This guide is intended to assist you in the operation of the YorSurv iOS App, the main means of submitting survey information into the database for access from the YorSurv portal.
Checks, Tips, and Warnings Within this guide, you will find some highlighted sections of text. There are 3 different types of these, as follows.
䋱 indicates an action you can make that may help you.
䌬 indicates something that you may wish to be careful about.
䌮 indicates some useful information, but isn’t essential to know or complete.
YorSurv iOS User Guide
Page 4 of 19
Getting Started Supported Devices The following devices are supported. Please note that for a full user experience the iPhone 6+ / iPad mini / iPad should be used.
! iPad mini (minimum spec -‐ iPad Mini2 Wi-‐Fi and Cellular 16GB) ! iPad ! iPhone 6Plus / 6 / 5S / 5C / 5
iOS 8.3 must be installed as a minimum. Please update your device before downloading the app.
Organisations are to provide their own devices. Yorkshire Water has a small number of devices which it may be possible to borrow initially. These are to be signed out for use. Please contact [email protected]
Setup To get started, you will need to ensure your device has an internet connection available. This can be either through Wi-‐Fi, or through mobile data. This can be done via the iPad Settings menu.
Connecting to Wi-‐Fi
Figure 1 iPad Settings Icon
Once in the settings menu (figure 1), look down the list on the left. You should see an option for Wi-‐Fi (figure 2). It should also display the current Wi-‐Fi state. If this reads as “Connected”, then you’re already good to go and can skip to “Get the App”
Figure 2 Wi-‐Fi option
Select this option, and look down the list on the right for a Wi-‐Fi point you recognise.
Figure 3 An available Wi-‐Fi network is nearby
䌬 You must ensure that you are either the owner of the Wi-‐Fi connection, or have permission to use it before continuing.
YorSurv iOS User Guide
Page 5 of 19
Figure 4 Prompted for the Wi-‐Fi password
It is likely you will be prompted for a Wi-‐Fi password, if so, you should enter it. The Wi-‐Fi owner can provide this, or it can normally be found on the back of the wireless router if at home. Don’t worry if it connects without one; some Wi-‐Fi points are setup not to require it.
Figure 5 Connected to Wi-‐Fi network
Wi-‐Fi – Livingstone House YW-‐Partners is now available in Livingstone House. To connect, contact the YW Service Desk on 0844 5434999 and be prepared to provide your YW username.
Auto-‐Correction It is recommended that you turn off “Auto-‐Correction” to prevent your typing being changed automatically. This option can be found in:
Settings >> General >> Keyboard >> Auto Correction
Get the App The app is distributed in 2 ways depending on the device.
YW YorSurv iPads The App will be preloaded onto the device using Meraki. All updates will be downloaded automatically.
All Other Devices You will need to download it from the iTunes store by following these steps:
1. Request “Redemption Code” from Italik Helpdesk1 at 0845 226 1955/ [email protected]. This is your YorSurv Surveyor Licence. Please note that you may need to purchase additional licences2.
䋱 Talk to your supervisor or manager if you think you need an account and don’t have one.
2. Make sure your device has an Internet connection.
3. Open up the App Store on a device. Scroll to the bottom of the “Featured” page and Click on Redeem
(figure 6).
1 Italik Ltd are the YorSurv Service Providers 2 You should also request your “Surveyor Account” at this time. The helpdesk will require the following information: Name / Work email / Work mobile number / Company
YorSurv iOS User Guide
Page 6 of 19
Figure 6 Redeem options on App Store
4. Enter your code manually and click Redeem (see figure 7)
Figure 7 Enter code to redeem here
5. Log in with your AppleID if you are not already logged in3.
6. The App Store should then confirm the App you wish to download (figure
8)
Figure 8 Confirmation of the App Download
7. The app should start to download automatically and once complete will
appear on your screen as shown in Figure 9.
Figure 9 YorSurv App Icon on a device
You now have the app on your device. Ensure you have your YorSurv username and password and you are ready to go.
䋱 Talk to your supervisor or manager if you think you need an account and don’t have one.
3 If you do not have an AppleID, then go to https://appleid.apple.com/account
YorSurv iOS User Guide
Page 7 of 19
Using the App Opening the App To start the App, you simply need to find the YorSurv icon on the Home screen and press it.
Logging In After starting the app, you should see a button allowing you to Login in the top right.
Figure 10 Login Button
Click this, and you’ll be prompted to enter your username (email) and password. Please note your YorSurv password may differ from your email password.
Figure 11 Login prompt
䋱 If you’ve forgotten your password, enter your email address without the password and click “Forgot Password”. A new one will be emailed to you.
After logging in, you will be sent a dynamically generated one time 6-‐digit security code to your email and/or phone. The contact details will have been set up when your account was created.
Figure 12 Entering the security code to login
Once logged in, you can proceed. Your username or email address will appear in the top right to indicate this.
䌮 This method of two-‐factor authentication helps keep your account secure. It works on the basis of requiring something you know, and something you own. You can find out more about this online if you are interested.
䌮 Your login will expire 12 hours after the last action made. You may be prompted to login again after this. This will allow any background uploads to complete, even if left running overnight.
YorSurv iOS User Guide
Page 8 of 19
Downloading Work The first step to getting started is to download any allocated work packages. A package consists of any sites, surveys and related documents that have been assigned to you.
Figure 13 Sync icon
To begin the transfer, just tap the sync icon in the top right corner of the screen. This will take you to a transfers screen. Any active transfers, up or down, will appear here. Tap the download icon in the top right to fetch any new packages.
Figure 14 Download icon
Figure 15 Two files are just completing their download
䋱 If the download fails, you can either retry it by pressing the button, or cancel it by swiping it left off the screen. You can always start it again later by pressing the download button again.
Figure 16 A download has failed, and can be reattempted by tapping the retry button, or cancelled by swiping left to reveal the cancel
button
Uploading Completed Work When you’re ready to submit completed work, you can use the same transfer screen you used to download your packages. Tap on the Sync icon to bring it up, as before, and then tap on the upload icon in the top right.
Figure 17 Upload icon
This will start any pending uploads to the server. You can track the status of these in the transfer list on the screen, exactly the same as you can with active downloads.
YorSurv iOS User Guide
Page 9 of 19
These uploads will continue to run in the background, so you can close the app, complete other surveys, or check your other jobs while you wait. You’ll get a notification once it has completed.
Figure 18 Transfers have been completed while the user is still within the app
Figure 19 The user will be notified of completed transfers, even if they have closed the app and returned to the iPad home screen
Verify ing Uploaded Surveys Once the surveys have been uploaded you can verify that the server has received these by pressing the button below. Caution pressing this button will also remove the surveys which have been received by the server from the iPad.
Figure 20 Verify icon
If any have failed to upload you can then upload them again.
䋱 If the upload fails it is advisable to check the device’s internet connection status.
S ites Sites are locations where work is to be carried out. Each site will have a number of survey packages associated with it. To select which site you wish to view, simply tap it. The red dots on the map will show only the sites available, and can be filtered along with the list.
YorSurv iOS User Guide
Page 10 of 19
Figure 21 A collection of sites is available once a work package has been selected
䌮 You can filter the list by searching in the box below the map.
Figure 22 A Yorkshire Water van indicates your position on the map
䋱 To view a map on the iPhone you can tap the map icon on the site cell.
YorSurv iOS User Guide
Page 11 of 19
Figure 23 iPhone screen showing map icon
Figure 24 MapView is shown full screen and can be dismissed with the arrow close button tap
Packages Within a site, there are survey packages that form a job. Tapping one of these opens the survey selection for that package.
While on the packages menu, you can see an overview of what work you have and what has been completed so far.
YorSurv iOS User Guide
Page 12 of 19
Figure 25 Packages are viewable side by side, with a map showing all assigned sites
If you are traveling to a remote site, where network data may be tricky to obtain, you can use the map snapshot feature.
You can expand the map using the map icon on the collection cell.
Figure 26 Map Icon on Packages screen
Choose the map detail you wish to take a snap shot of. Hit the Photo Icon.
Figure 27 Snapshot icon
This will then save a snapshot of the map and save it for looking at in the ‘Context’ menu at any point.
YorSurv iOS User Guide
Page 13 of 19
Figure 28 Snapshotted Maps viewed in the context function
Surveys
Figure 29 Surveys available for the package and site selected
Survey Status A survey can be in one of four states of progress. This can be seen on the bottom of each survey tile, and is one of:
Pending This is a new survey, awaiting completion. In Progress This survey has been started, but not yet completed. You may resume where
you left off. Completed This survey has been completed, and is now ready to be sent to the server. Sent This survey has been completed and sent to the server. It should be safe to
delete from your device if required. Received This survey has been completed and sent to the server. It has also been verified
that it exists on the Server.
䌬 Until a survey has been received by the server the information is only available on the device.
YorSurv iOS User Guide
Page 14 of 19
Creating a Survey To create a new survey, simply navigate to the required package and site, and tap “New” in the top right corner. This brings up a menu with a number of survey types that are available for this site. Tap the ones you require, then tap “Done”.
Figure 30 Different surveys are available for creation
Types of Question Choice A choice question provides a list of possible options form which you should choose one.
Figure 31 A choice question example
Date A date question allows input of a date and time. This can be manually selected by clicking on the calendar icon, or it defaults to the current date and time.
Figure 32 A date picker lets you select a date and time easily
YorSurv iOS User Guide
Page 15 of 19
Location A location question takes a map position for an answer. By default, this is your current position, but it can be changed by pressing and holding on the map for a second. Once you’ve selected your location, just tap “Confirm Location” to use it.
Figure 33 A location question
Measurement There are two forms of measurement questions. One is a 2D measurement, the other a 3D measurement. These questions will have an input field for each dimension, and will require a numerical input.
Figure 34 A 2D Measurement question
Figure 35 A 3D Measurement question
Number Number questions require a single numerical response. There may be a unit associated with the answer.
Figure 36 A Number question representing an amount of bar
Branch A branch question gives a Yes/No choice, that can open up additional questions on the survey.
Photo Each photo question allows you to add up to 3 photos. These can either be taken from the camera immediately, or selected from the iPad’s gallery.
Figure 37 Tapping the camera icon lets you choose where to add photos from
YorSurv iOS User Guide
Page 16 of 19
Signature A signature question simply requires a signature to be added. Tapping the area will bring up a signing pad that can be signed using a finger or stylus.
Figure 38 A signature can be provided by drawing on the screen with finger or stylus
Text A text question allows simple entering of text via the iPad keyboard. You can add multiple lines if desired.
Additional Survey Information Comments Comments can be added in support of a question where the comments icon is visible. Simply tap the icon to bring up the comment entry box.
Figure 39 A comment icon indicates that comments can be added to support your answer
Help A help icon can be tapped to provide some help and guidance about the question.
Mandatory A mandatory question is marked with a red “M”. This means the question requires an answer, and the survey cannot be completed without it.
Figure 40 A Mandatory icon
Completing a Survey In order to start entering data on a survey, simply tap the required survey while on the site. If the survey is new, you’ll get a clean form, otherwise you’ll be able to continue where you left off. Once you’ve completed all the mandatory fields, you’ll be able to tap the “Finalise” button in the top corner. After finalising, the survey will be ready to upload next time you tap the upload icon on the transfers screen.
Context Menu The context menu is a special menu that can be accessed in many places within the app. An information icon can be tapped to bring it up.
Figure 41 Tapping an information icon will bring up the context menu
YorSurv iOS User Guide
Page 17 of 19
The context menu is a handy menu for finding information and documents related to a job. It can be used to provide information scuh as turn-‐by-‐turn directions from your current position, and information which has been added via the YorSurv portal such as the site address, who the contact is on site, any documents related to the job, and information on the package and scope of work.
Figure 42 The context menu provides information on the package, scope, access to related documents, site details, site contact, and
turn-‐by-‐turn directions to the site.
䋱 On contacts on an iPhone you can make a call directly from the app
Swipe left on a row in contacts and it should give you the option to email / call (if available) the contact.
Figure 43 Showing Email and Call buttons on the iPhone App
YorSurv iOS User Guide
Page 18 of 19
YorSurv iOS User Guide
Page 19 of 19
Using Other Apps The YorSurv iOS App is designed to work with other Apps that are available. The current list of Apps that are recommended at present are:
Ref App Name Use 1 Excel Microsoft. For Excel files 2 Word Microsoft. For Word documents 3 PowerPoint Microsoft. For PowerPoint presentations 4 SketchBookX SketchBook Express. Provided free from Autodesk. Provides the
ability to save sketches into the photo gallery 5 AutoCAD 360 Provided free from Autodesk. Allows AutoCAD drawings to be
viewed 6 Adobe Reader Allows PDFs to be viewed 7 8 9 10
