Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/developer/web-api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ by making a GET request to the `/api/relativePeriods/{RELATIVE_PERIOD_KEYWORD}`

The endpoint supports the following parameters:
- `startDate`: Represents the start date to calculate the relative period from. Format: `yyyy-MM-dd`. Default is today if not provided.
- `financialYearStart`: Should be one of FINANCIAL_YEAR_APRIL, FINANCIAL_YEAR_JULY, FINANCIAL_YEAR_OCTOBER. Default is FINANCIAL_YEAR_OCTOBER if not provided.
- `financialYearStart`: Should be one of FINANCIAL_YEAR_FEBRUARY, FINANCIAL_YEAR_APRIL, FINANCIAL_YEAR_JULY, FINANCIAL_YEAR_AUGUST, FINANCIAL_YEAR_SEPTEMBER, FINANCIAL_YEAR_OCTOBER. Default is FINANCIAL_YEAR_OCTOBER if not provided.


As an example, to get the ISO representation of the relative period `LAST_3_MONTHS`
Expand Down
6 changes: 2 additions & 4 deletions src/developer/web-api/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ A number of authentication modes are supported when running routes. These authen
}
}
```
Note that this request configures the route with static headers so that these headers are included in the request sent from DHIS2. Keep in mind that DHIS2 does not store these static headers as encrypted.
Note that this request configures the route with static headers so that these headers are included in the request sent from DHIS2. Keep in mind that DHIS2 does not store these static headers as encrypted.

* `api-headers`: adds user-defined headers for API authentication. Here is an example creating a route configured with `api-headers` authentication:

Expand Down Expand Up @@ -182,7 +182,7 @@ For performance reasons, the maximum transfer time for a route response is 5 min
}
```

The minimum permitted response timeout is 1 second while the maximum permitted timeout is 60 seconds. The `responseTimeoutSeconds` setting should be used with caution since concurrent, long-running routes could degrade DHIS2's overall performance.
The minimum permitted response timeout is 1 second while the maximum permitted timeout is 60 seconds. The `responseTimeoutSeconds` setting should be used with caution since concurrent, long-running routes could degrade DHIS2's overall performance.

