feat: load tracked entities from tracker analytics [DHIS2-16362]

cypress/integration/layers/trackedentitylayer.cy.js

@@ -49,6 +49,7 @@ describe('Tracked Entity Layers', () => {
         Layer.selectTab('Period')
             .typeStartDate('2018-00-00')
             .selectTab('Org Units')
+            .unselectOu('Sierra Leone')
             .openOu('Bo')
             .openOu('Badjia')
             .selectOu('Njandama MCHP')

cypress/integration/requests.cy.js

@@ -200,7 +200,7 @@ describe('API requests check for all layer types', () => {
                 // -- apiFetch - src/util/api.js
                 // -- @dhis2/d2 - src/api/Api.js
                 'getTrackedEntities40_TrackedEntities1',
-                // -- teiRelationshipsParser - src/util/teiRelationshipsParser.js
+                // -- trackedEntityRelationships - src/util/trackedEntityRelationships.js
                 // -- apiFetch - src/util/api.js
                 // -- @dhis2/d2 - src/api/Api.js
                 // TODO: Should this be only TEIs within the same timeframe?
@@ -213,7 +213,7 @@ describe('API requests check for all layer types', () => {
                 // -- apiFetch - src/util/api.js
                 // -- @dhis2/d2 - src/api/Api.js
                 'getTrackedEntities41_TrackedEntities1',
-                // -- teiRelationshipsParser - src/util/teiRelationshipsParser.js
+                // -- trackedEntityRelationships - src/util/trackedEntityRelationships.js
                 // -- apiFetch - src/util/api.js
                 // -- @dhis2/d2 - src/api/Api.js
                 // TODO: Should this be only TEIs within the same timeframe?

i18n/en.pot

@@ -5,8 +5,8 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2026-09-01T12:42:29.454Z\n"
-"PO-Revision-Date: 2026-09-01T12:42:29.454Z\n"
+"POT-Creation-Date: 2026-10-05T12:46:47.530Z\n"
+"PO-Revision-Date: 2026-10-05T12:46:47.531Z\n"
 
 msgid "2020"
 msgstr "2020"
@@ -1885,6 +1885,9 @@ msgstr "related"
 msgid "Tracked entity"
 msgstr "Tracked entity"
 
+msgid "Displaying first {{pageSize}} tracked entities"
+msgstr "Displaying first {{pageSize}} tracked entities"
+
 msgid "not one of"
 msgstr "not one of"
 

package.json

@@ -59,6 +59,7 @@
         "@turf/centroid": "^7.4.0",
         "abortcontroller-polyfill": "^1.7.8",
         "array-move": "^4.0.0",
+        "betterknown": "^1.2.0",
         "classnames": "^2.5.1",
         "d3-array": "^3.2.4",
         "d3-axis": "^3.0.0",

src/components/orgunits/OrgUnitSelectMode.jsx

@@ -1,28 +1,36 @@
+import { useConfig } from '@dhis2/app-runtime'
 import i18n from '@dhis2/d2-i18n'
 import React, { useMemo } from 'react'
 import { useSelector, useDispatch } from 'react-redux'
 import { setOrgUnitMode } from '../../actions/layerEdit.js'
+import {
+    ORG_UNIT_MODE_CHILDREN,
+    ORG_UNIT_MODE_DESCENDANTS,
+    ORG_UNIT_MODE_SELECTED,
+} from '../../constants/orgUnits.js'
+import { getTrackedEntityDefaultOrgUnitMode } from '../../util/trackedEntity.js'
 import { SelectField } from '../core/index.js'
 import styles from './styles/OrgUnitSelectMode.module.css'
 
 const OrgUnitSelectMode = () => {
     const organisationUnitSelectionMode = useSelector(
         (state) => state.layerEdit.organisationUnitSelectionMode
     )
+    const { serverVersion } = useConfig()
     const dispatch = useDispatch()
 
     const items = useMemo(
         () => [
             {
-                id: 'SELECTED',
+                id: ORG_UNIT_MODE_SELECTED,
                 name: i18n.t('Selected only'),
             },
             {
-                id: 'CHILDREN',
+                id: ORG_UNIT_MODE_CHILDREN,
                 name: i18n.t('Selected and below'),
             },
             {
-                id: 'DESCENDANTS',
+                id: ORG_UNIT_MODE_DESCENDANTS,
                 name: i18n.t('Selected and all below'),
             },
         ],
@@ -34,7 +42,10 @@ const OrgUnitSelectMode = () => {
             <SelectField
                 prefix={i18n.t('Selection mode')}
                 items={items}
-                value={organisationUnitSelectionMode || 'SELECTED'}
+                value={
+                    organisationUnitSelectionMode ||
+                    getTrackedEntityDefaultOrgUnitMode(serverVersion)
+                }
                 onChange={(mode) => dispatch(setOrgUnitMode(mode.id))}
                 className={styles.selectField}
             />

src/components/plugin/LayerLoader.jsx

@@ -29,7 +29,11 @@ const LayerLoader = ({ config, onLoad }) => {
     const engine = useDataEngine()
     const [analyticsEngine] = useState(() => Analytics.getAnalytics(engine))
     const {
-        systemSettings: { keyAnalysisDigitGroupSeparator },
+        systemSettings: {
+            keyAnalysisDigitGroupSeparator,
+            KeyTrackedEntityInstanceMaxLimit,
+            KeyTrackedEntityMaxLimit,
+        },
         currentUser,
     } = useCachedData()
     const {
@@ -62,9 +66,11 @@ const LayerLoader = ({ config, onLoad }) => {
             userId,
             userOrgUnitIdsByKeyword, // Event loader
             baseUrl,
-            analyticsEngine, // Thematic and Event loader
+            analyticsEngine, // Thematic, Event and Tracked entity loader
             periodTypeData, // Thematic and Event loader
             serverVersion, // Tracked entity loader
+            KeyTrackedEntityInstanceMaxLimit, // Tracked entity loader (2.40)
+            KeyTrackedEntityMaxLimit, // Tracked entity loader
         }).then((result) => {
             onLoad(result)
         })
@@ -80,6 +86,8 @@ const LayerLoader = ({ config, onLoad }) => {
         keyAnalysisDisplayProperty,
         keyAnalysisDigitGroupSeparator,
         serverVersion,
+        KeyTrackedEntityInstanceMaxLimit,
+        KeyTrackedEntityMaxLimit,
     ])
 
     return null

src/constants/layers.js

@@ -128,6 +128,7 @@ export const TEI_BUFFER = 100
 export const TEI_RELATED_COLOR = '#000000'
 export const TEI_RELATED_RADIUS = 3
 export const TEI_RELATIONSHIP_LINE_COLOR = '#0000BB'
+export const TEI_CLIENT_PAGE_SIZE = 50000
 
 /* FACILITY LAYER */
 export const FACILITY_BUFFER = 5000

src/constants/orgUnits.js

@@ -0,0 +1,4 @@
+// Org unit selection modes (ouMode / orgUnitMode API params)
+export const ORG_UNIT_MODE_SELECTED = 'SELECTED'
+export const ORG_UNIT_MODE_CHILDREN = 'CHILDREN'
+export const ORG_UNIT_MODE_DESCENDANTS = 'DESCENDANTS'

src/constants/settings.js

@@ -21,6 +21,9 @@ export const SYSTEM_SETTINGS = [
     'keyHideMonthlyPeriods',
     'keyHideBiMonthlyPeriods',
     'keyDefaultBaseMap',
+    // Tracker API limit, 2.40 and 2.41+ names: see getTrackerMaxLimit
+    'KeyTrackedEntityInstanceMaxLimit',
+    'KeyTrackedEntityMaxLimit',
     ...Object.keys(MAP_SERVICE_KEY_TESTS),
 ]
 

src/hooks/useLayersLoader.js

@@ -32,7 +32,11 @@ export const useLayersLoader = () => {
     const engine = useDataEngine()
     const [analyticsEngine] = useState(() => Analytics.getAnalytics(engine))
     const {
-        systemSettings: { keyAnalysisDigitGroupSeparator },
+        systemSettings: {
+            keyAnalysisDigitGroupSeparator,
+            KeyTrackedEntityInstanceMaxLimit,
+            KeyTrackedEntityMaxLimit,
+        },
         currentUser,
     } = useCachedData()
     const { showAlerts } = useLoaderAlerts()
@@ -61,9 +65,11 @@ export const useLayersLoader = () => {
                 userId,
                 userOrgUnitIdsByKeyword, // Event loader
                 baseUrl,
-                analyticsEngine, // Thematic and Event loader
+                analyticsEngine, // Thematic, Event and Tracked entity loader
                 periodTypeData, // Thematic and Event loader
                 serverVersion, // Tracked entity loader
+                KeyTrackedEntityInstanceMaxLimit, // Tracked entity loader (2.40)
+                KeyTrackedEntityMaxLimit, // Tracked entity loader
                 loadExtended: !!dataTable, // Event loader
             })
             if (result.alerts) {
@@ -128,5 +134,7 @@ export const useLayersLoader = () => {
         baseUrl,
         dataTable,
         serverVersion,
+        KeyTrackedEntityInstanceMaxLimit,
+        KeyTrackedEntityMaxLimit,
     ])
 }