Webová aplikace Nastavení Android¶

Přehled¶

Tato část se zaměřuje na implementaci Webová aplikace Nastavení Android.

Webová aplikace Natavení Androidu umožňuje administrátorům konfigurovat parametry synchronizace pro aplikaci DHIS2 Android, šifrovat místní databázi zařízení Android , přizpůsobit vzhled programů, datových sad a domovské obrazovky a přidat položky TEI Analytiky. Konfigurační parametry definované v této webové aplikaci přepíší nastavení všech zařízení Android používajících aplikaci DHIS2 Android Capture.

Please note that in this version of the Web App (2.3), if the DHIS2 version is equal to or higher than 2.40, only users with "M_androidsettingsapp" or "ALL" authority can define those parameters in the configuration. Other users accessing the web app can see the value of the parameters but cannot edit them.

Warning

If the DHIS2 version is not above 2.40, only users with 'ALL' authority can define those parameters in the configuration.

Obecná nastavení¶

Zahrnuje konfigurace, jako je Matomo URL a ID projektu, počet vyhrazených hodnot ke stažení na TEI a šifrování databáze zařízení.

Matomo configuration¶

The DHIS2 Android App sends anonymize analytics that can be used to evaluate performance and/or detect problems at an early stage. Matomo is the tool used for this and running in a specific server not accessible to the general public. However, implementations can set up their own Matomo instance (or using the cloud version) in order to collect and analyse the statistics.

Once you have your Matomo instance ready you should get the URLs and the project ID like shown in the picture below (left). The ID can be introduced directly but the URL needs to be followed with /matomo.php and start with https or http as shown below (right).

Mobile configuration¶

This section allows admin users to edit the SMS gateway ad result sender phone number. This configuration can be found in the Android app. - Klepněte na Nastavení - Klikněte na Nastavení SMS

Reserved values¶

Toto určí počet hodnot na atribut TEI vyhrazený ke stažení do zařízení. Ve výchozím nastavení si aplikace pro Android vyhrazuje 100 ID, ale toto číslo je možné přidat nebo snížit.

To find this configuration in the Android app: - Klepněte na Nastavení - Click on Reserved Values - To refill them click on Manage Reserved Values

Encrypt device database¶

To přinutí všechna zařízení ukládat databázi zašifrovaně, čímž se zvýší úroveň zabezpečení proti útokům krádeže dat.

