18
1 | Page Surveybe Freedom Android™/Kindle Fire OS Installation Manual August 2018 Strictly for distribution solely within EDI, Surveybe and their clients under the conditions agreed. Surveybe reserves the copyright on all software manuals and training materials.© ECONOMIC DEVELOPMENT INITIATIVES (EDI) LTD Prospect House, T: + 44 (0) 1494 435 112 38, Crendon St., E: [email protected] High Wycombe, W: www.surveybe.com Buckinghamshire HP13 6LA UK

Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

  • Upload
    others

  • View
    10

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

1 | P a g e

Surveybe Freedom Android™/Kindle Fire OS

Installation Manual

August 2018

Strictly for distribution solely within EDI, Surveybe and their clients under the conditions

agreed. Surveybe reserves the copyright on all software manuals and training

materials.©

ECONOMIC DEVELOPMENT INITIATIVES (EDI) LTD

Prospect House, T: + 44 (0) 1494 435 112

38, Crendon St., E: [email protected] High Wycombe, W: www.surveybe.com Buckinghamshire HP13 6LA UK

Page 2: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

2 | P a g e

CONTENTS

1. Introduction ................................................................................................ 3

2. Operating System Requirements ................................................................. 3

3. Hardware Requirements............................................................................. 4

4. Installing Surveybe For Android ................................................................... 5

5. Downloading From The Google Play Store .................................................. 5

6. Sideloading Surveybe For Android ............................................................... 7

6.1 Introduction To Sideloading ....................................................................................... 7

6.2 Downloading The Installer For Sideloading From Surveybe.com ................................ 8

6.3 Setting Up The Android Device For Sideloading ....................................................... 10

6.4 Copying To The Android Device ............................................................................... 12

6.5 Installing On The Android Device .............................................................................. 14

7. File Locations For Android ......................................................................... 15

8. Uninstalling Surveybe For Android ............................................................ 16

Page 3: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

3 | P a g e

1. INTRODUCTION

This document provides step by step instructions on how you can install the Surveybe Implementer

software on Android and Kindle fire devices. It covers the following key sections:

What are the hardware and operating system requirements

How to download and run the Surveybe Implementer installer

How to un-install Surveybe

Wherever Android in mentioned in the text it should be taken to refer to both Android and Kindle Fire

OS devices unless otherwise stated.

If you don’t understand any part of the document or you have any questions please contact

[email protected].

Questionnaires built in the Surveybe Freedom Designer will run in both Windows and Surveybe for

Android/Kindle Fire OS. Refer to the Surveybe for Windows installation guide to find out how to install

the Surveybe Designer.

If you’ve installed the Surveybe Implementer on Windows you’ll notice that Android doesn’t use a

separate Java installation. This simplifies the installation process and eliminates Java version issues.

Please note that this document doesn’t discuss the initial setup of the Android device or the Google (or

Amazon) accounts you’ll need to set up the devices. Instructions for this should be available from your

device supplier.

2. OPERATING SYSTEM REQUIREMENTS

The Surveybe for Android Implementer will run on:

Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes

Lollipop (v5), Marshmallow (v6) and Nougat (v7)

Amazon Fire tablets that have the Fire OS 4.4 and later

Note that, Android devices without a built in GPS will only accept manual entry of GPS coordinates. At

the time of writing, the available devices running Kindle Fire OS rely on Wifi for location services.

It may be possible to purchase Android devices with earlier OS versions and to upgrade to the minimum

supported or a later version. Make sure you consult a reliable source before trying this, and don’t

purchase hardware until you are confident this process is viable.

If you use upgradable hardware we’d advise you to make sure the OS version is upgraded in the devices

before you distribute them, especially if your project will be operating where internet access is limited

or unreliable.

Page 4: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

4 | P a g e

If you only know your Android version by name, this Wikipedia page has details of all the Android versions released.

3. HARDWARE REQUIREMENTS

The Surveybe for Android Implementer will run on any device running a suitable Android operating system.

As with all computer applications you’ll find that the capabilities of the hardware will have an impact on how quickly Surveybe for Android will run.

