Skip to content

docs: PI disaggregation categoryCombo note and section cleanup (DHIS2-18745) - #1776

Open
karolinelien wants to merge 5 commits into
masterfrom
docs/DHIS2-18745-pi-disaggregation-categorycombo-note
Open

docs: PI disaggregation categoryCombo note and section cleanup (DHIS2-18745)#1776
karolinelien wants to merge 5 commits into
masterfrom
docs/DHIS2-18745-pi-disaggregation-categorycombo-note

Conversation

@karolinelien

Copy link
Copy Markdown
Contributor

Summary

  • Documents that when configuring Program Indicator disaggregation directly via the metadata API, the Program Indicator's own categoryCombo/attributeCombo must also include the mapped Category, or the mapping won't show/be editable in the Maintenance app screen (though it still works in analytics)
  • Cross-checked the rest of the "Setting up new program disaggregation mappings" section against the Maintenance (Preview) app source and fixed several issues:
    • Corrected "Other section" to "Programs section" for where Program Disaggregations is grouped in the sidebar
    • Fixed broken step numbering (duplicated/skipped numbers), a typo, and inconsistent Visualizer/visualization spelling
    • Sized the oversized retina screenshots consistently with the rest of the page
    • Added notes on save-time mapping validation (a warning icon shows for missing/invalid mappings but doesn't block saving) and the aggregate-export ID fields (free-text, unvalidated against the target's Category Combination; alternate COC/AOC fields appear when the combo is left as default)

Test plan

  • Docs build renders the section correctly (headings, numbered list, image sizes)
  • Links (#data_exchange anchor, external JEXL reference) resolve correctly in the built site

AI Assisted

… (DHIS2-18745)

When setting up Program Indicator disaggregation directly via the metadata
API instead of through the Maintenance app, the Program Indicator's own
categoryCombo/attributeCombo must also be set to a Category Combination
containing the mapped category, or the mapping won't display or be
editable in this screen even though it still works in analytics.

AI Assisted
…isaggregation section (DHIS2-18745)

Corrects several issues in the program disaggregation mappings walkthrough
found while cross-checking it against the Maintenance (Preview) app source:
the section is actually grouped under "Programs" in the sidebar, not
"Other". Also fixes broken step numbering, a typo, inconsistent
Visualizer/visualization spelling, sizes the oversized retina screenshots
consistently with the rest of the page, and adds notes on save-time mapping
validation and the aggregate-export ID fields.

AI Assisted
…IS2-18745)

The app was renamed from "Maintenance (Preview)" to "Metadata Management"
(metadata-management-app commit 77821e6, DHIS2-21090), which also changed
its URL slug from maintenance-preview to metadata-management. Updates the
PI disaggregation walkthrough to match.

AI Assisted
@karolinelien
karolinelien marked this pull request as ready for review August 5, 2026 13:32

@DavidCKen DavidCKen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link I highlighted should be relative to the anchor, the wrong format was already in the file. and a lot of the screenshots should be changed to show the MMA not the maintenance app preview, do you want to do that in a combined PR or seperate?


8. In the text field under each Category enter an expression using the Program Data Elements and Attributes that defines the category. The expression uses the same syntax as the Filter section of the Program Indicator creation screen. It is recommended to open a Program Indicator within the Program you are mapping, use the Filter screen to construct the expression and then copy it into this field. This allows you to use the inbuilt expression validation of the Program Indicator filter builder.
[Program Indicator functions and Variale operators](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-242/configuring-the-system/programs.html#program_indicator_functions_variables_operators)
[Program Indicator functions and Variable operators](https://docs.dhis2.org/en/use/user-guides/dhis-core-version-242/configuring-the-system/programs.html#program_indicator_functions_variables_operators)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed - now links to the internal anchor (#program_indicator_functions_variables_operators) instead of the external versioned URL.

… validation (DHIS2-18745)

Expands the existing categoryCombo note after confirming against dhis2-core
(ProgramCategoryMappingValidator / PiDisagInfoInitializer) that neither
completeness nor duplicate-categoryId mappings are checked when a Program or
Program Indicator is created/updated via the API - both only surface at
analytics query time, and a categoryId collision currently crashes with an
unhandled server error rather than a validation message. The Maintenance
(Preview)/Metadata Management screen prevents this; the API does not.

AI Assisted
…(DHIS2-18745)

Per David's review comment on #1776: the target section already exists in
this same book, so the link should be a relative anchor instead of an
external versioned docs.dhis2.org URL.

AI Assisted
@karolinelien

Copy link
Copy Markdown
Contributor Author

Doing this as a combined PR - I'll swap the outdated Maintenance (Preview) screenshots for the current Metadata Management app in this same PR rather than splitting it out.

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