By default, the DHIS2 Android App database is not encrypted, but an admin can check the Encrypt device database to encrypt the metadata and data stored in every device. Encrypting the database will have an impact on the database volume and performance (degradation between 10-15%) of the Android app. Note that at the moment of selecting or unselecting this option, no data is lost (even if it hasn't been previously synchronized with the server)

Warning

This is a critical action and will affect the local database of all Android devices synchronizing with the server (it won't affect the server DHIS2 database).

By default, the Android app database is not encrypted, but an admin can check the Encrypt device database to encrypt the metadata and data stored in every device. Encrypting the database will have an impact on the database volume and performance of the Android app. Note that at the moment of selecting or unselecting this option, no data is lost (even if it hasn't been previously synchronized with the server)

Allow screenshots¶

This section allows to configure the possibility to take screenshots or screen sharing using the Android Capture App (which is required to remote support with applications like Teamviewer, Teams, etc.). Please note that the default behavior is deactivated screenshots.

Warning

The DHIS2 Android App disables the possibility of taking screenshots (and capturing the screen from other apps) by default following security and privacy recommendations. Allowing screenshots might be useful for support and/or sharing purposes in same cases but make sure you understand the security and privacy implications of this setting before enabling it.

Skip DHIS2 version validation (v2.4)¶

When connecting to DHIS2 instances, the app typically verifies compatibility with supported versions. However, in some cases, connecting to unsupported instances may be necessary or useful. Please note that the default behavior is to enforce strict version validation. To skip the validation process for DHIS2 version compatibility, select the checkbox.

Warning

This option is only applicable when using Android Capture app version 3.0 or later.

Opt-in Features (v2.3.1)¶

Opt-in features are additional functionalities or settings within the application that the user can choose to enable based on preferences. Unlike default settings, these features require an explicit consent or action ('opting in') to activate. Opting in allows the user to customize the experience by adding extra capabilities to the app. Keep in mind that these features might come with specific considerations, so it is recommended to review any associated information before opting in.

To enable a feature:

• Click on Opt-in Features.
• A list of available opt-in settings will appear.
• Click on the feature's checkbox to enable it.

Data entry Form (**v2.4):** The inputs for all value types have been redesigned in the Android Capture App with an improved selection mode and increased tappable areas and texts to offer a cleaner and more intuitive user experience. By default, the Android Capture App will display the new forms. Admin users can opt out of using the new version of forms by clicking the checkbox option.

Disable all settings¶

Kliknutím na toto tlačítko uživatel odstraní všechna nastavení konfigurace systému Android. Na aplikaci pro Android nebude použita žádná konfigurace (pokud je to tento případ, použijí se parametry synchronizace ty, které jsou definovány v aplikaci Android Capture).

Synchronizace¶

Nabízí další parametry pro řízení synchronizace metadat/dat.

Globální¶

Metadata sync

Admin users can choose how often the metadata will sync. e.g. Sync metadata every 24 hours.

Data sync

Admin users can choose how often the data will sync. e.g. Syncing data every 6 hours.

Use the new Tracker Importer

Admin users can choose which tracker importer endpoint will be used.

Warning

This option is only available if the Android Settings Webapp is used from version 2.38 DHIS2 API onwards.

By default, if the DHIS2 API version is 2.38 or higher, the Android app will use the importer introduced in 2.37 /api/tracker endpoint but an admin can deselect this option and the legacy tracker importer /api/trackedEntityInstances will be used.

Use the new Tracker Exporter (v2.3)

Admin users can choose which tracker exporter endpoint will be used.

Warning

This option is only available if the Android Settings Webapp is used from version 2.40 DHIS2 API onwards.

By default, if the DHIS2 API version is 2.40 or higher, the Android app will use the exporter introduced in the 2.37 /api/tracker endpoint, but an admin can deselect this option, and the legacy tracker importer /api/trackedEntityInstances will be used.

Limit the file size to download (v2.3)

Admin users can limit the maximum size of the file resources downloaded in KB.

Note

Admin users have the ability to set the maximum file resource size for downloads. Admins can now leave the field with no value to indicate no limit on the maximum file size. (v2.4.1) - no value: Allows unlimited file resource size for downloads. By default, this is the initial value. - 0: Restricts downloads to 0 KB. - Any positive value: Restricts downloads to files within the specified maximum size limit (in megabytes or another unit).

This provides flexibility for admins to either enforce a file size limit or allow unrestricted downloads depending on their needs.

Program¶

Tato sekce ovládá parametry synchronizace dat programu. Má sekci pro definování globálních nebo výchozích parametrů, které se mají použít při synchronizaci všech programů.

Globální nastavení¶

Globální nastavení platí pro všechny programy, ke kterým má uživatel Android přístup. Nastavení lze povolit globálně, na organizační jednotku, na program nebo na organizační jednotku a program.

• TEI to download: Maximum number of TEIs to download from the server.

• TEI download period: It downloads the TEIs that have been updated within a period. e.g. TEIs that have been updated within last month

• Event to download: Maximum number of Events to download (from events programs, see note below).

• Event download period: It downloads Events which event date belongs to a specific period.

Poznámka

Administrators may notice that the total number of downloaded events appears higher than expected when configuring limits for both TEIs and Events. This is due to how the Android app applies these limits:

• The TEI limit controls how many tracked entities are downloaded, including all their associated events.
• The Event limit applies only to event programs (programs without registration).
• It does not restrict events belonging to tracker programs.

Example:

A tracker program contains TEIs with an average of 5 events each. If the TEI download limit is set to 100, the app will download those 100 TEIs and all their related events (100 × 5 = 500 events). Additionally, an event program contains 1,000 standalone events, and the Event download limit is set to 200. In total, the Android app will download:

• 500 events from the tracker program (due to 100 TEIs × 5 events each)
• 200 events from the event program

Resulting in 700 events downloaded overall.

Konkrétní nastavení¶

Program specific settings allow administrators to override the global synchronization rules for selected programs. This is useful when different programs require different limits or filtering criteria.

To configure program-specific settings:

1. Click Add a Program-specific setting.

2. Select a program under Values per Program.

3. Configure the available parameters (varies depending on program type).

Available Parameters

Program specific settings differ depending on whether the program has registration (Tracker) or does not have registration (Event programs). Each setting appears only when applicable.

1. Programs Without Registration (Event programs)

Parameters may include:

• Setting level – Defines whether synchronization applies to all Org Units or specific Org Units.
• Download events based on predefined list views (available from 3.3.0)
• Maximum event downloads

• Download events with event date within (configurable time range)

• Programs With Registration (Tracker programs)

Parameters may include:

• Setting level
• Maximum TEI downloads per program
• Download TEIs updated within
• Download TEIs based on predefined list views (available from 3.3.0)
• Download TEI with status
• Download TEIs with enrollment date within

Download based on List views

When a program is linked to one or more working lists, the corresponding filtering fields will behave as follows:

• The Android app syncs TEIs based on the working list(s) assigned to the user.
• If a user has access to one working list → that list is used.
• If the user has access to multiple lists → their content is merged automatically.

Viewing and managing program-specific settings¶

When one or more program-specific configurations have been saved, they will appear in a summary table. From this table, administrators can:

• View the current configuration per program *Edit the values
• Delete the program-specific settings

Important Considerations¶

Caution Program-specific settings can lead to a larger number of TEIs being downloaded than expected based on the global synchronization limit. This happens because the Android client performs synchronization in two steps:

1. Global sync: Downloads up to X TEIs based on the user’s organisation units and the lastUpdated field.
2. Program-specific sync: Downloads up to Y additional TEIs for each program that has specific settings configured.

If the TEIs included in the global sync were updated more recently than those in a specific program, both sets will be downloaded.

For example: * Global TEI limit = 500 * Program-specific TEI limit for Malaria Case Diagnosis = 500 * Global set contains more recent TEIs than the program-specific set

The device may download up to 1000 TEIs in total — 500 from the global step and 500 from the program-specific step. Although this may seem unexpected at first, it can be used strategically to guarantee minimum TEI numbers for critical programs.

Example

Imagine a program called Community Care with 17 TEIs, all updated a long time ago. The same user also has access to other organisation units with many recently updated TEIs from other programs.

To ensure that all 17 TEIs from Community Care are always downloaded:

Set a low number (e.g., 20) in Global Settings.

Set 17 as the program-specific limit for Community Care.

Initial sync will download:

20 recently updated TEIs (not from Community Care)

17 TEIs from Community Care

Total downloaded = 37 TEIs

Resetovat všechny hodnoty¶

Kliknutím na Resetovat všechny hodnoty uživatel admin obnoví výchozí hodnoty nastavení sekce programu. Upozorňujeme, že v tomto případě to neznamená žádná specifická nastavení pro program.

To save any configuration, the admin user needs to click on the Save button (this button is disabled for the users who don't have "ALL" or "M_androidsettingsapp" authority)

Soubor dat¶

Tato část řídí parametry synchronizace agregovaných dat.

Globální nastavení¶

The first part is for global settings that apply to all data sets an Android user has access to.

The maximum number of periods defines the amount of past periods the app will download in the data synchronization process.

If a data set has future periods ("open future periods" configuration) the app won't take them into consideration in the restriction of the amounts of periods to download.

For example, in a data set with "open future periods" = 2 and a "maximum number of periods to download" = 1, the app will download 3 periods.

Specifická nastavení¶

Přidání konkrétního nastavení:

• Click on Add a Data set specific setting, a dialog with a list of data sets will appear.
• Klikněte na datovou sadu a toto pole se automaticky doplní výchozí hodnotou podle typu období datové sady.

Uživatelský test synchronizace¶

This section checks the amount of data and metadata a user would sync to his/her device. You can run this test on any user that you have access to. This test shows up the number of organisation units, data sets, program rules, programs, etc., that an android user has access to (so the resources that the android app will download), and the metadata and data download size (approx estimation). Please note that a user doesn't need to have the "ALL" or "M_androidsettingsapp" authority to run this test.

Note:

The values that are highlighted in red are because the value is considered greater than the maximum recommended value.

Vzhled¶

Tato nastavení poskytují kontrolu nad vzhledem formulářů pro zadávání dat a seznamů.

• Filtr: definuje filtry, které lze povolit v různých nabídkách aplikace.
• Kolektor dokončení: zapíná/vypíná číselník dokončení, který ukazuje průběh ve formuláři pro zadávání dat.

These settings refer to visual components, so they must be consumed by the app. For more information about filters feel free to review filters documentation.

Domovská obrazovka¶

Umožňuje administrátorovi povolit nebo zakázat možnost zobrazení filtrů souvisejících s Datum, Organizační jednotka, Stav synchronizace a Přiřazeno mi na domovské obrazovce.

Program¶

Program appearance allows to hide/show features within the program according to the configuration needs. These changes can happen globally, applying to ALL the programs, or specifically to a single one.

Globální nastavení¶

Globální nastavení platí pro všechny programy, ke kterým má uživatel systému Android přístup.

Percentage (%) complete in Program: Enable or disable the option to show the completion percentage of the data entry form.

TEI referrals (v2.3.1): It allows to switch off/on the TEI referral option.

Collapse sections in form (v2.3.1):
Current behavior lets the sections collapse and expand in an accordion style. This option overrides the behavior by keeping all the sections of the form (registration and events) open and removing the "next" button in each section.

Konkrétní nastavení¶

This section allows the admin user to customize features such as filter, completion percentage, mandatory search, referrals, TEI headers, referral options and collapse sections in form. Each explained in the section below.

Přidání konkrétního nastavení:

• Click on Add a Program Settings, and a dialog will appear.
• Klikněte na rozevírací seznam, který zobrazí seznam programů.
• Kliknutím na program se zobrazí různé filtry ke konfiguraci. Kombinovaný filtr kategorií závisí na názvu kombinace kategorií.

TEI without searching: Offer online and offline search, as well as allow the user to create a TEI without a prior search.

TEI Header (v2.3.1): Assign a specific attribute or expression that will be displayed as a header in TEI cards.

To add a TEI Header:

• Select a Program Indicator
• An expression related to the program indicator will be displayed

Note:

A notice box will be displayed if the selected program lacks expressions related to program indicators that are valid for Android.

An expression is considered valid for Android only if it is composed exclusively of attributes and/or functions.

If any specific settings have been saved, a table will summarize the particular configuration per program, and the options to edit or delete these settings.

The option "Show percentage (%) complete in Program toolbar" refers to:

Search Tracked Entity (v2.2)

Searching before entering a new TEI is mandatory to avoid possible duplicates, and the DHIS2 Android App has been designed as such. This new version gives the possibility to choose to keep this process or allow the user to create a TEI without searching first. By default, allowing the user to create a TEI without searching is disabled.

Capture Coordinates (v2.4.1)

This section provides admin users with two configurable options for managing location capture on mobile devices:

• Disable Manual Location Capture: By enabling this option, manual location entry on mobile devices is disabled. This ensures that location data is captured automatically, preventing manual errors or alterations.

• Minimum Location Accuracy: This field allows admins to define the minimum precision level (in meters) required for capturing location data. The lower the value, the higher the accuracy required. The minimum recommended value is 5 meters, ensuring reliable and precise location capture.

These options provide admins with greater control over how location data is captured and ensure consistency in the accuracy of recorded positions.

Quick Actions (New 2.4.2)

The Quick Actions Bar is a new feature in the Android App that allows users to configure and add "chips" representing different actions for easy access in the TEI Dashboard. This section aims to enhance user productivity by providing a streamlined and customizable interface for frequently used functions.

Note:

Checking the box will display the action as a "quick-access" chip instead of just listing it in the menu.

Chips can’t be reordered. The order of appearance will be: - Mark for follow-up - Transfer TEI - Complete Enrollment - Cancel Enrollment - More enrollments

By default, all the chips are unselected and the Quick actions bar is not available in the Android app.

Soubor dat¶

Umožňuje správcům povolit / zakázat filtry pro sekci Soubor dat

Globální nastavení¶

První část je pro globální nastavení, které platí pro všechny datové sady, ke kterým má uživatel Androidu přístup.

Konkrétní nastavení¶

Přidání konkrétního nastavení:

• Click on Add a Data set Settings. A dialog box will pop up with a dropdown with a list of data sets.
• Klikněte na soubor dat a zobrazí se seznam možností povolení nebo zakázání filtrů.

Capture Coordinates (New 2.4.2)

This section provides admin users with two configurable options for managing location capture on mobile devices:

• Disable Manual Location Capture: By enabling this option, manual location entry on mobile devices is disabled. This ensures that location data is captured automatically, preventing manual errors or alterations.

• Minimum Location Accuracy: This field allows admins to define the minimum precision level (in meters) required for capturing location data. The lower the value, the higher the accuracy required. The minimum recommended value is 5 meters, ensuring reliable and precise location capture.

These options provide admins with greater control over how location data is captured and ensure consistency in the accuracy of recorded positions.

Analytika¶

Analytics settings define TEI, Home, Program and Data Set analytics items (charts, tables) that will be displayed to the user. Any item defined in the settings app will overwrite the default behaviour of the android app, only showing the items defined in the settings app.

I když jsou tyto analýzy vytvářeny pomocí webové aplikace nastavení systému Android, agregace dat probíhá offline pouze pomocí dat uložených v zařízení.

TEI¶

Rozsah analýzy je TEI, takže vizualizace se zobrazí na ovládacímu panelu TEI aplikace pro Android.

The purpose of this section is to define visualizations to show evolution of data elements and program indicators over time. Based on that, it will only take into consideration data elements that belongs to a repeatable program stage, or program indicators which formula contains at least one data element that belongs to a repeatable program stage.

Chcete-li vytvořit položku TEI Analytika:

1. Click on Add TEI Analytics. A dialog box will pop up with a small form.
2. Vyberte program a opakovatelnou fázi programu a vyplňte formulář. Krátký název je jediné nepovinné pole.
3. Pokud byla vybrána jiná vizualizace položky než Výživa WHO, další pole k výběru jsou typ období (měsíční, týdenní, denní), typ prvku (indikátor programu, datový prvek) a prvek, který bude založen na prvku dříve vybraný typ. Pamatujte, že tyto prvky souvisí s programem a opakovatelnou fází programu zvolenou na začátku.

Chcete-li vytvořit položku WHO Nutrition Analytics:

1. Vyberte program, fázi programu a výživu WHO jako typ vizualizace.
2. Vyberte typ vizualizace WHO, kterým může být výška k věku (HFA), hmotnost k věku (WFA) nebo hmotnost k výšce (WFH).
3. Vyberte atribut trasované entity, který představuje pohlaví. Poté musíte zadat volbu pro Muž 'Mužský nadpis' a volbu pro Žena 'Ženský nadpis'. Normálně to budou kódy možností.
4. Vyberte datový prvek/indikátor programu, který se zobrazí na vodorovné (x) ose
5. Vyberte datový prvek/indikátor programu, který se zobrazí ve vertikální (y) ose

Pokud byla vytvořena jakákoli položka TEI Analytics, tabulka zobrazí název položky a název programu a akční tlačítka pro odstranění nebo úpravu této položky.

Home¶

Vizualizace domova se zobrazují na domovské obrazovce (karta Analytics) aplikace pro Android.

All items available are first created in the Data visualizer or Line Listing app in DHIS2 and configured in the Android Settings app.

Note:

Visualization items can be sourced either from the Data Visualizer or the Line Listing app.

When choosing a visualization type, the items shown automatically change; if "Data Visualization" is selected, only visualizations created in the Data Visualization app will be displayed.

When selecting "Event Visualization" (v2.4), only elements created in the Line Listing app will appear in the Visualization search box.

Chcete-li vytvořit položku Domů:

1. Click on "Add Home Visualization" Button.
2. Choose a "Visualization Type" (v2.4)
3. Klikněte na vyhledávací pole a vyberte vizualizaci ze seznamu nebo zadejte název položky vizualizace.
4. Add an alternative title, otherwise, the app will display the name of the visualization.
5. Ve výchozím nastavení aplikace povolí nastavení skupinové vizualizace.
6. Create a new group: A free text box will pop up to type the name or
7. Vyberte vytvořenou vizualizaci skupiny: Vyberte možnost ze seznamu pro přidání vizualizace nebo
8. Zakažte vizualizaci skupiny kliknutím na zaškrtávací políčko.
9. Klikněte na tlačítko "Uložit".

Note:

Visualizations that are added with no group selected, will be displayed in a common "group"

To edit the title of a Home item (v2.2.1):

1. Vyhledejte položku rozbalením skupin.
2. Click the "Edit" button next to the item's name.
3. A pop-up with only the visualization title available will be available, the other fields will be disabled. If wanted change the visualization title.
4. Klikněte na tlačítko "Uložit".

Odebrání položky Domů:

1. Vyhledejte položku rozbalením skupin
2. Klikněte na tlačítko "Smazat" vedle názvu položky
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

To reorganize a Home item inside a group (New 2.4.2):

1. Vyhledejte položku rozbalením skupin
2. Click on the "Up" or "Down" arrow button next to the item's name
3. Keep clicking on the button until the item is in the wanted position
4. Klikněte na tlačítko "Uložit".

Odebrání skupiny Domů:

1. Vyhledejte konkrétní skupinu, kterou chcete odstranit
2. Klikněte na "Odstranit skupinu"
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

Všechny položky přidružené k této skupině budou smazány

Chcete-li resetovat všechny hodnoty:

1. Klikněte na "Obnovit všechny hodnoty na výchozí"
2. Klikněte na tlačítko "Uložit".

Program¶

Vizualizace programů se zobrazují na obrazovce vyhledávání (karta Analytika) v programech sledování nebo na obrazovce seznamu (karta Analytika) v programech událostí aplikace pro Android.

All items available are first created in the Data visualizer or Line Listing (v2.4) app in DHIS2 and configured in the Android Settings app.

Note:

Visualization items can be sourced either from the Data Visualizer or the Line Listing app.

When choosing a visualization type, the items shown automatically change; if "Data Visualization" is selected, only visualizations created in the Data Visualization app will be displayed.

When selecting "Event Visualization" (v2.4), only elements created in the Line Listing app will appear in the Visualization search box.

Chcete-li vytvořit položku Program:

1. Click on "Add Program Visualization" Button.
2. Choose a Visualization Type (v2.4).
3. Select a Program.
4. Klikněte na vyhledávací pole a vyberte vizualizaci ze seznamu nebo zadejte název položky vizualizace.
5. Přidejte alternativní název, jinak aplikace zobrazí název vizualizace
6. Ve výchozím nastavení aplikace povolí nastavení skupinové vizualizace.
7. Create a new group: A free text box will pop up to type the name or
8. Vyberte vytvořenou vizualizaci skupiny: Vyberte možnost ze seznamu pro přidání vizualizace nebo
9. Zakažte vizualizaci skupiny kliknutím na zaškrtávací políčko.
10. Klikněte na tlačítko "Uložit".

To edit the title of a Program item (v2.2.1):

1. Vyhledejte položku rozbalením skupin.
2. Click the "Edit" button next to the item's name.
3. A pop-up with only the visualization title available will be available, the other fields will be disabled. If wanted change the visualization title.
4. Klikněte na tlačítko "Uložit".

To remove a Program item:

1. Vyhledejte položku rozbalením programu a skupiny
2. Klikněte na tlačítko "Smazat" vedle názvu položky
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

To reorganize a Program item inside a group (New 2.4.2):

1. Search for the item by expanding the program and groups
2. Click on the "Up" or "Down" arrow button next to the item's name
3. Keep clicking on the button until the item is in the wanted position
4. Klikněte na tlačítko "Uložit".

To remove a Program group:

1. Vyhledejte v příslušném programu konkrétní skupinu, kterou chcete odstranit
2. Klikněte na "Odstranit skupinu"
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

Všechny položky přidružené k této skupině budou smazány

Chcete-li resetovat všechny hodnoty:

1. Klikněte na "Obnovit všechny hodnoty na výchozí"
2. Klikněte na tlačítko "Uložit".

Data Set¶

Vizualizace datové sady se zobrazují na obrazovce se seznamem (karta Analytics) v sadě dat aplikace pro Android.

Všechny dostupné položky se nejprve vytvoří v aplikaci Data Visualizer v DHIS2 a nakonfigurují se v aplikaci nastavení systému Android.

Chcete-li vytvořit položku Datová sada:

1. Klikněte na „Přidat vizualizaci datové sady“
2. Vyberte datovou sadu
3. Klikněte na vyhledávací pole a vyberte vizualizaci ze seznamu nebo zadejte název položky vizualizace.
4. Přidejte alternativní název, jinak aplikace zobrazí název vizualizace
5. Ve výchozím nastavení aplikace povolí nastavení skupinové vizualizace.
6. Create a new group: A free text box will pop up to type the name or
7. Vyberte vytvořenou vizualizaci skupiny: Vyberte možnost ze seznamu pro přidání vizualizace nebo
8. Zakažte vizualizaci skupiny kliknutím na zaškrtávací políčko.
9. Klikněte na tlačítko "Uložit".

To edit the title of a Data set item (v2.2.1):

1. Vyhledejte položku rozbalením skupin.
2. Click the "Edit" button next to the item's name.
3. A pop-up with only the visualization title available will be available, the other fields will be disabled. If wanted change the visualization title.
4. Klikněte na tlačítko "Uložit".

Odebrání položky Datová sada:

1. Vyhledejte položku rozbalením souboru dat a skupiny
2. Klikněte na tlačítko "Smazat" vedle názvu položky
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

To reorganize a Data Set item inside a group (New 2.4.2):

1. Search for the item by expanding the Data Set and groups
2. Click on the "Up" or "Down" arrow button next to the item's name
3. Keep clicking on the button until the item is in the wanted position
4. Klikněte na tlačítko "Uložit".

Odebrání skupiny Soubor dat:

1. Vyhledejte konkrétní skupinu, kterou chcete odstranit, v odpovídající sadě dat
2. Klikněte na "Odstranit skupinu"
3. Klikněte na "Smazat"
4. Klikněte na tlačítko "Uložit".

Všechny položky přidružené k této skupině budou smazány

Chcete-li resetovat všechny hodnoty:

1. Klikněte na "Obnovit všechny hodnoty na výchozí"
2. Klikněte na tlačítko "Uložit".

Visualization user test¶

Uživatelský test vizualizace je funkce dostupná v nastavení Home, Program a Data Set Analytic, která pomáhá administrátorovi určit, zda nějaký konkrétní uživatel uvidí vizualizaci.

Aplikace nastavení systému Android zkontroluje alespoň jedno z těchto tří oprávnění:

1. Vizualizace je veřejná
2. Uživatel má k vizualizaci individuální přístup
3. Uživatel je ve skupině, která má přístup k vizualizaci

Chcete-li spustit test:

1. Vyberte uživatele ze seznamu
2. Klikněte na "Spustit test"

Analytics Limitations¶

Since the aggregations and calculations displayed are calculated in the device, the implementation of analytics is limited compared to web.

In summary the compatible and supported objects and features for Data Visualizations are:

• Dobře tvarované analytické objekty (řady, kategorie, filtry)
• Use of relative periods (Fix periods are not supported)
• Uživatel má přístup k prohlížení
• Omezení pro kontingenční tabulky
• Number of header lines: 1 or 2 (v2.3)
• Počet sloupců záhlaví: 2
• Omezení pro grafy
• Počet sérií: Bez omezení (ale nezapomeňte, že vykreslujete na malé obrazovce)
• Počet kategorií (neplatí pro výsečový graf): Bez omezení

Na Android Analytics se vztahuje mnohem více omezení týkajících se mnoha možností konfigurace dostupných ve Web Visualizer a také podporovaných funkcí a výpočtů souvisejících s indikátory a indikátory programu. Tato tabulka shrnuje všechny podporované funkce.

In the same way, Event visualizations are considered valid if:

• Visualization was created using Line Listing app
• Visualization type is Line List
• Use of relative periods
• Limitations for Table
• Number of columns: 15

Note (v2.2.1)

When searching for a visualization to add as part of the Analytics visualizations, all visualizations will be listed, but visualizations that don't meet the above restrictions will be disabled.

Custom Intents¶

By configuring custom intents, administrators can enable the Android app to launch external applications, send data to them, and receive data back to populate fields automatically.

Adding a Custom Intent¶

To add a new Custom Intent:

1. Open the Android Settings Web App
2. Navigate to the Custom Intents section
3. Click on Add Custom Intent
4. Fill in the configuration parameters as described below

Configuration Parameters¶

Basic Information¶

Intent Name

A unique, descriptive name for the custom intent. This name helps identify the intent in the configuration interface.

Intent Description

A detailed description of what the custom intent does and which third-party app it integrates with. This helps other administrators understand the purpose of the intent.

Element Binding¶

Element Type

Specifies where the custom intent will be attached. Options include:

• Tracked Entity Attribute: Links the intent to a specific tracked entity attribute
• Data Element: Links the intent to a specific data element

Attribute/Data Element

Select the specific tracked entity attribute or data element that will trigger the custom intent. When a custom intent is configured for a field, users must use the third-party application to enter or search data for that field. Manual data entry will not be available.

Note

Only Data Elements or Tracked Entity Attributes with TEXT or LONG_TEXT value types are currently supported for custom intents.

Screen/Action

Defines where in the Android app the custom intent will be triggered. Available options:

• SEARCH: The intent will be available during search operations, allowing users to search for tracked entity instances using data from external apps
• DATA_ENTRY: The intent will be available during data entry, allowing users to populate fields with data from external apps

Third-Party Application¶

Package Name

The complete package name and action of the third-party Android application to launch. This should include both the package identifier and the specific action.

Format: com.apppackageName.id.CAPTURE

Example: com.google.zxing.client.android.SCAN for a barcode scanner app

Important

The third-party application must be installed on the Android device for the custom intent to work. If the app is not installed, users will receive an error message when attempting to trigger the intent.

Request Configuration¶

The Request section defines the parameters that will be sent to the third-party application when the intent is launched. This allows you to customize the behavior of the external app based on your requirements.

Request Parameters¶

Request Parameters

A list of key-value pairs that will be sent as extras to the third-party application's intent. Each parameter consists of:

• Key: The parameter name expected by the third-party application
• Value: The parameter value to send

The "value" parameter is an expression that allows the assignment of dynamic values if needed.

It has support for the d2-functions used in program rules and some suppport for variables. The supported variables are:

The identifier for those variables is the prefix VAR. For example, you might have a value like:

VAR(orgunit_id)

d2:condition('OU_', VAR{orgunit_id}) // Resulting in something like 'OU_DiszpKrYNg8'

Note

Request parameters are type-safe. Follow these formatting rules: - Strings: Must be surrounded by single quotes (e.g., 'QRCODE', 'portrait') - Integers: No quotes needed (e.g., 100, 640) - Floats: No quotes needed (e.g., 3.14, 2.5) - Booleans: No quotes needed (e.g., true, false) - Expressions: No quotes needed (e.g., VAR{orgunit_id})

Example Request Parameters:

Response Configuration¶

The Response section defines how to extract and process data returned from the third-party application. This determines which value will be populated in the linked tracked entity attribute or data element.

Response Parameters¶

Extra Name

The exact name of the extra field in the intent returned by the third-party application. This is the key used by the external app to send data back to DHIS2.

Example: SCAN_RESULT, LATITUDE, BARCODE_VALUE

Extra Type

The data type of the returned value. Available options:

• String: Plain text value
• Integer: Whole number value
• Float: Decimal number value
• Boolean: True/false value
• JSON Object: A single JSON object
• List of JSON Objects: An array of JSON objects

Property in JSON Object

Only applicable when Extra Type is "JSON Object" or "List of JSON Objects"

Specifies the property name to extract from the JSON object(s). This should be a direct property of the JSON object.

Example: value, latitude, name

Note

• Only direct properties are supported. Nested properties (e.g., location.coordinates.latitude) are not currently supported.
• Array indexing (e.g., results[0].name) is not currently supported.
• When using List of JSON Objects as the Extra Type:
• For SEARCH: The specified property will be extracted from all objects in the list, allowing users to search for tracked entity instances that match any value in the list.
• For DATA_ENTRY: The values will be extracted from all objects and concatenated into a single string separated by commas (e.g., value1,value2,value3).

Use Cases and Examples¶

Example 1: Barcode Scanner Integration¶

This example shows how to integrate a barcode scanner app to populate a patient ID field.

Configuration: - Intent Name: Barcode Scanner for Patient ID - Intent Description: Scans patient ID barcodes using ZXing scanner - Element Type: Tracked Entity Attribute - Attribute: Patient ID - Screen/Action: DATA_ENTRY - Package Name: com.google.zxing.client.android.SCAN

Request Parameters: | Key | Value | |-----|-------| | SCAN_MODE | 'QR_CODE_MODE' | | PROMPT_MESSAGE | 'Scan patient ID barcode' |

Response: - Extra Name: SCAN_RESULT - Extra Type: String - Property in JSON Object: (leave empty for string type)

Example 2: GPS Coordinates Integration¶

This example demonstrates capturing GPS coordinates accuracy from a mapping application that returns JSON data.

Configuration: - Intent Name: GPS Location Capture - Intent Description: Captures GPS coordinates from mapping app - Element Type: Data Element - Data Element: Household Location - Screen/Action: DATA_ENTRY - Package Name: com.example.gpsapp.CAPTURE_LOCATION

Request Parameters: | Key | Value | |-----|-------| | ACCURACY | 'HIGH' | | TIMEOUT | 60000 |

Response: - Extra Name: LOCATION_DATA - Extra Type: JSON Object - Property in JSON Object: accuracy

Example JSON response:

{
  "coordinates": {
    "latitude": -1.2921,
    "longitude": 36.8219
  },
  "accuracy": 5.0,
  "timestamp": "2025-11-03T10:30:00Z"
}

Example 3: Custom Data Collection Tool¶

This example shows integration with a custom medical device app that returns multiple measurements in a JSON array.

Configuration: - Intent Name: Blood Pressure Monitor - Intent Description: Captures blood pressure from external monitor device - Element Type: Data Element - Data Element: Systolic Pressure - Screen/Action: DATA_ENTRY - Package Name: com.medical.bpmonitor.MEASURE

Request Parameters: | Key | Value | |-----|-------| | MEASUREMENT_TYPE | 'BLOOD_PRESSURE' | | UNIT | 'mmHg' |

Response: - Extra Name: MEASUREMENTS - Extra Type: List of JSON Objects - Property in JSON Object: systolic

Example JSON response:

[
  {
    "systolic": 120,
    "diastolic": 80,
    "pulse": 72,
    "timestamp": "2025-11-03T10:30:00Z"
  }
]

Limitations and Considerations¶

Third-Party App Requirements¶

• The third-party application must be installed on all Android devices that will use the custom intent
• The third-party app must support Android Intent-based communication
• The package name and action must be correctly configured and match the third-party app's implementation

Data Type Compatibility¶

• The Extra Type configured in the response must match the actual data type returned by the third-party application
• The tracked entity attribute or data element value type should be compatible with the returned data
• Type mismatches may result in errors or unexpected behavior

Device Compatibility¶

• Custom Intents rely on Android's Intent system and are only available on Android devices
• Some third-party apps may have specific Android version requirements
• Testing should be performed on all target device models

Security Considerations¶

Warning

When configuring custom intents that integrate with third-party applications, consider the following security implications: - Data sent to third-party apps may be stored or transmitted according to the third-party app's privacy policy - Ensure third-party applications are from trusted sources - Review the permissions requested by third-party applications - Sensitive health data should only be shared with certified and compliant applications - Consider implementing Mobile Device Management (MDM) to control which apps can be installed

Network and Offline Behavior¶

• Custom intents work in offline mode as long as the third-party app is installed and doesn't require network connectivity
• Some third-party apps may require internet access to function properly
• Ensure the solution works in the expected connectivity scenarios for your deployment

Troubleshooting¶

Common Issues¶

Issue: Custom intent button doesn't appear - Verify that the custom intent is correctly configured in the Android Settings Web App - Check that the device has synchronized the latest configuration - Ensure you're viewing the correct tracked entity attribute or data element

Issue: "Application not found" error - The third-party application is not installed on the device - The package name is incorrectly configured - The third-party app doesn't support the specified action

Issue: No data is returned - Verify the Extra Name matches the key used by the third-party app - Check that the Extra Type is correct - Review the third-party app's documentation for the expected response format

Issue: Wrong value is populated - Verify the Property in JSON Object path is correct - Check that the JSON structure matches the expected format - Ensure the Extra Type matches the actual returned data type

Issue: App crashes when launching intent - Review the request parameters for syntax errors (e.g., missing quotes for strings) - Verify the third-party app supports the configured parameters - Check Android logs for detailed error messages

Testing Custom Intents¶

Before deploying custom intents to production:

1. Test with a small group of users on various device models
2. Verify the third-party app is available and properly licensed
3. Test both online and offline scenarios
4. Verify data validation rules are applied to returned values
5. Test error handling when the third-party app is not installed
6. Document the configuration and user instructions

Note

Consider creating a test program or data set specifically for testing custom intent configurations before deploying to production programs.

Best Practices¶

1. Clear Naming: Use descriptive intent names that clearly indicate the purpose and third-party app being used

2. Documentation: Maintain documentation of all configured custom intents, including the required third-party apps and their versions

3. User Training: Provide clear instructions to users on how to use custom intents and what to expect. Ensure users understand that manual data entry will not be available for fields with custom intents configured.

4. App Distribution: Use Mobile Device Management (MDM) to ensure third-party apps are properly installed and updated on all devices

5. Testing: Thoroughly test custom intents in a non-production environment before deployment

6. Validation: Implement appropriate validation rules on fields that use custom intents to ensure data quality

7. Reliability: Ensure the third-party application is stable and reliable, as it will be the only way to populate the configured field. Have a contingency plan if the third-party app becomes unavailable.

8. Version Control: Keep track of third-party app versions and test compatibility when apps are updated

9. Privacy Compliance: Ensure custom intent configurations comply with data privacy regulations (GDPR, HIPAA, etc.)

Instalace¶

Uživatel si může snadno nainstalovat webovou aplikaci pro nastavení systému Android, když se přihlásí k serveru DHIS2 a přejde do části Správa aplikací.

• Klikněte na App Hub
• Go to Android Settings App
• Click on Install V2.X.X

Přihlaste se a poprvé nastavte¶

After a user installs and launches the Android Settings Web App for the first time, the web app will require setting and saving the default values of the configuration. This will apply default settings to all android devices connected to the instance.

Upozornění

Uvědomte si, že předchozí verze jsou zastaralé, takže začnete s novou výchozí konfigurací.

Warning (v2.3)

When using DHIS2 version equal to or higher to 2.40, only users with "M_androidsettingsapp" or "ALL" authority can save or update the configuration, but any user will have view access once it is created.

Zadejte a uložte konfigurační parametry¶

Datové úložiště¶

Internally all settings are stored in Datastore in JSON format.

Struktura datového úložiště:

Uložte konfigurační parametry¶

At the form footer of all settings sections, admin users can find a Save button.

Only when an admin user clicks on this button, all changes made on the current section are saved on the Datastore. These changes will apply to the Android Capture App when they synchronize their configuration.

Unsaved changes

In case an admin user wants to go to another section when there are still some unsaved changes, an alert will be displayed before navigating away from the current section. In case the user accepts leaving the page, the unsaved changes will be lost.

Obnovte všechny hodnoty na výchozí¶

An admin user can restore the settings at any time. There is a Reset all values to default button at the form footer of all settings sections.

Výchozí hodnoty budou obnoveny pouze na Datastore a použity po kliknutí na Uložit.

Uninstall the app¶

In case of needing to uninstall the Android Settings App it is recommended to also delete all the data from the reserved datastore namespace.

Delete data¶

• Go to General section
• Click on Disable all settings
• A modal will pop up, click on Disable

Uninstall app¶

• Go to App Management
• Click on Custom Apps
• Go to Android Settings App
• Click on Uninstall V2.X.X

Warning

This is a critical action, be aware that by doing this, all previous configurations will be permanently deleted.

App Compatibility¶

A label is displayed to indicate the minimum Android app version required to use specific features or functionalities. This ensures that users are informed about compatibility requirements and can update their app if necessary to meet the minimum version.

For example, if a feature requires Android app version 2.9 or higher, the label will show the required version clearly for the user.

This table summarises all supported features and the compatibility of them with the Android Capture app.