Installing ODK-X Basic Tools

These instructions describe the steps to install the ODK-X basic tools on a tablet.

Prerequisites

You must have an Android tablet with an operating system version 5.0 or higher.

If you are working on a Windows/Mac/Linux machine, you can use Android Studio to launch an Android emulator for testing purposes.

Note

Please note that ODK-X Services version 2.1.7 doesn't work on Android 11. You will need Android 10 with an API level of less than 30 for version 2.1.7.

Before installing any of the ODK-X tools, you will need the following third-party app:

Required

No other ODK-X Android tools are prerequisites to installing Using ODK-X Services. However, ODK-X Services is a prerequisite for all the other ODK-X Android tools.

Installing Services

  1. From your device's Settings, choose Apps & notifications. (On older versions of Android, this setting may be in Applications or Security depending upon your Android version.)

  • Go to Special app access in Advanced and choose Install unknown apps.

  • From the list of applications, select a browser of your choice and check Allow from this source.

  • (On older versions of Android, the above two steps are not required; ensure installation from Unknown Sources is checked.)

  1. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android, any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)

  2. Navigate to https://github.com/odk-x/services/releases/latest and download the latest ODK-X Services APK.

  3. In the download window, you will see ODK_Services_vN.N.N.apk. - Select it to download the file.

  • On older devices, the APK will automatically install after you approve the security settings.

  • On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.

Note

You can also download the ODK-X Services APK to your computer and load it on your device via adb or another tool like AirDroid.

Tip

You can also install ODK-X Services on an Android emulator. However, this can be slow and is only recommended for developers actively working on Services.

Installing the ODK-X Survey App

  1. From your device's Settings, choose Apps & notifications. (On older versions of Android, this setting may be in Applications or Security depending upon your Android version.)

  • Go to Special app access in Advanced and choose Install unknown apps.

  • From the list of applications, select a browser of your choice and check Allow from this source.

  • (On older versions of Android, the above two steps are not required; ensure installation from Unknown Sources is checked.)

  1. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android, any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)

  2. Navigate to https://github.com/odk-x/survey/releases/latest and download the latest ODK-X Survey APK.

  3. In the download window, you will see ODK-X_Survey.N.N.apk. - Select it to download the file.

  • On older devices, the APK will automatically install after you approve the security settings.

  • On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.

Note

You can also download the ODK-X Survey APK to your computer and load it on your device via adb or another tool like AirDroid.

Tip

You can also install ODK-X Survey on an Android emulator. However, this can be slow and is only recommended for developers actively working on Survey.

Installing the ODK-X Tables App

  1. From your device's Settings, choose Apps & notifications. (On older versions of Android, this setting may be in Applications or Security depending upon your Android version.)

  • Go to Special app access in Advanced and choose Install unknown apps.

  • From the list of applications, select a browser of your choice and check Allow from this source.

  • (On older versions of Android, the above two steps are not required; ensure installation from Unknown Sources is checked.)

  1. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android, any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)

  2. Navigate to https://github.com/odk-x/tables/releases/latest and download the latest ODK-X Tables APK.

  3. In the download window, you will see ODK_Tables.N.N.apk. - Select it to download the file.

  • On older devices, the APK will automatically install after you approve the security settings.

  • On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.

Note

You can also download the ODK-X Tables APK to your computer and load it on your device via adb or another tool like AirDroid.

Tip

You can also install ODK-X Tables on an Android emulator. However, this can be slow and is only recommended for developers actively working on Tables.