Differences

This shows you the differences between two versions of the page.

--- education_survey_tool_android_app_systems_administrator_manual [2020/07/09 06:13] – [Setting up the Tablet] ghachey
+++ education_survey_tool_android_app_systems_administrator_manual [2023/11/17 16:57] (current) – old revision restored (2023/11/17 10:17) ghachey
@@ Line 1: / Line 1: @@
-====== Education Survey Tool Android App Systems Administrator Guide ======
+====== Pacific EMIS Education Survey Tool Android App Systems Administrator Guide ======
 ===== Setting up the Tablet =====
-The tablet can be setup any number of ways to support this app. However, the recommended setup is to have an Owner account first created by the organization's systems administrator. Two different ways here are possible:
+The tablet can be setup generally in two different ways:
-  * Using a Google G Suite email account if you have the service with Google. This is a more advanced corporate setup that enable centralized control of the tablets. This is normally the preferred method but it a bit more involved and your Google G Suite subscriptions may or may not support Device Policy.
+  * Using a Google G Suite email account if you have the service with Google. This is a more advanced corporate setup that enables centralized control of the tablets. This is normally the preferred method but it a bit more involved and your Google G Suite subscriptions may or may not support Device Policy.
-  * Using a dedicated system email account. For example, you could create a Gmail account just for this called org.systems@gmail.com. This is simpler setup but the tablets are not centrally managed and secured. Each user would need normal "personal" Gmail account to keep an audit trail.
+  * Using a dedicated system email account. For example, you could create a Gmail account just for this called myorgname.staffname@gmail.com. This is simpler setup but the tablets are not centrally managed and secured. Each user would need normal "personal" Gmail account to keep an audit trail.
-Then for any school inspector that will be conducting surveys with the app you create a new user with their work or personal email (depending on your setup above).
+Then for any school inspector that will be conducting surveys with the app you create a new user with their work or personal email (depending on your setup above). A tablet can generally have more then one user but you would need to install the app for each user also. Ideally, a single work tablet is assigned to a single staff who is responsible for it.
 To start with a clean state you should do a Factory Reset of the Android tablet before you create your owner user with admin email.
@@ Line 15: / Line 15: @@
 <note warning>Before doing the factory reset ensure that there is nothing of value on the tablet such as photos.</note>
