Skip to main content

DHIS2 version compatibility

Program Rules Playground supports DHIS2 2.40, 2.41, 2.42 and 2.43. The About page in the app, linked from the bottom of the program list, shows the same range under Supported DHIS2.

The app reads the version of the server you are connected to and adjusts two things: which rule actions the server is expected to run, and which app the rule editor link opens.

Where each rule action runs​

Some rule actions change the form, and the app runs them in your browser as you type. Others only take effect on the server, for example sending a message. The app does not run those in the browser. It lists them in the Server effects dialog instead, marked Simulated.

Rule actionIn the app (browser)Server on 2.40 to 2.42Server on 2.43
HIDEFIELD, SHOWFIELD, HIDESECTION, HIDEOPTION, SHOWOPTION, HIDEOPTIONGROUP, SHOWOPTIONGROUPRuns, changes the formNot runNot run
DISPLAYTEXT, DISPLAYKEYVALUEPAIRRuns, shows in Feedback or IndicatorsNot runNot run
ASSIGN, SETMANDATORYFIELDRuns, changes the fieldRunsRuns
UNSETMANDATORYFIELDRuns, makes the field optionalNot runNot run
SHOWWARNING, SHOWERRORRuns, shows on the fieldRunsRuns
WARNINGONCOMPLETE, ERRORONCOMPLETERuns, shows on the field and in the completion checkRunsRuns
SENDMESSAGE, SCHEDULEMESSAGENot run, simulated in Server effectsRunsRuns
SCHEDULEEVENTNot run, simulated in Server effectsNot runRuns
CREATEEVENTNot run, simulated in Server effectsNot runNot run
HIDEPROGRAMSTAGEShows in the rules panel only, the stage stays visibleNot runNot run

"Runs" in a server column means the DHIS2 tracker importer runs the action when data is imported, and reports it when you use Verify with server.

SCHEDULEEVENT and CREATEEVENT

The server runs SCHEDULEEVENT from DHIS2 2.43. On DHIS2 2.40 to 2.42, SCHEDULEEVENT and CREATEEVENT rows in Server effects are dimmed and read "Not executed by this server (requires 2.43)".

On 2.43, CREATEEVENT rows read "Not executed by this server", because the server declares the action but doesn't run it.

For the full list of rule actions and what each one does in the app, see Rule action types.

The rule details dialog has a link that opens the rule in the DHIS2 app where you edit rules.

Rule editor link
  • On DHIS2 2.40 to 2.42 the link reads Edit in Maintenance app and opens the Maintenance app.
  • On DHIS2 2.43 the link reads Edit in Metadata Management app and opens the Metadata Management app.

If the app can't tell the server version, it uses the Maintenance app link and treats the server as 2.40.

What has been checked on which version​

The user authorities and sharing in Requirements and user authorities were checked on DHIS2 2.43.2. They have not been checked on 2.40 to 2.42 yet, and neither has the Edit in Maintenance app link.