Generic features¶

Login¶

There are two ways to access the application:

1. Manual: The user must type the corresponding URL of the server to be used and enter the username and password.

   Note

   Take note that login is only possible with servers from version 2.29.

2. QR: The user can use a QR code instead of typing the URL but username and password must be entered manually.

Note

1. After a succesful login the DHIS2 Android App will keep these values cached (URL and username) and will suggest them for future connections without having to type them.

After a succesful login the user should be able to perform an offline login only (only avaialble for the last combination of URL/Username). Offline usage gives the possiblity of using the application withou any type of connectivity. All data will still be stored and user can perform a synchornization once the connection is restablished or avaialble.

Warning

In DHIS2 versions up to 2.30 if a user attemps an on-line login and their account has been disabled as explained in the DHIS 2 Manual - Disable User all the data will be wiped from the phone. Make sure that before disabling a user all the data has been synced or that you are using this feature to remotely wipe sensitive data in case of a device getting lost.

Due to a change in the login API this feature is not available in 2.31, 2.32, 2.33, 2.34, 2.35 and 2.36.

Offline Multi-user¶

The Android app have removed the limitation on the number of offline accounts that users can create, allowing them to work with as many offline accounts as needed.

The users will need to have access to the internet for the first login of each account and will be able to switch accounts after without requiring access to the Internet.

The users will be able to manage the user accounts and delete accounts if needed.

Account Recovery¶

The users will be able to restore their own password if they have the setting enabled: Enabled User Account Recovery.

Blocking session (PIN)¶

User is able to lock the session using a 4 digit PIN. This allows to move to other apps in your phone without deleting the local data. If the user forgets the PIN number, log in by entering the credentials is also available.

Fingerprint¶

User is able to use the fingerprint scanner if the feature is activated in the device.

• When the fingerprint scanner is enable and not the PIN, every time the app closes, goes to background or the device is blocked, the session will be locked. Once the app is open again, the user needs to tap the fingerprint icon to activate the scanner.
• If the PIN and the fingerprint are set, when the session is locked and the user open the app again, the PIN will be asked.

Instructions/information buttons¶

A contextual guide is available in TEI dashboard screen.

Tip

User is able to re-open the instructions by clicking on the three dots at the top right corner of the screen.

Filter¶

A filter can be applied in all listing screens (home, event listing, tei search and dataSets) which narrows down the data displayed. The filters available are: period, org. unit, sync state, event status, category option combination and "assigned to me".

Filters will adapt to the different programs and data sets.

1. Program without registration: Date, Org. Unit, Sync State, Event Status and, Category Combination.
2. Program with registration: Event Date, Date of enrollment, Org. Unit, Sync, Enrollment Status, Event Status and Assigned to me. The filter icon will show only if a list of events is available (Display front page list feature or search)
3. Data Sets: Period, Org. Unit, and Sync State.

Assigned to me¶

It is possible to filter events based on its assignment to the current user. The “Assigned to me” filter has been added to the single event program list, the TEI list and the TEI Dashboard and the map views. It will only be displayed when the active program is configured to assign events to users.

Event Date/Date/Period¶

Filter the Events, TEIs(based on their events) and data sets, the following periods of time are availables: - Today - This week - This month - Yesterday - Last week - Last month - Tomorrow - Next week - Next month - From-to - Other (Opens a date picker) - Anytime

Org. Unit¶

Allows the user to type the search or select an organisation unit from the tree. The filter will not be visible if the user has only one Organisation Unit configured.

Sync¶

Filer by: - Synced (events, TEIs, Data Sets) - Not Synced - Sync Error - SMS Synced

Event Status¶

Filter the events by: - Open - Schedule - Overdue - Completed - Skipped

Multiple status selection is permited. Once you open a TEI, the filter will be kept in the dashboard and show only the events with the selected status.

Events shown are up to 5 years old.

Date of Enrollment¶

The 'Date of Enrollment' will apply to the Enrollment date of the TEI in the program. If there is more than one enrollment date, it should sort the results by the most recent one. The label of this filter will display when available.