-Once your tablet is setup in a clean state with your dedicated system admin user by your systems administrator you are ready. From this account the organization's system administrator can do the upgrades manage the tablet.
+==== Setting a Tablet Name ====
-<note tip>Install any upgrade of the tablet before proceeding is a good idea.</note>
+While not required this can become useful by more clearly identifying the tablet. Especially useful when using the advanced merging offline feature of the app. It is recommended to configure the name of the tablet with the name of the inspector that will be using it. For example, if it is used by Mr. Team Leader with an email address like team.leader [at] gmail [dot] com.
-===== Installing the app for a new inspector =====
+{{ :survey-tool-sysadmin-manual:est-settings-tablet-setup-1.jpg?nolink&600 |}}
-Let's say you have a new inspector called John Doe that will be tasked with conducting surveys. Get the tablet that the new staff will be using and add his/her user account with their email. Adding a new account in Android can be done like below (or slightly differently if you have a different version of Android).
+==== Google G Suite Email Account Setup ====
-Drag down the top menu and click on the little user icon.
+If you are using Google G Suite the first thing to do is allow installation from unknown apps has a policy. You do this like follows.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_2_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-device-policy-1.png?nolink&600 |}}
-Click ''Add User'' as shown below.
+{{ :survey-tool-sysadmin-manual:education-survey-tool-device-policy-2.png?nolink&600 |}}
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_3_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-device-policy-3.png?nolink&600 |}}
-and follow the steps as you would install a normal user using the work email of the new staff.
+{{ :survey-tool-sysadmin-manual:education-survey-tool-device-policy-4.png?nolink&600 |}}
-Then you must install the app for this new user. The app will be shared with the new user by a member of the Pacific EMIS team. You can access it in your Google Drive as shown below.
+Then you create your staff user on the tablet just as you would create a normal user. But if correctly using your Google G Suite user accounts you should see the following at some point in the initial setup. This means you on a the right track. Simply follow the steps to complete the work tablet for this staff.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_4_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-device-policy.png?nolink&600 |}}
-You need to locate the most recent build-release or the one you are told to install.
+Then request a Pacific EMIS member to share the Education Survey App into your staff's Google Drive. You are ready to install the app for that user.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_5_.png?nolink&400 |}}
+==== Google Normal Email Account ====
+If you are using a standard Google account the setup will be as usual with an Android device. Simply create a user for your new staff and install that app.
+<note tip>Install any upgrade of the tablet before proceeding is a good idea.</note>
+===== Installing the app for a new inspector =====
+Let's say you have a new inspector called John Doe that will be tasked with conducting surveys. You have already created the user on the tablet as per the previous section. The app will be shared with the new user by a member of the Pacific EMIS team. You can access it in your Google Drive as shown below.
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_4_.png?nolink&600 |}}
+You need to locate the most recent release or the one you are told to install. Typically, it will be the one as shown below and not in the release archive folders.
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install-5.jpg?nolink&600 |}}
 Click on the apk file to install it.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_6_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_6_.png?nolink&600 |}}
 You will be prompt to accept installation from unknown sources.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_8_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_8_.png?nolink&600 |}}
 You enable install from unknown source setting.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_16_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_16_.png?nolink&600 |}}
 Then you can proceed with the app installation as shown in following three photos.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_9_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_9_.png?nolink&600 |}}
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_10_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_10_.png?nolink&600 |}}
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_11_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_11_.png?nolink&600 |}}
 Start the Pacific EMIS Education Survey Tool app and give it all permissions requested.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_12_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_12_.png?nolink&600 |}}
 Select the context (name of your EMIS) and proceed.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_13_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_13_.png?nolink&600 |}}
 Click on the link to login with Google account. This will link the new staff email with all the work done in the app and provide an audit trail of all data collected.
-{{ :survey-tool-sysadmin-manual:education-survey-tool-install_14_.png?nolink&400 |}}
+{{ :survey-tool-sysadmin-manual:education-survey-tool-install_14_.png?nolink&600 |}}
 The installation and basic setup is complete
+===== Verifying Software Version and License =====
+From the home page click on ''Software License'' and you should get the page below.
+{{ :survey-tool-sysadmin-manual:est-software-1.jpg?nolink&600 |}}
@@ Line 83: / Line 105: @@
   - Centralized configuration online using Firebase.
