Benachrichtigungen
Installation und Konfiguration
Copyright ©
Mindbreeze GmbH, A-4020 Linz, .
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Einführung
Mit dem Benachrichtigungs-Service ist es möglich, Benutzer bei Änderungen von Treffern zu benachrichtigen.
Beispiel: Ein Benutzer sucht nach einem bestimmten Suchwort wie z.B. „Mindbreeze Folder“ und lässt sich alle PDF Dokumente anzeigen. Dafür erhält er 50 Suchtreffer.
Nun möchte er per E-Mail benachrichtigt werden (z.B. jeden Montag um 8 Uhr), wenn sich die Trefferanzahl verändert hat.
Vorbereitung
Datenbank für Benachrichtigungen erstellen
Um Benachrichtigungen verwenden zu können, muss eine Datenbank dafür vorhanden sein.
Tipp: So können Sie eine Datenbank anlegen:
create database notifications;
CREATE USER user WITH PASSWORD 'password';
grant all privileges on database "notifications" to user;
Konfiguration
Konfigurieren Sie im Tab „Client Services“ die „Alerting Service Settings“ und die „Resource Persistence Settings“.
Alert Service Settings – Alert Collection
Enable | Aktiviert die Benachrichtigungen – Standardwert: true |
Allow Email subscriptions | Sind im Standard-Insight-Client nicht verfügbar, daher sollte es nicht aktiviert werden |
Collection Name | Name der Collection – Wird u.a. für die Darstellung am Client benötigt. Beispiel: „Jeden Freitag um 08:00 Uhr“ |
Collection Path | Pfad zur Collection. Format: emailalert/eindeutiger_name – Beispiel: emailalert/daily |
Notification Schedule | Eine Extended Cron Expression, die angibt wann der Task ausgeführt werden soll.
Eine Dokumentation und weitere Beispiele zu Cron Expressions finden Sie hier. |
Path to Query Templates | Pfad für die Templates “Query Script” und “Output Format Script”. |
Query Script | Dateiname des Query Scripts. |
Output Format Script | Dateiname des Scripts zum Formatieren der Ausgabe. |
Mailserver | Angabe des Mailservers, von welchem die E-Mails versendet werden. |
Sender of alert emails | Angabe der E-Mail Adresse, von welcher die E-Mails versendet werden. |
Dedizierter Alerting Principal Resolution Service
Standardmäßig verwendet der Benachrichtigungs-Service die Suche und damit auch die konfigurierten Caching Principal Resolution Services der Datenquellen.
Für erweiterte Anwendungsfälle können zusätzliche Caching Principal Resolution Services im Client Service konfiguriert werden. Dies wird in der Sektion „Alerting Principal Resolution Plugins“ konfiguriert. Zusätzlich muss eine benutzerdefinierte Plugin-Eigenschaft "MES_SERVICE_CONTEXT" mit dem Wert "mindbreeze.service.NotificationService" hinzugefügt werden (Erweiterte Einstellungen). Diese Services werden zuerst aufgerufen, bevor die Suche auf den einzelnen Datenquellen durchgeführt wird.
Folgende Optionen stehen zusätzlich in „Alert Service Settings“ zur Verfügung:
Bestimmt, wie lange (In Sekunden) auf die Antwort von einem Caching Principal Resolution Services gewartet wird. Treten ein Timeout oder ein anderer Fehler auf, wird keine Benachrichtigung ausgesendet | |
Disable Alerts for Principal Pattern | Mit dieser Option können die Benachrichtigungen für gewisse Benutzer dynamisch deaktiviert werden. Dies geschieht abhängig von den aktuellen Principals des Benutzers (die über die Alerting Principal Resolution Plugins bestimmt wurden). Mit dieser Option kann ein regulärer Ausdruck (Java, unabhängig Groß-/Kleinschreibung) definiert werden. Falls ein Principal mit dem regulären Ausdruck übereinstimmt, wird die Benachrichtigung für den Benutzer deaktiviert. |
Use Principal Email Address | Wenn aktiv, wird die Empfänger-E-Mail-Adresse der Benachrichtigung mithilfe der konfigurierten Caching Principal Resolution Services ausgewählt. Welcher Principal als E-Mail-Adresse ausgewählt wird, kann mithilfe der Option „Principal Email Address Prefix“ bestimmt werden. |
Principal Email Address Prefix | Der Principal, der mit dem hier konfigurierten Prefix beginnt, wird als E-Mail-Adresse verwendet, wenn die Option „Use Principal Email Address“ aktiviert ist. Beispiel: Der Benutzer max.mustermann hat über einen Principal Resolution Service zusätzlich den Principal „email=max.mustermann@example.com“. Wenn hier also „email=“ als Prefix konfiguriert ist, wird „max.mustermann@example.com“ als Empfänger E-Mail-Adresse beim Versenden der Benachrichtigung ausgewählt. |
Automatische Anpassung der Email-Adresse auf Basis der Identität
Wenn ein Benutzer zum ersten Mal eine Benachrichtigung einrichtet, kann der Benutzer eine E-Mail-Adresse angeben, an die dann die Benachrichtigungen versandt werden.
Unter gewissen Voraussetzungen kann die E-Mail-Adresse automatisch gesetzt oder korrigiert werden. Im Client-Service muss eine Benutzeranmeldung über Trusted Peer verwendet werden. Die E-Mail-Adresse muss als Benutzerattribut verfügbar sein. (Siehe Trusted Peer Authentication Dokumentation)
Einstellungen:
Use Email Address from Identity | Wenn aktiv, wird die E-Mail-Adresse des Benutzers beim anlegen des Benutzers von dem Benutzerattribut der Trusted-Peer Anmeldung verwendet. (Standardwert: nicht aktiv) |
Email Address Identity Property | Name des Benutzerattributs, welches für die E-Mail-Adresse benutzt wird. (Standardwert: mail) |
Resource Persistence Settings
Einstellungen:
Aktiviert die Persistierten Ressourcen – Standardwert: false | |
User Administrator Users | Angabe der User Administratoren. |
JDBC URL | Angabe der Datenbank URL. |
Max Number Of Database Connections | Maximale Anzahl der Datenbankverbindungen. Standardwert: 10, Minimalwert: 2. |
User | Angabe des Benutzers zur Datenbank. |
Password | Angabe des Passworts zur Datenbank. |
Database Table Prefix | Angabe des Tabellen-Prefix in der Datenbank |
User Interface
Verwaltung der User
Sind die Benachrichtigungen aktiviert und korrekt eingestellt, erhält man im Management Center unter „Insight Apps“ einen neuen Eintrag „Users“, welcher alle vorhandenen User auflistet.
Der Administrator ist nun berechtigt, neue User anzulegen (Button „Add user“), sämtliche vorhandene User zu bearbeiten („Edit“) bzw. zu löschen.
Um einen vorhandenen User zu löschen, reicht ein Klick auf den „Delete-Button“ auf der Übersicht beim gewünschten Usernamen.
Verwaltung der Alerts
Sind die Benachrichtigungen aktiviert und korrekt eingestellt, erhält man im Management Center unter „Insight Apps“ einen neuen Eintrag „Alerts“, welcher alle vorhandenen Alerts auflistet.
Der Administrator ist nun berechtigt, sich Details zu allen Alerts anzusehen und die Description jedes einzelnen Alerts zu bearbeiten.
Um einen vorhandenen Alert zu löschen, reicht ein Klick auf den „Delete-Button“ auf der Übersicht beim gewünschten Alert.
Bearbeitung der Alerts am Client
Alle Benachrichtigungen können am Client bearbeitet werden. Dazu genügt ein Klick auf den gewünschten Alert. Es öffnet sich ein Vorschaufenster, indem die gesamte Suche angepasst werden kann (Query ändern, Filter ändern, etc.).
