How to trigger program rules on a list of event

mva · 28 November 2019 09:39

We have recently added program rules setting values to some data element to an existing program with some thousand events. Those works well, and each time we open a specific event we see them computed and the values correctly set in the related Data Elements.

The problem is now that we would like to “trigger” the rules on all our events. Our logic would be to call the API and iterate using a small script, but we’re unsure how to “force” DHIS2 to trigger program rules on a single event - any tips here?

Martin

jesplana · 22 October 2020 07:39

Hello Martin,
Did you find a solution to this? I have a similar use case.

Thank you,

John

brian · 23 October 2020 11:06

@mva and @jesplana,

There is work in progress to expand the backend rules engine in 2.35, and trigger program rules by “pinging” the event with a PUT or POST request.

See this CoP post with explanation: Backend program rules - #2 by jomutsani

And this JIRA ticket: DHIS2-7310 - Expand backend rules engine functionality: Assigning, errors and warnings

Currently the only PR Action available to trigger through this method is the SCHEDULEMESSAGE or SENDMESSAGE for SMS Program Notifications.

Maybe @Markus and @dhis2-tracker team could address this?

jesplana · 23 October 2020 12:57

Thanks Brian for sending the link.

John

kstankevitz · 9 August 2022 19:32

It looks like according to JIRA this was implemented in 2.36… has anyone successfully done this?

rithvik · 10 August 2022 18:37

Hi @kstankevitz ,

Looks like the new APIs are working. I gave it a try on 2.38.1.1 by adding a new program rule to assign a value and I was able to successfully assign value to past event records and update them. But unfortunately the Import/Export app is still using the old APIs. The procedure which I followed requires some technical expertise. If you are interested to know the process I followed, I would be happy to share.

Thanks,
Rithvik

kstankevitz · 10 August 2022 19:12

Yes, I would appreciate more information about your process. We have a number of different cases where we would like to trigger the PRs across multiple events.

Best,
Kayla

rithvik · 12 August 2022 14:07

Hi @kstankevitz ,

I have followed the documentation provided at New Tracker - DHIS2 Documentation.

Procedure I followed to test the functionality.

created a new data element and assigned it to a program
created a new program rule that would assign a value to the newly created data element based on other data elements in the program
I have used the following API to get all the event records for a given program, organisation unit.
https://play.dhis2.org/2.38.1.1/api/38/tracker/events.json?skipPaging=true&program=lxAQ7Zs9VYR&programStage=dBwrot7S420&orgUnit=DiszpKrYNg8&ouMode=SELECTED&fields=:all
You can use this section of the documentation New Tracker - DHIS2 Documentation to export the required event records for your use case.
In the downloaded json file, replace the “instances” key with “events”.
Now the exported events need to be imported back into the system for the program rules to execute.
I have used a HTTP client tool to make the following POST request to import the events.
https://play.dhis2.org/2.38.1.1/api/tracker?reportMode=FULL&async=false
with the exported events as payload.
Once the events were successfully imported, I verified the new dataelement has value as per the new program rule in the capture app.

Please test this thoroughly before performing this on production.

Thanks,
Rithvik