Omni-channel alerts
Learn how to read, set and preview the rule that decides who hears of each Signals alert event with the Java SDK.
- Stable unknown
- Release candidate not available
- Development since 0.2.0-dev.32+058a03c
Ovok keeps the project's omni-channel alerts rule and runs it on each alert event Signals sends. The rule names who to tell and over which channel, and Ovok tells them by push and email. ovok.omnichannelAlerts() reads, sets and previews that rule. It is for project admins, and it needs the OMNICHANNEL_ALERTS_ENABLED setting on.
Set the rule
ovok.projects().settings().update("OMNICHANNEL_ALERTS_ENABLED", true, RequestOptions.defaults());
ovok.omnichannelAlerts().rules().update(Map.of("logic", Map.of("if", List.of(
Map.of("==", List.of(Map.of("var", "event"), "alert.triggered")),
Map.of("notify", Map.of("channels", List.of("push", "email"), "to", List.of("practitioner"))),
List.of()))),
RequestOptions.defaults());logicis JSON Logic. It answersnotifyentries, each namingchannelsand the roles to tell (to), or an empty list to tell nobody.- The logic can read
event,alert.id,alert.code,alert.reason,alert.message,alert.valueandpatient.id. eventis one ofalert.triggered,alert.empty,alert.note,alert.inactive,alert.refired,alert.resolvedandalert.acknowledged.- Channels are
pushandemail. Roles arepractitioner,caregiver,relatedPersonandsharedWith. An unknown label (UNKNOWN_NOTIFY_LABELS) or a rule that cannot run on every event (INVALID_NOTIFICATIONS) raises anOvokValidationException. retrievereads the rule undernotifications, null when the project has none.removedeletes it.
Preview who it reaches
JsonNode preview = ovok.omnichannelAlerts().preview(
Map.of("patientId", patientId, "event", "alert.refired"),
RequestOptions.defaults());- Each entry of
notifylists the people its roles resolve to for that patient, and whether each has an email address on file. eventisalert.triggeredwhen omitted. Addalertto set the sample alert'scode,reason,messageorvalue, andnotificationsto try a rule before you save it. Nothing is sent.
See also
OmnichannelAlertsResourcereference: every method.- Push: register devices and set up the push provider.
- Projects: project settings.
Last updated on