Skip to content

docs: web-api docs update for program rule action SCHEDULEEVENT [DHIS2-16911] #1639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: web-api docs update for program rule action SCHEDULEEVENT [DHIS2-16911] #1639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions src/developer/web-api/tracker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1552,6 +1552,7 @@ A complete list of the supported program rule actions is presented below.
| SETMANDATORYFIELD | X |
| SENDMESSAGE | X |
| SCHEDULEMESSAGE | X |
| SCHEDULEEVENT | X |

Program rules are evaluated in the importer in the same way they are evaluated in the tracker apps.
To summarize, the following conditions are considered when enforcing the program rules:
Expand All @@ -1569,6 +1570,7 @@ The results of the program rules depend on the actions defined in those rules:
* When the action is assigning a value to an empty attribute/data element, a warning is generated.
* When the action is assigning a value to an attribute/data element that already has the same value to be assigned, a warning is generated.
* When the action is assigning a value to an attribute/data element that already has a value and the value to be assigned is different, an error is generated unless the `RULE_ENGINE_ASSIGN_OVERWRITE` system setting is true.
* When the action involves scheduling an event, a warning is generated indicating the scheduled event, along with the program rule UID that triggered it.

Additionally, program rules can also result in side-effects, like send and schedule messages. More
information about side effects can be found in the following section.
Expand Down