The following specification is recommended for questionnaires of typical to large size and complexity. If you’re using simpler questionnaires, with one or two layers of rosters and answer numbers in the hundreds you’ll find your questionnaires will run acceptably on hardware meeting the minimum specification.

If you are thinking of running the Implementer on a smartphone or a device with a screen smaller than our recommendation you will need to consider your questionnaire design particularly carefully.

We would generally advise purchasing the best hardware your project can afford to maximise it’s performance and reusability.

Recommended Minimum

RAM 2GB 1-1.5 GB1 Processor Speed 1.8 GHz 1.3 GHz2 On-board Memory3 16GB 8GB Memory Card As required4 8GB Screen Size 8” or 10” 7”

1 Performance of large and complex questionnaires may be poor or unacceptable

2 1.3 GHz Devices with burst speeds of 1.8 GHz are available and can provide acceptable performance

3 The application needs around 30 – 50MB. Typically on an 8 GB device, 4GB of free space will be

available for storage of applications etc.

4 The card can hold questionnaires, interview files and associated files. Images and multimedia files may

have a significant impact on the storage required and changing cards can be fiddly – bigger is better!

Other Hardware Considerations:

Is the Battery life adequate, especially if GPS and/or networking will be activated?

Do you need extra data storage to accommodate images or other files?

Will the screen size be adequate for your questionnaire design?

Are the included components satisfactory – for example, is the camera suitable for your needs?

Is the device generally robust, with satisfactory build quality?

Are accessories like covers, screen protectors and so on available at acceptable cost?

Page 5: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

5 | P a g e

Is the touchscreen responsive?

Does it connect well with Bluetooth and/or Wi-Fi?

How easy is it to make physical connections – for example, adding memory cards or via USB?

Can the device accommodate the latest (i.e. largest) memory cards?

4. INSTALLING SURVEYBE FOR ANDROID

You can install the Surveybe for Android Implementer in one of two ways:

From the Google Play™ store

By ‘sideloading’

You will have to use the sideloading approach if you are using a Kindle Fire, as these devices use the

Amazon Appstore1.

Sideloading means copying the installers directly to the device (typically using a PC and cable, memory

stick and adaptor or SD card). At first using the Play Store seems the best option, but sideloading has

advantages:

You only need to download versions of the installer (and anything else you want to distribute)

from the Internet once.

You don’t need Internet access to install on new or replacement devices in the field.

You can download the Surveybe For Android installer from the Surveybe website and distribute it by e-

mail, a file sharing service or on flash memory.

If for any reason you need to install an earlier version of the Surveybe for Android Implementer than

that available on the website and you don’t have the necessary installers, please contact

[email protected].

Please note that when you upgrade the surveybe software in future, you will not be required to uninstall

the application or do anything with licencing. You will only need to run the installer for the newer

version.

You do not need a licence key to run Surveybe for Android Implementer. Although you must agree to

the licence terms and conditions when installing, the application can be installed on as many compatible

hardware units as you like.

5. DOWNLOADING FROM THE GOOGLE PLAY STORE

Your device will need to be connected to the Internet to install from the Google Play Store. You can

download from the Google Play Store on the Internet using the device’s browser or use the Google Play

Store app. Surveybe is not currently available in the Amazon store – you’ll need to use sideloading to

install on Kindle Fire devices.

1 Workarounds are available on the Internet that allow the Play Store to be used on Kindle devices. We cannot

recommend using this approach.

Page 6: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

6 | P a g e

The instructions below depict downloading using the Google Play Store app.

The Play Store will carry only the latest available version. Before downloading, make sure you know

which version of the Implementer you require. To find out which version you need, check with your

organisation’s Surveybe administrator. The Surveybe administrator is usually the Surveybe Designer

licence holder.

1) Open the Google Play app or website

2) Search for Surveybe CAPI software, you should find this tile appears:

3) Locate and tap the Surveybe for CAPI software tile. This screen will appear:

Page 7: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

7 | P a g e

4) If you need to check the version number, scroll down the screen and click Permission Details.

The version number is displayed next to the Surveybe logo, under the App name:

5) If it’s the wrong version number you’ll need to obtain the correct version from

[email protected] and sideload it. Otherwise:

6) Click INSTALL, and then give the app the permissions it needs to operate.

