Install the Sample Application

Prerequisites

Install ODK-X Tables and its prerequisites from the guide Installing ODK-X Basic Tools.

Unlike ODK Collect, the ODK-X tools are application-focused. An application is identified by the name of the directory under the /sdcard/opendatakit/ folder. The sample application is named default, as is the sample applications provided for ODK-X Survey. This means that you can only deploy one of these sample applications at a time onto a device. We also provide instructions to rename one of these so that two or more applications can co-exist and not interfere with each other on this same device.

We will use the ODK-X synchronization mechanism to install this app. It is about 26 MB in size and takes a few minutes to download from the web.

  1. Launch ODK-X Tables. Press the Action Button (⋮) and press Preferences from the menu.

Tables Setting Button

  1. Follow the Server Configuration instructions to set up your server.

  • Set your Server URL to https://tables-demo.odk-x.org/.

    Note

    The server URL starts with https:// not http://. Don't forget to include the s.

  • Click on Server Sign-on Credential and change your authentication from None (anonymous access) to Username. Then, click Username, and enter demo_user1 in the space. Also change your server password to password.

    Tip

    You can also login by scanning a QR code.

  1. Back out until you return to Tables.

  2. Follow the Syncing instructions (see launching from Tables).

  • Again, leave your user as None (anonymous access).

  • Leave the file attachment setting to Fully Sync Attachments

After synchronization is complete, your device's configuration will exactly match that of the server. This includes both collected data and application level files (such as form definitions and HTML files). If you had nothing on your device before, your device will be populated with this data and these application files. If you already had files on this device in this application namespace they will be updated to match the server version. Any local configuration files for data tables or forms that are not present on the server will be removed from your device. Everything under the /sdcard/opendatakit/default/config directory will be revised to exactly match the content on the server.

Once the configuration and data on the device is an exact match to that of the server, the file attachments associated with those data are synchronized. If you have a slow connection, it may take two or three tries before the sync is successful. This will not overwrite or hurt anything to do multiple synchronizations in a row.

When complete, click OK on the Sync Outcome dialog and back out of the Services, returning to Tables.

Note

If there are sync conflicts, see Resolving Sync Conflicts for information on resolving sync conflicts.

If the sync was successful, ODK-X Tables will scan through the downloaded configuration, updating its list of available forms.

Tables Update Configuration

After this configuration is set up, ODK-X Tables should now present a custom home screen with five tabs, one for each of the demos. If it does not, back out of ODK-X Tables and re-launch it.

Learn More

For instructions on installing your own Tables application to a device, view the Moving Files To The Device guide.