Skip to content

7. Components

Jump to bottom
Máximo Ramírez edited this page Nov 10, 2017 · 7 revisions

Settings

Change Settings

Access the Change Settings view either by:

  1. Clicking on the three vertical dots icon: Menu Icon.
  2. If your device has a wide screen, then you may see a wrench icon like this: Change Settings Icon. Click on it to access this view.

Unlike Admin Settings, Change Settings are settings available to the enumerator and cannot be password protected.

Refer to ODK Survey documentation for going further with the ODK Survey provided menu items. The menu items which are added for Episample are under Interviewer/Device Info.

Components: Change Settings
  • [CS01] EpiSample: Link to the EpiSample GitHub repository.
  • [CS02] Server Platform (by default - ODK Aggregate):
    • ODK Aggregate: Aggregate service for receiving the data.
    • Other: UNKNOWN.
  • [CS03] URL: URL where the Aggregate service is exposed.
  • [CS04] Username: Credentials used by this client to communicate with the Aggregate service.
  • [CS05] Password: Credentials used by this client to communicate with the Aggregate service.
  • [CS06] Google Account: If the Aggregate service authentication is configured by using a Google account, you may select any Googla account setup on the mobile device.
  • [CS07] Form List Path (by default - /formList): API endpoint used for retrieving the list of forms currently loaded in the Aggregate service.
  • [CS08] Submission Path (by default - /submission): API endpoint used for posting form records in the Aggregate service.
  • [CS09] Text Font Size (by default - medium): Size of text contained inside ODK forms.
  • [CS10] Show Splash Screen (by default - disabled): This is not working as expected UNKNOWN.
  • [CS11] Selected Splash Image: This is not working as expected UNKNOWN.
  • [CS12] Interviewer Name: Records the name of the enumerator using the current device.
  • [CS13] Phone Number: Records the phone number of the enumerator using the current device.
  • [CS14] Device Name: Records the name used to externally identify the current device. Usually, in larger deployments, organizations write a number or name directly onto the device, or on the other hand, label it with an asset tag. This is not the name of the device in the Wi-Fi Direct settings. However, it is a good practice to use the same identification in both cases.

Admin settings

Access the Admin Settings view either by:

  1. Clicking on the three vertical dots icon: Menu Icon.
  2. If your device has Menu hardware button, click on this button to access this view.

Admin Settings can be password protected with an admin password so that admin related changes are not made to the app while it is deployed in the field.