Enrollment Status¶

The filter 'Enrollment status' offers three options: Active, Completed, Cancelled. Only one option can be selected at time. If you filter by "completed" and the TEI has more than one enrollment, the app will open the "active" enrollment. To see the completed one, select the three dot menu at the top right corner of the dashboard and select "program enrollments".

Follow-Up¶

The 'Follow Up' filter allowes the user to filter out the TEIs that have been marked as 'Follow-up'. TEIs can be marked to be followed up in the TEI Dashbaord.

Filtering added in TEI Dashboard:¶

Filters have been added to the TEI dashboard. It is possible to filter the events of a Tracked Entity Instance enrollment per period, organisation unit, sync status, event status, and user assignment.

Sorting¶

Sorting has been integrated in the filter menu.

The sorting button will be on the filter bars with the following behavior: - Only one sorting applies at a time. If the user clicks a different one, the previous one is disabled. - The icon for applied sorting shows it is active, the others are inactive.
- Repeated clicks keep changing the order to the reverse.

Dates (Period, Date, Event Date or Enrollment Date)¶

• Event Date preceds due date, only use due date when there is no event date.
• Order from most recent to less recent. Future events (due date) goes first.

Org. Unit¶

• List will be sorted in alphabetical order by org unit name.

Enrollment Status¶

• List will be sorted in alphabetical order by status name.

Sync Information¶

Login Sync¶

During the metadata download, the app will remain in the splash screen and will open the home screen once the metadata is in the device.

In the home screen, the app will inform with a loading spinner on each program when the data is downloading. After the sync process finishes, the app will display one of the two possible icons:

• A green checkmark if the program downloads data successfully and without errors (the icon will disappear after three seconds) or,
• A gray arrow if there is an error during the sync process and the total or partial data isn't donwloaded

The user will be able to see how many programs are downloading data, or completed, making the waiting process more transparent and informative about its progress.

NOTE: All programs and data sets will be blocked until the sync process is fully finished.

Subsequent logins¶

The application will launch a sync process for data and metadata only for the first time the user logs in. In order to facilitate the work in the most difficult cases, the sync process have been removed for the subsequent logins. This means that when the user opens the app, it will open without performing a full sync even if the user logs out of the account.

If the user deletes the account, then the next login will launch the sync process.

Also, users have the option to sync with the server through the Refresh button any time they wish.

Sync Status¶

Next to each program or data set an icon will be displayed which allows the user to check sync information. Synced records will not show display any icon. Unsynced (grey arrows), error (red arrows), warning (orange) or SMS (blue and including the SMS word inside) icons are be displayed according to the status.

Granular Sync¶

Users can click on the grey arrows (which means record(s) stored online in the device) to perform a sync. These options are available at top level (programs/dataset) or individually (TEI, events, datavalues).

SMS Sync¶

When there is no Internet conection (either via WiFi or Mobile Data) but there is still mobile conectivity, users can synchronize via SMS if the gateway has been previously established in the app and properly configured at server level.

If the app has been downloaded from Google Play users will have to send manually the SMS from their default SMS app (their default SMS application will open with the message composed). Users should send the message without modifying it and then switch back to the DHIS2 app to confirm that the message was sent.

However, if the app has been downloaded from Github (or the training version is being used) the App will just ask for a confirmation to send one or several messages (SMS) and will send them in the background (without opening the default SMS application).

Tip

Edit parameters related to SMS gateway in the SMS Settings (Settings Menu) or set this globally via the #capture_app_android_settings_webapp_general

Note

Note that in order to user the SMS sync capabilities the SMS services needs to be enabled in the server side as described in the https://docs.dhis2.org/master/en/dhis2_user_manual_en/mobile.html#sms-service. You can also find more information on how to use different gateways in the https://docs.dhis2.org/master/en/dhis2_android_implementation_guideline/about-this-guide.html

Meta data sync error¶

In case of errors during the sync process, a message is displayed in the settings menu ('Sync data' or 'Sync configuration' section). Also, a red sync icon is displayed next to the program in the Home screen. The sync error log gives details about the error and is prepared to be shared with admins.

