Skip to content

docs: update system settings docs - enable/disable period types, weekly relative start day and more#1744

Merged
karolinelien merged 9 commits into
masterfrom
feat/update-system-settings-analytics-docs
Apr 30, 2026
Merged

docs: update system settings docs - enable/disable period types, weekly relative start day and more#1744
karolinelien merged 9 commits into
masterfrom
feat/update-system-settings-analytics-docs

Conversation

@karolinelien
Copy link
Copy Markdown
Contributor

@karolinelien karolinelien commented Apr 28, 2026

Summary

Updates system settings and API developer docs for changes shipped in DHIS2 2.43, plus fixes for pre-existing gaps.

New settings (DHIS2 2.43+) — src/user/system-settings.md

  • DHIS2-20520: Add Period types available in analytics apps — replaces the individual hide-period checkboxes in the
    Settings app from v2.43
  • DHIS2-20839: Add Weekly relative period start day — choose which weekday the relative weekly period starts on
  • DHIS2-20840: Update Financial year relative start month — February, August and September are new options from v2.43

Hide period settings — consolidated the five separate rows (Hide daily/weekly/biweekly/monthly/bimonthly periods) into
one row, noting they were removed from the Settings app in v2.43.

Pre-existing gaps fixed

  • Add missing Use centroids for organisation unit polygons in event analytics row
  • Fix dashboard item → dashboard items (plural) in 4 setting labels to match UI text
  • Fix missing closing | on the Enable embedded dashboards row

API developer docs

  • settings-and-configuration.md: Add analyticsWeeklyStart, update analyticsFinancialYearStart with new 2.43 options, add
  • overview.md: Update financialYearStart parameter on /api/relativePeriods to include the three new 2.43 options

karolinelien and others added 4 commits April 28, 2026 13:36
- Add Period types available in analytics apps (DHIS2-20520): new v2.43
  multi-select control for enabling/disabling period types, replacing
  the individual hide-period checkboxes for instances on v2.43+
- Add Weekly relative period start day (DHIS2-20839): new v2.43 setting
  for choosing the weekly relative period start day (Mon–Sun)
- Update Financial year relative start month (DHIS2-20840): document
  February, August and September as new options from v2.43
- Add missing Hide biweekly periods setting (was in app, not in docs)
- Add Use centroids for organisation unit polygons in event analytics
  (was in app, not in docs)
- Fix dashboard item settings labels: item → items (4 rows) to match
  the actual UI labels

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The individual Hide daily/weekly/biweekly/monthly/bimonthly periods
settings were removed in DHIS2 2.43 (maximumApiVersion: 42) and
replaced by the new Period types available in analytics apps setting.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@karolinelien karolinelien force-pushed the feat/update-system-settings-analytics-docs branch from 339ff62 to 17a7839 Compare April 28, 2026 11:56
@karolinelien karolinelien marked this pull request as ready for review April 28, 2026 12:10
@karolinelien karolinelien force-pushed the feat/update-system-settings-analytics-docs branch 2 times, most recently from e598aae to 17a7839 Compare April 28, 2026 12:32
system-settings.md:
- Fix <br><br> to <br> <br> to match file convention
- Fix double space in Hide daily/weekly/... row
- Fix pre-existing missing closing | on Enable embedded dashboards row

settings-and-configuration.md:
- Add analyticsWeeklyStart system setting (new in 2.43)
- Update analyticsFinancialYearStart to list all valid options
  including new 2.43 values (FINANCIAL_YEAR_FEBRUARY/AUGUST/SEPTEMBER)
- Update all keyHide*Periods entries to note removal in 2.43
  and point to dataOutputPeriodTypes as replacement

overview.md:
- Update financialYearStart parameter to include new 2.43 options

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@karolinelien karolinelien force-pushed the feat/update-system-settings-analytics-docs branch from 17a7839 to 50af8f8 Compare April 28, 2026 12:48
@karolinelien karolinelien merged commit a3f919c into master Apr 30, 2026
@karolinelien karolinelien deleted the feat/update-system-settings-analytics-docs branch April 30, 2026 12:40
netroms pushed a commit that referenced this pull request May 11, 2026
…ly relative start day and more (#1744)

* docs: update analytics system settings for DHIS2 2.43 features

- Add Period types available in analytics apps (DHIS2-20520): new v2.43
  multi-select control for enabling/disabling period types, replacing
  the individual hide-period checkboxes for instances on v2.43+
- Add Weekly relative period start day (DHIS2-20839): new v2.43 setting
  for choosing the weekly relative period start day (Mon–Sun)
- Update Financial year relative start month (DHIS2-20840): document
  February, August and September as new options from v2.43
- Add missing Hide biweekly periods setting (was in app, not in docs)
- Add Use centroids for organisation unit polygons in event analytics
  (was in app, not in docs)
- Fix dashboard item settings labels: item → items (4 rows) to match
  the actual UI labels

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: note that Hide x periods settings were removed in v2.43

The individual Hide daily/weekly/biweekly/monthly/bimonthly periods
settings were removed in DHIS2 2.43 (maximumApiVersion: 42) and
replaced by the new Period types available in analytics apps setting.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Update system-settings.md

* Update system-settings.md

* docs: table rendering fixes and API docs for 2.43 analytics changes

system-settings.md:
- Fix <br><br> to <br> <br> to match file convention
- Fix double space in Hide daily/weekly/... row
- Fix pre-existing missing closing | on Enable embedded dashboards row

settings-and-configuration.md:
- Add analyticsWeeklyStart system setting (new in 2.43)
- Update analyticsFinancialYearStart to list all valid options
  including new 2.43 values (FINANCIAL_YEAR_FEBRUARY/AUGUST/SEPTEMBER)
- Update all keyHide*Periods entries to note removal in 2.43
  and point to dataOutputPeriodTypes as replacement

overview.md:
- Update financialYearStart parameter to include new 2.43 options

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Update overview.md

* Update settings-and-configuration.md

* Update settings-and-configuration.md

* Update settings-and-configuration.md

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants