https://github.com/dhis2/integration-t2a
A Tracker-to-Aggregate tool to improve the performance of program indicators
https://github.com/dhis2/integration-t2a
integration
Last synced: 4 months ago
JSON representation
A Tracker-to-Aggregate tool to improve the performance of program indicators
- Host: GitHub
- URL: https://github.com/dhis2/integration-t2a
- Owner: dhis2
- License: bsd-3-clause
- Created: 2022-01-12T11:10:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-06T14:38:18.000Z (about 1 year ago)
- Last Synced: 2025-09-06T10:34:38.205Z (10 months ago)
- Topics: integration
- Language: Java
- Homepage:
- Size: 337 KB
- Stars: 3
- Watchers: 10
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tracker-to-Aggregate
[Tracker-to-Aggregate](https://docs.dhis2.org/en/implement/maintenance-and-use/tracker-and-aggregate-data-integration.html#how-to-saving-aggregated-tracker-data-as-aggregate-data-values) (T2A) is a Java application that periodically aggregates and collects aggregate program indicators (PIs) from the DHIS2 server before pushing them back to the server as data values sets. T2A is a tool for DHIS2 administrators, designed to reduce the load of analytic operations on the DHIS2 server since requests for pre-aggregated data is often less demanding than on-the-fly aggregation of tracker data.
## Requirements
* Java 11
## Getting Started
### *nix Usage Example
```shell
./dhis2-t2a.jar --dhis2.api.url=https://play.dhis2.org/2.38.0/api --dhis2.api.pat=d2pat_apheulkR1x7ac8vr9vcxrFkXlgeRiFc94200032556 --org.unit.level=3 --periods=2022Q1,2022Q2,2022Q3,2022Q4 --pi.group.id=Lesc1szBJGe
```
### Windows Usage Example
```shell
java -jar dhis2-t2a.jar --dhis2.api.url=https://play.dhis2.org/2.38.0/api --dhis2.api.pat=d2pat_apheulkR1x7ac8vr9vcxrFkXlgeRiFc94200032556 --org.unit.level=3 --periods=2022Q1,2022Q2,2022Q3,2022Q4 --pi.group.id=Lesc1szBJGe
```
### Config
By order of precedence, a config property can be specified:
1. as a command-line argument (e.g., `--dhis2.api.username=admin`)
2. as an OS environment variable (e.g., `export DHIS2_API_USERNAME=admin`)
3. in a key/value property file called `application.properties` or a YAML file named `application.yml`
| Config Key | Description | Default Value | Example Value |
|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|----------------------------------------------------|
| `analytics.last.years` | Number of years to include when generating analytics. | `1` | `10` |
| `aggr.data.export.attr.id` | ID of the program indicator attribute referencing the data element that captures the aggregate program indicator data value. | `vudyDP7jUy5` | `nIqQZeSwU9E` |
| `dhis2.api.url` | DHIS2 server Web API URL. | | `https://play.dhis2.org/2.38.0/api` |
| `dhis2.api.pat` | Personal access token to authenticate with. This property is mutually exclusive to `dhis2.api.username` and `dhis2.api.password`. | | `d2pat_apheulkR1x7ac8vr9vcxrFkXlgeRiFc94200032556` |
| `dhis2.api.username` | Username of the DHIS2 user to run as. | | `admin` |
| `dhis2.api.password` | Password of the DHIS2 user to run as. | | `district` |
| `http.endpoint.uri` | HTTP address the application will bind to for accepting POST requests that will kick off application execution. The HTTP request is processed asynchronously allowing the application to return immediately an HTTP 204 response while the request is being processed in the background. | `http://localhost:8081/dhis2/t2a` | `http://0.0.0.0:8080/` |
| `org.unit.batch.size` | Number of organisation units to process at once when retrieving analytics. It is computationally more expensive for the DHIS2 server to process organisation units in larger batches. | `1` | `10` |
| `org.unit.level` | Level of the organisation units to retrieve analytics for. | | `3` |
| `periods` | [ISO or relative period/s](https://docs.dhis2.org/en/develop/using-the-api/dhis-core-version-master/introduction.html#webapi_date_perid_format) to retrieve analytics for. Multiple periods are comma delimited. | | `2022Q1,2022Q2,2022Q3,2022Q4` |
| `pi.group.id` | Program indicator group ID of the program indicators to retrieve analytics for. | | `Lesc1szBJGe` |
| `run.event.analytics` | Whether to generate event analytics before retrieving them. | `true` | `false` |
| `thread.pool.size` | Maximum no. of threads for processing analytics data. More threads might reduce execution time when `org.unit.batch.size` is less than the total no. of organisation units or `split.periods` is `true` but can also lead to more load on the DHIS2 server. | `1` | `3` |
| `schedule.expression` | Cron expression for triggering the execution of the application. By default, execution is kicked off at midnight every day. | `0 0 0 * * ?` | `0 0 12 * * ?` |
| `split.periods` | Whether to process periods individually when retrieving analytics. It is computationally more expensive for the DHIS2 server to process periods in batches (i.e., `split.periods=false`). | `true` | `false` |