Getting Started Deployment Architect Guide¶
Other perspective definitions can be found here.
- Migrating / Setting-up an ODK-X application
- Configuring your Device with an Application
- Modifying an ODK-X application
- Useful Grunt Commands
- Next Steps
This guide continues the tour were Getting Started User Guide left off. If you haven't yet completed that tour, do it first. When you have concluded the tour of the Geotagger example application's screens, return to this guide and we will turn to setting up our own ODK Aggregate server, and setting the application up to run on that server.
Now that we have seen how a device can join an already-configured application, and synchronize its view of the data with the ODK Aggregate server hosting the application, it is time to set up our own ODK Aggregate server.
The starting point for this is to have a fully configured application on your device. Only proceed with the following steps after you have your device configured as you want it to appear. In this case, we already have the device configured with the Geotagger demo, so let's proceed to create an ODK Aggregate server and configure it to serve that demo to your devices.
Follow the instructions for Installing Aggregate. You must install the ODK Aggregate v1.4.15 release. This is because we are transitioning away from Aggregate and towards ODK Sync Endpoint, but v1.4.15 will suit the purposes of this demo fine.
Once you have installed ODK Aggregate, log in with your super-user account. That process is also covered in Installing Aggregate.
Once logged in, enable the ODK Aggregate Tables Extension. You should grant the user account on your device the Administer Tables permissions.
Resetting the application on the ODK Aggregate server will push the application configuration on your device up to your server, replacing the configuration that is already on your server. Once the configuration is updated, data tables on the server and device will be synced. This process does not destroy data on the server, but instead merges changes on the client with any existing data tables on the server (this enables you to update your configuration without worrying about damaging or destroying the data already captured on the server).
Return to your device, start ODK Tables:
- Click the diminishing-lines icon to leave the custom home screen.
- Click the three vertical dots and select Sync to launch ODK Services onto the sync screen.
- Edit the Server URL to be the URL for this newly configured ODK Aggregate server (https://myodk-test.appspot.com).
- Click on Server Sign-on Credential and choose .
- Choose Username and enter the superuser username for your ODK Aggregate server.
- Choose Server Password and enter the ODK Aggregate server password for that superuser username.
- Click the back button until you have returned to the sync screen.
- Click on Reset App Server to push your device configuration up to your ODK Aggregate server.
After this has completed, you have created your own server that replicates the configuration and contents of the https://opendatakit-simpledemo.appspot.com site. Congratulations!
Any device with a user account with Administer Tables permissions can reset the app server. If you configure a device with a user account (or Anonymous user) with only the Synchronize Tables permissions, they will not be able to reset the app server and will only be able to sync and join into the existing ODK-X application on this ODK Aggregate server.
Next, we will work through the steps to configure your device with an ODK-X application (rather than downloading an existing application from a server).
This task begins with setting up the ODK Application Designer on your computer.
For the purposes of this tutorial, we have created a copy of the Application Designer that only contains the files for this Geotagger example (it is otherwise identical).
Read the Intro and Overview sections to get a sense of the features and functionality of the ODK-X Application Designer environment (we will install it below). Follow this guide to Setting Up ODK Application Designer.
Finally, follow this guide to Launching the Application Designer.
If successful, the cmd window (on Windows) should display some status messages. Below is a screen-shot of my cmd window beginning with a dir of the contents of the directory, and running grunt in that directory:
And a Chrome browser window should open to display:
If a Chrome browser does not open, try manually launching it and opening http://localhost:8000/index.html.
You can further verify that the Application Designer works by clicking on the Geotagger button, then clicking on Follow link. This opens the Geotagger form on your computer, and simulates all the features available to you on your device.
You can also try other things, like choosing different device dimensions to see how the form renders on different screen geometries.
We will return to this design environment later.
Now that we have the design environment installed and functioning, and because that environment has a copy of the fully-configured Geotagger application that is running on https://opendatakit-simpledemo.appspot.com (minus any data that users have submitted to the server), we can work through the steps of deploying that application to your device, and then resetting your server to push that configuration up to your server.
First, confirm that your device has USB debugging enabled inside your device's Settings. This checkbox is in different places on different devices and may be hidden by default on some. See this guide to USB debugging on Android for instructions.
Return to the cmd window on your computer.
Control-C to stop the grunt command that popped-open the Chrome browser. On Windows, you will be asked to confirm this
Terminate batch job (Y/N)?. Enter
Y to confirm.
Connect your device to your computer via USB. Wait for the storage connection to be established (on Windows, this will generally pop up a file browser or an options box that enables you to select a file browser). Be sure you trust your computer on your Android device, or it will cause unexpected errors.
At the command prompt, type:
$ grunt adbpush
This command will force-close ODK Services, Survey, and Tables, and it will clear all ODK-X data from the device. The data you are pushing will overwrite any exiting application or collected data you might have. Be sure to make backups and be sure you are ready before running this command.
This pushes the configured ODK-X application within this ODK-X Application Designer directory to your device. Because this is a stripped-down version of the Application Designer that only contains the simple demo files, this will copy only those files to the device. When you issue this command, the cmd window will display a long series of commands and conclude with a display of overall progress and timings:
Now, on your device, launch ODK Tables.
This will initiate the configuration of ODK Tables and conclude with a Configuration Summary pop-up reporting that everything was imported successfully. Click OK.
Everything should now appear as it did with the application you first joined on https://opendatakit-simpledemo.appspot.com, except you will only have the data rows configured by the ODK-X Application Designer zip, and not any added or modified since that time.
Once you have the application running on the device, you will typically need to reset the contents of the application server. While the Reset App Server button on the device can shuffle the various supporting files between the device and the server, it will not destroy data tables that already exist on the server. This is intentional – we want to minimize the potential for accidental loss of data.
Whenever you are developing an application, and have found a need to add a new column to an existing table, you will need to manually delete the data tables from the server before using the Reset App Server button from the device.
Open a browser window to the server, log in with a user that has Administer Tables or Site Admin privileges.
Navigate to the ODK Tables / Current Tables sub-tab.
Delete each of the tables here. In this case, there will be only one, Geotagger. The server will now have a set of App-Level files but no data tables, forms for those tables, or data files. Except for the app-level files, it is clean.
If your table has a large number of configuration files or data rows, the server may time out during the deletion process. In this case, the next time you try to create the table on the server, it will resume the deletion process, and potentially time out again until such time as it is able to finish the deletion. Only then will it re-create the table.
Now, from your device, launch ODK Tables, click on the sync icon (two curved arrows) to launch ODK Services, make sure you are logging in as a user with Administer Tables or Site Admin privileges, and choose Reset App Server.
The synchronization process will create the tables and push your content up to this server. Note that the server now only contains the data rows present on the device – it no longer has any of the additional data records from the demo site.
You have now successfully set up the Application Designer, used it to deploy an application to a device, and, from that device, configured an ODK Aggregate server to supply that application to other devices you join to that server.
The final task is to modify the Geotagger example by adding a new data field to it.
The overall development process is:
And then follow the steps in the preceding section to deploy the modified application to the device and push the application up to an ODK Aggregate server.
Return to your cmd window and once again launch the ODK-X Application Designer environment (and a Chrome browser) by typing:
Now, open a file browser and navigate to the directory where you downloaded the Application Designer. Then navigate within that directory to
app/config/tables/geotagger. Rename the
definition.csv files in this directory to
orig.definition.csv. These were the initialization files needed by ODK Tables and they will need to be regenerated because we are altering the data table to incorporate an additional question.
Navigate within that directory to
app/config/tables/geotagger/forms/geotagger. Open the
geotagger.xlsx file in Excel (or OpenOffice). This is the form definition used by ODK Survey.
We will be adding a question to ask the user what direction they were facing when they took the photo. For this example, we will be collecting a text response. A more realistic modification might restrict the user to a set of choices (North, Northwest, West, Southwest, South, and so on).
On the survey worksheet, after the image-capture prompt, add a row that looks like the following.
|string||Direction||Image Direction||Enter the direction in which the photo was taken (North, South, East, West, and so on)|
Save your changes and go back to the Application Designer. Click on the tab that says XLSX Converter. Choose this XLSX file or use your file browser to drag and drop the
geotagger.xlsx file onto this screen (dragging and dropping is not supported on all operating systems).
You should now see some JSON in the output window. Hit the Save to File System button. This will display three pop-up notifications announcing that the Application Designer is
- Writing the updated ODK Survey form definition into the
formDef.jsonfile in the same location as the
- Updating the
- Updating the
properties.csv files are updated because the form_id is the same as the table_id.
Go back to the Chrome Browser and click on the Preview tab. Click on Purge Database. This will delete the earlier Geotagger data table – a necessary step because we are adding a Direction column to that data table. Select Geotagger if you do not already have that form open.
Create a new instance of Geotagger and advance through it (this will create the data table with the new Direction column). Confirm that the new question is displayed. Note that the date and description are required fields and will generate error pop-ups if you attempt to advance through those prompts without supplying a value.
You have now successfully modified the form.
Fortunately, because the geotagger formId matches the tableId, by using the Save to File System button on the CSV, the tool will automatically regenerate the
properties.csv files for this form. Furthermore, the configuration that ODK Tables uses to specify what HTML files to use for the list, detail, and map views are all specified within the XLSX file on the properties sheet. No manual actions are required!
Now, deploy your updated application to your device. Launch ODK Tables to initialize and load your application. Confirm that when you edit a data row that you are now asked for the direction in which the photo was taken.
At this point, we have added the new field to the data table, but have not yet updated the initial set of Geotagger locations with values for that field.
Return to your
Application Designer directory. Recall that when an ODK Tables application first starts up, it reads the
assets/tables.init file. That file identifies CSV files within
config/assets/csv that should be imported into the data tables upon first start-up. Read more about importing data into a table from a CSV in the ODK Tables guide.
In this example application, the file being imported is
config/assets/csv/geotagger.updated.csv. If we wanted to, we could edit this file, add a column for the new data field (Direction), and supply values for this field for all of the data rows that form the initial set of Geotagger locations.
Alternatively, we can return to the device and use the CSV export functionality within ODK Tables to export the CSV file (into
/sdcard/opendatakit/default/output/csv). Then pull it off the device and overwrite the CSV file under the Application Designer at
app/config/assets/csv/geotagger.updated.csv. Finally, open that file and fill in values for the Direction column.
Some CSV editors, like Office or OpenOffice, may convert or alter the content inappropriately when you save changes. If your edits cause the device to fail to initialize the data fields, you may need to make this edit manually using a less-sophisticated tool or choose different options when saving your changes.
There are two areas where image information is displayed, one is in the list view, where you can expand or collapse an item, and the other is in the detail view, which is opened when you click or tap on an expanded item in the list view. We will only modify this detail view to report the image direction. A more comprehensive edit would likely also update the expanded item within the list view.
To determine all the HTML files, we can begin with the files referenced in the
properties.csv file we recently finished editing. Looking again at that file, we see three files referenced:
Open a file browser and navigate to the directory where you downloaded the Application Designer. Then navigate within that directory to
geo_detail.html in a text editor. Insert a line that defines a DIR element above the Latitude line in the HTML body region. This will be where we will display the value of the Direction field. For example:
<h1><span id="TITLE"></span></h1> <p>Image Direction: <span id="DIR"></span></p> <p>Latitude: <span id="FIELD_1"></span></p>
Save the file. Now, navigate to
geo_detail.js in a text editor. Navigate down to the bottom of the
var dir = geoDetailResultSet.get("Direction"); document.getElementById("DIR").innerHTML = dir;
Save the file. Once again, push the application to the device. Confirm that when you expand a item in the map list window, and then tap on that expanded item, that it now shows Image Direction:. (See example below.)
Congratulations, you have successfully modified this ODK-X application to add a new data field and display it as a field in the HTML detail-view page.
You could now log onto your server, delete the geotagger table, reset your server, and start collecting geopoints with the new image direction field.
grunt addtable:tableid : Will create the required directory structure for an individual table, including the forms directory.
grunt xlsx-convert-all : Takes all .xlsx files and converts them into a formDef.json file. Can be used instead of XLSX converter on the app designer.
grunt wipe-data : Allows users to get rid of the default tables/data included with app designer.
grunt setup : Launches the login and sync screen on the connected device.
grunt kill all : Force stops survey, tables and services on the connected device.
grunt uninstall : Uninstall ODK tools from the connected device.
Survey and Tables each have a basic sample application that walks through their features:
To get started building applications, first set up the ODK Application Designer. After you have familiarized yourself with that tool, you can try building and deploying an application:
For examples of real world applications and details about they are implemented, try out the: Reference Applications.
We also provide guides geared towards Deployment Architects for each of the Android and Desktop tools.
However the user guides for these tools are also useful for everyone.
Finally, to expand your knowledge of the more advanced features of the platform, such as data permission filters, read the Deployment Architect Advanced Topics.