The application will be downloaded and installed automatically.

6. SIDELOADING SURVEYBE FOR ANDROID

6.1 INTRODUCTION TO SIDELOADING

As we’ve mentioned already, sideloading is simply the process of installing software on a device without

using the proprietary store (Google Play).

In order to install you need to:

Obtain the appropriate Implementer installer

Set up the device to accept sideloading

Transfer the Implementer Installer onto the target device,

Run the installer to set up the implementer and create a shortcut.

In principle it should be possible to download the installer directly to the device. These instructions

assume you’ll use a PC to obtain the installer.

Page 8: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

8 | P a g e

6.2 DOWNLOADING THE INSTALLER FOR SIDELOADING FROM SURVEYBE.COM

First you’ll need to download the required Surveybe for Android Implementer installer from the

Surveybe website.

The website will carry only the latest available version. This may not be the appropriate version for

you to download – your project may be using an earlier version. To find out which version you need,

check with your organisation’s Surveybe administrator. The [email protected] team can supply

older version if required and advise you on the differences between versions under the terms of your

support contract.

1) Navigate to the surveybe Client Login page on the Surveybe website:

http://surveybe.com/login/

2) Enter the Username and password to access the client area of the website.

Note: If you have not yet been in contact with us or requested an evaluation copy of Surveybe, please go

to http://surveybe.com/try-for-free/ to register with us. You’ll then be able to download the latest

installers.

If you’ve forgotten your password but remember your email address, you can regain access to your

account by resetting your password.

3) Upon clicking ‘Login’, you will be taken to the main client resource page. Click on ‘Surveybe

Installers’.

Page 9: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

9 | P a g e

4) Click on the Implementer icon to start the download the zipped folder which contains the

Surveybe For Android Implementer installer file. You will need to extract the installer file from

the zipped folder before transferring it to your Android device(s).

Windows (from XP onwards) comes with a built-in extraction tool which can be used to unzip the

folder. To extract the installer file, simply right-click on the zip folder and select ‘Extract All’. A

dialogue box will then display on your screen; you will be required to choose where you want to

save the extracted file. You can keep the default extraction location or choose a new location. Click

‘Extract’ on the dialogue box. You will find the extracted installer file in the destination folder.

Page 10: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

10 | P a g e

6.3 SETTING UP THE ANDROID DEVICE FOR SIDELOADING

Android devices are usually set up to only allow installation from the Play store. It’s straightforward to

change this to allow sideloading.

1) Find the Security option in the device settings menu. The exact location may vary from device to

device. On our Lenovo device it’s here:

2) Enable the “installation from unknown sources” option in the device.

On our Samsung device, you do this by checking the indicated checkbox as shown below:

Page 11: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

11 | P a g e

On our Lenovo device there’s a switch, like this:

Now permissions are set up on the device, you may find it useful to install a 3rd party file manager on

your device.

This will make it easier to:

Transfer files2 to, from or around the device, especially if you are copying to the device from

flash memory.

Locate and run the installer

We have used an app called ES File Explorer for the images in this document, which is available in the

Play Store and Amazon Appstore. A variety of similar apps are available.

You can, of course, simply use any file handling tools supplied with your device.

2 You may need to move questionnaires, interviews and other files as well.

Page 12: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

12 | P a g e

1) Open the Play Store on your device, search for and download “ES File Explorer”. This image

shows the Play Store after the App has been downloaded:

6.4 COPYING TO THE ANDROID DEVICE

You now need to copy the App Installation (.apk) file onto the Android device.

You can do this by:

Connecting the device to a computer using a USB cable and copy it using Windows.

Copy from a computer using Bluetooth (you’ll need to pair the devices first)

Using a USB stick (with an adaptor if required)

Using a SD card or similar

Sending it as an e-mail attachment3

In this case, we are going to connect the device to a PC using a USB cable, as this will usually be the most

convenient method when installing on a set of devices.

1) Connect your device to your PC using a suitable USB cable. In most cases the charging cable

provided will suffice.

The first time you connect the PC will install the device driver and a dialogue similar to this will appear:

3 The installer is around 5MB in size, you will need an e-mail client installed on your device.

Page 13: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

13 | P a g e