-==== Local Setting, going into Production ====
+==== Local Settings ====
-Local setting configure a single tablet and app, the one you click on the setting. You use this to make an individual app do into Production. This means all the surveys conducted on the tablet once put into Production will be made available into the Production EMIS of your country.
+Local settings configure a single tablet and app, the one you are in. You go into settings from the home page by clicking on ''Settings''.
-You do it like this.
+{{ :survey-tool-sysadmin-manual:est-settings-1.jpg?nolink&600 |}}
+You will be prompt for the master password then ''Confirm''.
-==== Android Centralized Configuration ====
+{{ :survey-tool-sysadmin-manual:est-settings-2.jpg?nolink&600 |}}
-All other configuration you are better off centrally managing and all your tablets will sync and get the latest configuration. For example, if you want to change the contact person you change it centrally and it gets synced to all tablets. This is done using Firebase, a Google service. Anyone that was given the permission can access it at [[https://console.firebase.google.com/u/2/|https://console.firebase.google.com/u/2/]]
+There are many settings most of which will have been set automatically through the remote centralized settings. However, you typically use the local settings to change a tablet's ''Operating mode'': to make an individual app go into Production.
+{{ :survey-tool-sysadmin-manual:est-settings-3.jpg?nolink&600 |}}
+With this setting you can flip from Development (testing/training/etc.) to Production (real use on-the-ground).
+{{ :survey-tool-sysadmin-manual:est-settings-4.jpg?nolink&600 |}}
+This means all the surveys created on the tablet after you put it into Production will be made available into the Production EMIS of your country. When the tablet is in Development mode all the created surveys will be available in the Pacific EMIS on the software developers workstations for testing (which you may be given access also if needed.
+<note warning>Only do this when you are certain the tablet will be used to enter valid data to be loaded into the production system.</note>
+Other important features you can find in the settings are the Update data shown below. You only need to do this on the tablet at the installation once. It downloads from the Pacific EMIS database the list of schools, teachers and subjects for use in dropdowns fields in surveys to improve data quality. You can also click on those if you know you data has changed (e.g. new teachers).
+{{ :survey-tool-sysadmin-manual:est-settings-5.jpg?nolink&600 |}}
+Other settings are described below. They are typically set centrally and remotely but it can be overridden locally on individual tablets:
+  * **Logotype**: is the logo on the home page of the app.
+  * **Change master password**: password used for operations not normally done by normal users.
+  * **Name**: title on the home page
+  * **Contact**: email of the data manager
+  * **Operating mode**: important and most commonly configured locally on tablets (see above)
+  * **Import schools from CSV**: a legacy settings to load schools into the tablet (superseded by the Update schools from EMIS API below)
+  * **Update schools from EMIS API**: loads all the schools into the tablet with a programmatic call to the EMIS backend
+  * **Update teachers from EMIS API**: loads all the teachers into the tablet with a programmatic call to the EMIS backend
+  * **Update subjects from EMIS API**: loads all the subjects into the tablet with a programmatic call to the EMIS backend
+  * **Templates of surveys**: view the structure of the currently loaded surveys
+  * **Load Production Certificate**: a cryptographic key used to securely communicate with the Pacific EMIS cloud account for syncing data. Should not be change for proper operation of the system.
+  * **Tablet ID**: a unique identifier of the tablet the app is running on. A read only setting.
+  * **DEBUG: show storage**: view the cloud account files useful mostly for administrators and developers.
+==== Centralized Configuration ====
+Most settings are better configured centrally has it will be much easier: all your tablets will sync and get the latest configuration. For example, if you want to change the contact person you change it centrally and it gets synced to all tablets. This is done using Firebase, a Google service. Anyone that was given the permission can access it at [[https://console.firebase.google.com/u/2/|https://console.firebase.google.com/u/2/]]
 For a very brief overview of how to manage the configuration in Firebase refer to [[firebase_configuration|Firebase Configuration]]
 <note tip>You rarely need to change those.</note>
+Details of the configuration can be found at [[Pacific EMIS Education Survey Tool Android App Configuration]]
 ===== Troubleshooting =====
+==== Verifying Version Installed ====
+When seeing errors it is important to know how to get the version of the app that is installed. This is how you do it.
+{{ :survey-tool-sysadmin-manual:verify-version-1.png?nolink&600 |}}
+{{ :survey-tool-sysadmin-manual:verify-version-2.png?nolink&600 |}}
 ==== Re-installing app may trigger error ====
@@ Line 106: / Line 176: @@
 First go into the Google Playstore and click on the menu as shown below.
-{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-1.jpg?nolink&400 |}}
+{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-1.jpg?nolink&600 |}}
 Then click on play protect as shown below.
-{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-2.jpg?nolink&400 |}}
+{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-2.jpg?nolink&600 |}}
 Then click on the settings button top right as shown below.
-{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-3.jpg?nolink&400 |}}
+{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-3.jpg?nolink&600 |}}
 Then turn off the scan as shown below.
-{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-4.jpg?nolink&400 |}}
+{{ ::survey-tool-sysadmin-manual:emis-education-survey-tool-playstore-4.jpg?nolink&600 |}}
-===== Cloud Integration with Google Drive (Obsolete?!) =====
-<note warning>Is this obsolete since switch to google service account?</note>
-Currently the documentation for this is minimal and can be found at
-  * https://docs.google.com/document/d/1yF5LuWecwi_eqRsLUy9iKo5l098zri9kg0dwBJ2gReY/edit