>IMPORTANT: The response timeout can be customised starting from DHIS2 v40.10 and v41.6. Earlier DHIS2 versions have a response timeout of 10 seconds, except for:
>* 40.8 ≤ v < 40.10
Expand Down Expand Up @@ -223,5 +223,3 @@ The [Route Manager app](https://apps.dhis2.org/app/5dbe9ab8-46bd-411e-b22f-905f0
![Routes Manager app](./resources/images/route-manager/route-manager-list.png)

Visit the [DHIS2 system maintenance guide](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/maintaining-the-system/route-manager.html) to learn more about using Route Manager.


2 changes: 1 addition & 1 deletion src/developer/web-api/scheduling.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Table: `ANALYTICS_TABLE` job parameters

| Name | Type | Default | Description |
|---------------|---------------|---------|--------------------------------------------------|
| `lastYears` | int | empty | Number of years back to include. No value means all years. |
| `lastYears` | int | empty | Number of years back to include. No value means all years. |
| `skipTableTypes` | array of enum | `[]` | Skip generation of tables; Possible values: `DATA_VALUE`, `COMPLETENESS`, `COMPLETENESS_TARGET`, `ORG_UNIT_TARGET`, `EVENT`, `ENROLLMENT`, `VALIDATION_RESULT` |
| `skipResourceTables` | boolean | `false` | Skip generation of resource tables |
| `skipPrograms` | array of string | `[]` | Optional list of programs (IDs) that should be skipped |
Expand Down
3 changes: 2 additions & 1 deletion src/developer/web-api/settings-and-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ Table: System settings
| keyCustomTopMenuLogo | Logo for custom top menu | No |
| globalShellEnabled | When this property is enabled (set to true), apps will be displayed as iframes within a global shell. This global shell provides a consistent header bar across the system which has expanded functionalities compared to the original header bar. Default: true. | No |
| keyCacheAnalyticsDataYearThreshold | Analytics data older than this value (in years) will always be cached. "0" disabled this setting. Default: 0 | No |
| analyticsFinancialYearStart | Set financial year start. Default: October | No |
| analyticsFinancialYearStart | Set financial year start. Options: FINANCIAL_YEAR_FEBRUARY, FINANCIAL_YEAR_APRIL, FINANCIAL_YEAR_JULY, INANCIAL_YEAR_AUGUST, FINANCIAL_YEAR_SEPTEMBER, FINANCIAL_YEAR_OCTOBER. Default: FINANCIAL_YEAR_OCTOBER | No |
| analyticsWeeklyStart | Set weekly relative period start day. Options: WEEKLY (Monday), WEEKLY_WEDNESDAY, WEEKLY_THURSDAY, WEEKLY_FRIDAY, WEEKLY_SATURDAY, WEEKLY_SUNDAY. Default: WEEKLY (Monday) | No |
| keyIgnoreAnalyticsApprovalYearThreshold | "0" check approval for all data. "-1" disable approval checking. "1" or higher checks approval for all data that is newer than "1" year. | No |
| keyAnalyticsMaxLimit | Maximum number of analytics records. Default: "50000" | No |
| KeyTrackedEntityMaxLimit | Maximum number of tracked entities that are returned by `/tracker/trackedEntities`. More info [here](tracker.md#tracked-entities-collection-limits). Default: "50000" | No |
Expand Down
32 changes: 23 additions & 9 deletions src/developer/web-api/tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The table below will point out any exceptional cases between these two.
| event | The identifier of the event. Generated if not supplied. | No | Yes | String:Uid | ABCDEF12345 |
| programStage | The program stage the event represents. | Yes | No | String:Uid | ABCDEF12345 |
| enrollment | A reference to the enrollment which owns the event. Not applicable for `EVENT PROGRAM`. | Yes | Yes | String:Uid | ABCDEF12345 |
| program | The program that contains the event. | No | Yes | String:Uid | ABCDEF12345 |
| program | Only for reading data. The type of program the enrollment which owns the event has. | No | Yes | String:Uid | ABCDEF12345 |
| trackedEntity | Only for reading data. The tracked entity which owns the event. Not applicable for `EVENT PROGRAM`. | No | No | String:Uid | ABCDEF12345 |
| status | Status of the event. Default is `ACTIVE`. For `EVENT PROGRAM` only `ACTIVE` and `COMPLETED` statuses are allowed. | No | No | Enum | ACTIVE, COMPLETED, VISITED, SCHEDULE, OVERDUE, SKIPPED |
| orgUnit | The organisation unit where the user registered the event. | Yes | No | String:Uid | ABCDEF12345 |
Expand Down Expand Up @@ -3153,18 +3153,18 @@ Table: Entity query criteria definition

| Property | Description | Example |
| --- |---|---|
|attributeValueFilters|A list of attributeValueFilters. This is used to specify filters for attribute values when listing tracked entities|`"attributeValueFilters"=[{"attribute": "abcAttributeUid","le": "20","ge": "10","lt": "20","gt": "10","in": ["India", "Norway"],"like": "abc","sw": "abc","ew": "abc","dateFilter": {"startDate": "2014-05-01","endDate": "2019-03-20","startBuffer": -5,"endBuffer": 5,"period": "LAST_WEEK","type": "RELATIVE"}}]`|
|enrollmentStatus|The tracked entities enrollment status. Can be none(any enrollmentstatus) or ACTIVE, COMPLETED, CANCELLED||
|attributeValueFilters|A list of attributeValueFilters. This is used to specify filters for attribute values when listing tracked entities|`"attributeValueFilters":[{"attribute": "abcAttributeUid","le": "20","ge": "10","lt": "20","gt": "10","in": ["India", "Norway"],"like": "abc","sw": "abc","ew": "abc","dateFilter": {"startDate": "2014-05-01","endDate": "2019-03-20","startBuffer": -5,"endBuffer": 5,"period": "LAST_WEEK","type": "RELATIVE"}}]`|
|enrollmentStatus|The tracked entities enrollment status. Can be none(any enrollmentstatus) or `ACTIVE`, `COMPLETED`, `CANCELLED`||
|followUp|When this parameter is true, the working list only returns tracked entities that have an enrollment with `followUp=true`.||
|organisationUnit|To specify the uid of the organisation unit|`{"organisationUnit": "a3kGcGDCuk7"}`|
|ouMode|To specify the organisation unit selection mode. Options are `SELECTED`, `CHILDREN`, `DESCENDANTS`, `ACCESSIBLE`, `CAPTURE`, `ALL`|`"ouMode": "SELECTED"`|
|assignedUserMode|To specify the assigned user selection mode for events. Options are CURRENT, PROVIDED, NONE , ANY. See table below to understand what each value indicates. If `PROVIDED` (or null), non-empty assignedUsers in the payload will be considered.|"assignedUserMode": "PROVIDED"|
|assignedUsers|To specify a list of assigned users for events. To be used along with PROVIDED assignedUserMode above.|`"assignedUsers": ["a3kGcGDCuk7", "a3kGcGDCuk8"]`|
|assignedUserMode|To specify the assigned user selection mode for events. Options are `CURRENT`, `PROVIDED`, `NONE`, `ANY`. See table below to understand what each value indicates. If `PROVIDED` (or null), non-empty assignedUsers in the payload will be considered.|`"assignedUserMode": "PROVIDED"`|
|assignedUsers|To specify a list of assigned users for events. To be used along with `PROVIDED` assignedUserMode above.|`"assignedUsers": ["a3kGcGDCuk7", "a3kGcGDCuk8"]`|
|displayColumnOrder|To specify the output ordering of columns|`"displayOrderColumns": ["enrollmentDate", "program"]`|
|order|To specify ordering/sorting of fields and its directions in comma separated values. A single item in order is of the form "orderDimension:direction". Note: Supported orderDimensions are trackedEntity, created, createdAt, createdAtClient, updatedAt, updatedAtClient, enrolledAt, inactive and the tracked entity attributes|`"order"="a3kGcGDCuk6:desc"`|
|programStage|To specify a programStage uid to filter on. tracked entities will be filtered based on presence of enrollment in the specified program stage.|`"programStage"="a3kGcGDCuk6"`|
|trackedEntityType|To specify a trackedEntityType filter tracked entities on.|`{"trackedEntityType"="a3kGcGDCuk6"}`|
|trackedEntities|To specify a list of tracked entities to use when querying tracked entities.|`"trackedEntities"=["a3kGcGDCuk6","b4jGcGDCuk7"]`|
|order|To specify ordering/sorting of fields and its directions in comma separated values. A single item in order is of the form "orderDimension:direction". Note: Supported orderDimensions are trackedEntity, created, createdAt, createdAtClient, updatedAt, updatedAtClient, enrolledAt, inactive and the tracked entity attributes|`"order":"a3kGcGDCuk6:desc"`|
|programStage|To specify a programStage uid to filter on. tracked entities will be filtered based on presence of enrollment in the specified program stage.|`"programStage":"a3kGcGDCuk6"`|
|trackedEntityType|To specify a trackedEntityType filter tracked entities on.|`{"trackedEntityType":"a3kGcGDCuk6"}`|
|trackedEntities|To specify a list of tracked entities to use when querying tracked entities.|`"trackedEntities":["a3kGcGDCuk6","b4jGcGDCuk7"]`|
|enrollmentCreatedDate|[DateFilterPeriod](#webapi_tracker_workinglists_common_objects) object date filtering based on enrollment created date.|`"enrollmentCreatedDate": { "period": "LAST_WEEK", "type": "RELATIVE" }`|
|enrollmentIncidentDate|[DateFilterPeriod](#webapi_tracker_workinglists_common_objects) object date filtering based on enrollment incident date.|`"enrollmentIncidentDate": { "startDate": "2014-05-01", "endDate": "2019-03-20", "startBuffer": -5, "endBuffer": 5, "period": "LAST_WEEK", "type": "RELATIVE" }`|
|eventStatus|The event status. Options are `ACTIVE`, `COMPLETED`, `VISITED`, `SCHEDULE`, `OVERDUE`, `SKIPPED` and `VISITED`|`"status":"VISITED"`|
Expand Down Expand Up @@ -3685,6 +3685,16 @@ GET /api/messages

To retrieve a specific message.

```
GET /api/messages/scheduled/sent?enrollment={uid}
```

```
GET /api/messages/scheduled/sent?event={uid}
```

To retrieve a specific message.

```
GET /api/messages/{uid}
```
Expand Down Expand Up @@ -3735,6 +3745,10 @@ tracker export endpoints. Further performance optimizations require knowledge of
patterns and data distribution. If your implementation can share this information, it will help
prioritize improvements.

For tracker performance improvements relative to previous releases, see the corresponding release
note, e.g.
[2.43](https://dhis2.github.io/dhis2-releases/releases/2.43/ReleaseNote-2.43.html#tracker).

### Import

#### Notifications
Expand Down
3 changes: 3 additions & 0 deletions src/sysadmin/reference/dhis.conf.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,9 @@ analytics.connection.pool.min_size = 5
# Number of connections a pool will try to acquire upon startup. Should be between minPoolSize and maxPoolSize. (default: 5).
analytics.connection.pool.initial_size = 5

# If present, overrides the analytics.connection.url value - useful when running Apache Doris in a container (so it is not able to access Postgres via `localhost`).
doris.catalog.connection.url = https://doris.example.org


# ----------------------------------------------------------------------
# System telemetry [Optional]
Expand Down
Loading