Components: Admin Settings
  • [AS01] Change Settings: By tapping on this option you will be redirected to the Change Settings view.
  • [AS02] Admin Password (by default - not protected): By tapping on this option you may establish a password for protecting the Admin Settings view. Therefore, just those users who know this password will be able to access and change the settings contained inside this view.
  • [AS03] Place Name List: Tap here to manage the place name list (i.e. geographical hierarchy, config.csv file).
    • Load: Parses the config.csv file which contains the geographical hierarchy and loads this information to the EpiSample instance.
    • Purge: Removes the loaded place name list from the EpiSample instance. However, the config.csv file remains in the device so it may be loaded again.
  • [AS04] Load Points: PENDING...
  • [AS05] Clear All Data: This is not working as expected Clears all the data from the EpiSample instance including the place name list and already collected points.
  • [AS06] Collect (by default - enabled): Allows users to access and use the Collect module in this EpiSample instance.
  • [AS07] Send/Receive - Wifi Direct (by default - enabled): Allows users to access and use the Send/Receive module in this EpiSample instance.
  • [AS08] Send/Receive - Bluetooth (by default - enabled): This is not working as expected UNKNOWN.
  • [AS09] Select (by default - enabled): Allows users to access and use the Select module in this EpiSample instance.
  • [AS10] Navigate (by default - enabled): Allows users to access and use the Navigate module in this EpiSample instance.
  • [AS11] Backup Census (by default - enabled): Allows users to use the backup census feature in this EpiSample instance.
  • [AS12] Restore Census (by default - enabled): Allows users to use the restore census feature in this EpiSample instance.
  • [AS13] Edit Census (by default - disabled): Allows users to use the edit census points feature in this EpiSample instance.
  • [AS14] Remove Census (by default - disabled): Allows users to use the remove census points feature in this EpiSample instance.
  • [AS15] Invalidate Census (by default - disabled): Allows users to use the invalidate close (or duplicated) census points feature in this EpiSample instance.
  • [AS16] Edit Saved Form (by default - enabled): This is not working as expected UNKNOWN.
  • [AS17] Get Blank Form (by default - enabled): This is not working as expected Allows users to download forms from the linked ODK Aggregate service, in this EpiSample instance. This feature results in an error: No manifest or empty manifest.
  • [AS18] Delete Saved Form (by default - enabled): Allows users to use the delete saved forms feature in this EpiSample instance.
  • [AS19] Server Protocol and URL (by default - enabled): Allows users to change the URL setting in this EpiSample instance.
  • [AS20] Username (by default - enabled): Allows users to change the Username setting in this EpiSample instance.
  • [AS21] Password (by default - enabled): Allows users to change the Password setting in this EpiSample instance.
  • [AS22] Google Account (by default - enabled): Allows users to change the Google Account setting in this EpiSample instance.
  • [AS23] Text Font Size (by default - enabled): Allows users to change the Text Font Size setting in this EpiSample instance.
  • [AS24] Show Splash Screen (by default - enabled): Allows users to change the Show Splash Screen setting in this EpiSample instance.
  • [AS25] Selected Splash Screen (by default - enabled): Allows users to change the Selected Splash Screen setting in this EpiSample instance.
  • [AS26] Interviewer Name (by default - enabled): Allows users to change the Interviewer Name setting in this EpiSample instance.
  • [AS27] Phone Number (by default - enabled): Allows users to change the Phone Number setting in this EpiSample instance.
  • [AS28] Device Name (by default - enabled): Allows users to change the Device Name setting in this EpiSample instance.
  • [AS29] Change Seetings (by default - enabled): Allows users to access the Change Settings view in this EpiSample instance.
  • [AS30] Change Language (by default - enabled): This is not working as expected UNKNOWN.
  • [AS31] Go To Prompt (by default - enabled): This is not working as expected UNKNOWN.
  • [AS32] Ask to clean data from previous date (by default - disabled): This is not working as expected UNKNOWN.
  • [AS33] GPS Accuracy Thresholds (by default - 10): Sets what is considered a valid GPS point in terms of the reported accuracy. Accuracy is reported in meters. Setting this too low may cause frustration while enumerators wait for the GPS to become accurate by incorporating additional satellites, and setting this too high may result in GPS coordinates that are not accurate enough for your data collection purpose. It should also be noted that reported GPS accuracy can vary significantly from actual GPS accuracy, depending on the device.
  • [AS34] Require Comment (by default - disabled): Makes mandatory the field Comment in the Collect view for this EpiSample instance.
  • [AS35] Auto Increment House Number (by default - enabled): Auto increments the house number value automatically after tapping on the Save button in the Collect view.
  • [AS36] Allow to Edit Saved Data (by default - disabled): Allows enumerators to edit saved points data directly from the Collect module. If this option is not enabled, once the Save button is tapped, the point will not be editable. Note that if you choose to allow to edit saved data, GPS coordinates will be overwritten with the location of the device during editing.
  • [AS37] Device has low quality GPS (by default - disabled): Allows to configure a delay while capturing coordinates to increase GPS accuracy in the current device.
  • [AS38] Delay (by default - 30 seconds): Indicates the delay that users need to wait before capturing a point for increasing GPS accuracy in the current device.
  • [AS39] Device belongs to team lead (by default - disabled): Identifies the device as a team leader (supervisor) device. This setting only affects the Send/Receive module. As a team leader, you can choose which device to connect to. If the device is not a team leader device, all you can do is advertise that the device is available to connect so that the burden of choosing who to connect with is with the team leader and not with the enumerators.
  • [AS40] Turn on and of WiFi automatically (by default - enabled): Enables the current device with the ability to turn WiFi on when it requires and turn WiFi off when it finishes to use it.
  • [AS41] Set Fixed Number of Main Points (by default - 0): Locks-down the number of main points so that users cannot change the sample size in the Select view at time of selection. Enter 0 if you do not want to lock-down the number of main points and instead, allow the user to choose the number of main points at any time directly in the Select module.
  • [AS42] Set Fixed Number of Additional Points (by default - 0): Locks-down the number of additional points so that users cannot change the sample size in the Select view at time of selection. Enter 0 if you do not want to lock-down the number of additional points and instead, allow the user to choose the number of additional points at any time directly in the Select module.
  • [AS43] Set Fixed Number of Alternate Points (by default - 0): Locks-down the number of alternate points so that users cannot change the sample size in the Select view at time of selection. Enter 0 if you do not want to lock-down the number of alternate points and instead, allow the user to choose the number of alternate points at any time directly in the Select module.
  • [AS44] Choose Form: Indicates the questionnaire used in the Navigate module. The questionnaires can be loaded via the regular process used by ODK Survey to load questionnaires.
  • [AS45] Show filter by place name icon (by default - disabled): Filter by Place Allows users to filter points (in the Navigate view) by the lowest nested level specified in the geographical hierarchy inside the config.csv file.
  • [AS46] Show mark as finalized by friends menu (by default - enabled): Allows users to mark a point as a finalized by a colleague if the house was already visited by other person.

