If you're encountering the "You must use a Chrome or Safari browser" error when running the ODK-X Application Designer, you are not running the latest version - please update to v2.1.11

Logo

Getting Started

  • Selecting the Appropriate Tool Suite
  • Installing ODK-X Basic Tools
  • Trying Out ODK-X Survey
  • Trying Out ODK-X Tables
  • Getting Started Building an Application
  • Example Applications
    • Geographic Health Survey App
    • Longitudinal Clinic Study App
      • Key Features
      • Installing Hope Study
      • Guided Tour
        • Hope Study Guided Tour
    • Inventory Management and Maintenance App
  • Troubleshooting

Building your own Application

  • Building an Application
  • ODK-X Application Designer
  • Setting Up ODK-X Application Designer
  • Using ODK-X Application Designer
  • ODK-X XLSX Converter
  • ODK-X Tables Web Pages
  • ODK-X WebKit

Mobile Apps

  • ODK-X Survey
  • ODK-X Tables
  • ODK-X Services
  • ODK-X Notify

Cloud Apps

  • ODK-X Cloud Endpoints
  • ODK-X Sync Endpoint
  • Setup ODK-X Sync Endpoint with Cloud Services
  • Setup ODK-X Sync Endpoint Manually
  • Users and Groups

Desktop Apps

  • ODK-X Suitcase

Advanced Topics

  • Advanced Application Building Topics
  • Platform Developer Advanced Topics

Contributing

  • Contributing to ODK-X Docs

Currently Not Supported

  • ODK-X Scan
  • ODK-X Scan Form Designer
  • ODK Aggregate Tables Extension
ODK-X
  • Example Applications
  • Longitudinal Clinic Study App
  • Hope Study Guided Tour
  • Main Menu
  • Edit on GitHub

Main Menu

Main Menu

Function

The Main Menu module is the first screen a user sees after launching the application, and provides a basic choice of the three main workflow options available:

  • Screen Female Client: to launch the female client screening form: Screen Client.

  • Follow Up with Existing Client: to find the record for an existing client and launch the appropriate follow up form (the Existing Client List module).

  • Send Data: To launch the synchronization interface and sync the database with the server: Send Data.

Implementation

This is the first screen a user sees, which would usually imply that its html file is assets/index.html. However, this application is embedded within the larger Tables Sample Application, which claims the index.html file. That demo launches assets/hope.html, which defines this screen. If this application were extracted from this sample application and deployed on its own, this file would need to be renamed index.html.

This file creates its HTML <body> dynamically with embedded JavaScript. This JavaScript defines the three buttons:

  • Screen Female Client: Calls odkTables.addRowWithSurvey(...) to launch the screenClient form. Notice that the database table being written to is femaleClients which is shared among other forms. See the Follow Up Forms module implementation details.

  • Follow Up with Existing Client: Calls odkTables.openTableToListView(...) to launch the Existing Client module.

  • Send Data: Calls odkCommon.doAction(...) to launch the SyncActivity. This is the same functionality as pressing the sync button in the upper right of the screen, but with two advantages.

    1. The call is embedded within the custom workflow of the application so the user can be instructed to use it at the appropriate time.

    2. The doAction function supports the Action-Callback workflow, which means further actions could be triggered after synchronization is completed.

Files

  • assets/hope.html

Forms

None

Database Tables

None

Hope Study Guided Tour Screen Client

Download this documentation as a PDF.

For video tutorials, you can check out our YouTube Channel

If you still need help, you can ask support questions in the ODK-X Forum

If you find a problem with this documentation, please file an issue

You are also encouraged to fork our Github repo and become a contributor

© Copyright 2023, ODK-X. This document is licensed under a Creative Commons Attribution 4.0 International License..

Built with Sphinx using a theme provided by Read the Docs.