2) To prevent this dialogue appearing every time you connect a device:

Tick Always do this for this device

Click Open device to view files

This will open a Windows Explorer dialogue, thus:

3) Double click on the icon to drill down into the default directory. Note the directory may be

named differently on different devices.

4) Using a second Windows Explorer window, locate the installer you downloaded from the

Surveybe website or received from another source (see section 6.2, above).

5) Copy and paste or drag and drop the installer onto the Android device – you can use any folder

you like, in the fixed memory of the device (as in our example) or onto a memory card (if

present).

Page 14: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

14 | P a g e

The current version of the installer, pasted into the default directory on our Lenovo device.

6.5 INSTALLING ON THE ANDROID DEVICE

You now need to run the installer the App Installation (.apk) file onto the Android device (in these

images our Samsung device).

1) Locate the copied Installation(.apk) file using ES File Explorer (or your preferred tool), which will

look like this:

Page 15: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

15 | P a g e

2) Click on the .apk file which will show the next screen. Yours will be named differently from the

one in the image above. It will be named in the format Surveybe-Implementer-App-n.n.n-

release.apk , where n.n.n is the release number. For example: Surveybe-Implementer-App-

5.5.14-release.apk. Click Install on the dialog to initiate the installation process:

When the installation is complete you can now open and use your Surveybe for Android Implementer by

clicking on the Implementer icon on your device. The icon will look something like this, the background

colour depends on your device:

7. FILE LOCATIONS FOR ANDROID

The Surveybe for Android application will use a number of different directories on your device. Two of

these in particular need to be accessed by Implementer users:

Interview Files - These will be saved in and opened from a sub-folder of the surveybe_interview_files

folder, which can be found in the root directory of the external memory. The sub-folder name will be

data folder specified in the Questionnaire.

Page 16: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

16 | P a g e

Database Files - These will be held in a sub-folder of the surveybe folder, which can be found in the root

directory on the installed SD card. Users should not move, change or delete this folder or any of the files

or sub-folders within it.

Image Files - These are files containing images that will be displayed as part of the questionnaire. If

Questionnaires contain display images (or other multimedia files) these will need to be copied to the

Android device. The need to be placed in the root directory of the internal storage.

8. UNINSTALLING SURVEYBE FOR ANDROID

1) Click on the Application Manager in your device’s Settings menu. On our Lenovo device it’s

called Apps:

2) Tap on the Surveybe Implementer application you wish to uninstall.

Page 17: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

17 | P a g e

3) Tap on uninstall.

Note: Uninstalling Surveybe For Android is not required before installing a new version, and will not

normally resolve licencing or other software issues

This process will remove the application, but not the underlying database, any interview, image or

other files you have on the device. This means you can simply re-install the Implementer if you need to.

It is possible to remove all the data files and folders created by Surveybe, although we do not

recommend deleting any files or folders without specific advice from [email protected] or your

client services representative.

Page 18: Surveybe Freedom Android /Kindle Fire OS Installation Manual · Android tablets that have KitKat which is API level 19 and later (version 4.4) – this includes Lollipop (v5), Marshmallow

18 | P a g e

Copyright

This document and all of its contents are protected by copyright. This document has been provided to the user and is not for distribution, reproduction or any other unspecified use without the express permission of EDI Limited. Where amendments are required to correct errors in any of the included text, these should be

highlighted to EDI via email to [email protected].

Trademark

The Surveybe name and logo are trademarks of Economic Development Initiatives (EDI) Ltd, Prospect

House, 38 Crendon St, High Wycombe, Buckinghamshire, HP13 6LA, UK. The Surveybe name and logo

may only be used with the express written permission from Economic Development Initiatives (EDI) Ltd.

Disclaimer

This installation manual is intended to facilitate and guide the easy installation of Surveybe software

onto the user’s hardware. EDI will not accept liability for any issues arising with the user’s hardware,

including its operation or contained files, data, software or other programs. The user accepts full

responsibility for any potential unforeseen consequences of installing the Surveybe software.

EDI may make amendments and revisions to this document without prior notice. Consequently, the information contained within this document should be regarded as guidance only and no guarantee is made as to the factual accuracy or representation of the information thereof.