Main Modules

Collect

Access the Collect module by clicking on Filter by Place from the Home screen.

The Collect view is optimized to rapidly collect census data in the field. You can assign a customized geographic name (such as an enumeration area) based on a cascading set of geographic names, associate that place name with a GPS coordinate, a head of household name and a comment. These are the basic data needed in order to sample the population and then navigate back to households to conduct surveys.

Components: Collect
  • [CL01] Place Name: Allows enumerators to easily select a specific geographic region from a list of hundreds or even thousands of place names by traversing through a hierarchical list that starts from the highest geographical level (for example, Province) to the lowest level (for example, "EA" or Enumeration Area).
  • [CL02] House Number: Allows enumerators to assign an arbitrary house number that is associated with the current GPS coordinate. You can enter a number between 1 and 99999.
  • [CL03] +1 Button: If the Auto Increment House Number parameter is checked under the Admin Settings view, tapping the +1 button will automatically insert a number that is incremented by one based on the last entry. Tapping +1 at anytime generates a new entry.
  • [CL04] Head Name: Allows enumerators to assign the name of the head of the household. In countries where this application is intended to be used, it is common for cultures to have a "head of household". This field is required or else the point cannot be saved.
  • [CL05] Comment: Allows enumerators to assign a comment to either describe the point being gathered to aid in navigation, or for any other use that would help surveyors to identify the point. This field can be configured in the Admin Settings view to either be required or optional. The Comment field has a limit of 250 characters and once this field reaches 12 lines it will automatically scroll so that the screen does not become unusable. Be thoughtful about using the Comment field for anything other than non-essential description of the point. If you plan to put structured data in this field (such as a code, address, date, name, etc.) be aware that you may be frustrated with the result since the field is an open text field without any restriction. Episample is designed to capture all of the minimum required fields for a basic census. So please make sure you aware of what Episample captures before instructing enumerators to complete this field with critical structured data.
  • [CL06] Backward & Forward Buttons: Allows enumerators to move among already collected points. This component displays a number (not the house number) that represents the point, assigned and ordered by a relative creation date/time, out of the total number of points collected Filter by Place. This display changes color based on the category the point was assigned to:
    • Valid (V): Green color.
    • Invalid (I): Red color.
    • Excluded (E): Gray color.
  • [CL07] Exclude Box: Allows enumerators to exclude points from the sampling frame. This is useful for PoIs (Points of Interest) that may help navigation. Examples include a nearby school, post office, health post, bridge or any other visually identifiable structure. An empty box represents that it is included in the sampling frame, and a filled box represents that it is excluded from the sampling frame.
  • [CL08] Save Button: Allows enumerators to save new points or edit already registered points if the Allow to Edit Saved Data parameter is enabled in the Admin Settings view.
  • [CL09] Counters (Valid, Invalid and Excluded): Display the number of valid, invalid and excluded points collected and/or imported.
Clone this wiki locally