You can also open the sync errors log from Settings:

Refresh data¶

Users can now retrieve the latest data from the server before entering new data. A refresh button is now located to trigger a granular synchronization in the following screens:

• Home
• Search
• TEI dashboard
• Event program listing
• Event details
• Data set listing
• Data set details

Org unit¶

The whole organisation unit tree is displayed. Organisation units not available for data entry will be colored in grey. User must check the box to select the org unit wanted. After an organisation unit is selected, the parents will be marked in bold to show hint of the organisation unit selection when opening the hierarchy.

Caution

Mobile users are not expected to access the org. unit hierarchy of a whole country. Maximum number of org units is difficult to set, as the App does not set the limit, but the resources on the device (memory, processor). We could say below 250 org units should be safe, but still believe that is a very big number for a mobile use case.

Data Sets¶

The user can now enter aggregate data for an organisation Unit, a period and a set of data elements and send it to the server.

Home¶

The home screen of the DHIS2 Android App shows the list of programs and data sets available for the user. The first thing the user does when collecting data in this case is to select the program or data set to work with.

Tip

An easy way to differentiate them is by looking at the word at the bottom left corner. The word 'Event' will always be in event programs. In tracker will appear the name of the tracked entity type (person, patient, building, etc.). For data sets, the word 'DataSets' will be shown next to the number of records.

For those implementations where the users have access to only one program or dataset, the App will skip the home and will open directly the program or datasaset screen with the event, TEI or dataset list to reduce the number of clicks and streamline the process of data entry.

Sharing Data¶

Users can share TEI via QR codes. This allows transferring/sharing information between devices without the need of transferring via the server (useful when connecitivity might be missing). To do this users should open any TEI and click on the SHARE button.

Capture Coordinates¶

TEI coordinates¶

Capture the TEI coordinates in the registration form. Enable this feature in the TET feature type.

Polygons¶

The app now supports the geoJSON format and the user is able to capture polygons.

Images¶

ValueType image can be used in Android to capture data and also, depending on the program configuration to be displayed in the TEI dashboard. When this value type the first data element/attribute marked as displayed in the program configuration it will be used as the TEI profile image.

Open the TEI profile image by clicking on it.

Display events and TEIs in maps¶

When a program stage or tracked entity type have a feature type (and for programs with registration the option displayFrontPageList is enabled) the listings can be switched to display the information in a map. Make the switch by clicking on the map icon in the navigation panel.

If the TEI has a profile image, the map will display it.

Personalized Calendar View¶

In the DHIS2 Android Capture App users can switch date selection from spinner to calendar view. In this version, the app will remember the last visualization selected by the user and use it the next time the user needs to select a date.

Reason for non-editable data¶

Data can be blocked for many reasons in DHIS2, because of access restrictions or expiration among others. When an Event, TEI or Data Set are not editable the user will be able to find the reason on the "Details" section.

The following list contains all possible reasons:

• Event completion
• Enrollment completion
• Expired event
• Closed organization unit
• Organization unit out of capture scope
• No access to capture data in the program or data set
• No access to a category option in the program or data set

Configuration troubleshooting¶

This feature is for administrators. The Android App incorporates an option in the settings screen for verifying some aspects of the DHIS2 configuration.

• Language: the user will be able to change the language of the application user interface to identify labels, buttons or prompts with errors or without translation.

• Program rule validation: this validator will check the program rules in the device and display configuration inconsistencies.

Error Navigation¶

The Android App has improved the navigation of sync errors on the user interface. The app will display the sync errors in a simple and clean manner allowing the user to navigate from the home screen to the exact field that is causing the error inside the event or data set.

User must tap on any of the errors listed and the app will move to the correspondent screen. Once the error is located and fixed, the user can synced by tapping on the "Refresh" button.

LMIS Module¶

The new module for real stock monitoring use case enables users to manage and monitor their stock levels in real-time. Integrating a module implies that the app will open a completely new and different user interface and experience to respond to a different data entry flow. To use this modules the program will need to be configured using the new web app for program use case configuration.