Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core information center entwickeln


Benachrichtigung per E-Mail konfigurieren

Ein Benutzer kann sich basierend auf einstellbaren Suchergebnissen vom System per E-Mail benachrichtigen lassen. Im Standard ist die E-Mail-Benachrichtigung deaktiviert.


Voraussetzungen

Das Versenden von E-Mails in agorum core ist eingerichtet, etwa indem Sie agorum core als Mailserver oder als externen RELAY-Server verwenden.

Die Benachrichtigung per E-Mail aktivieren


  1. Öffnen Sie links in der Seitenleiste Explorer.
  2. Öffnen Sie Ihren Workspace unter:
    Eigene Dateien/Administration/workspace/agorum.composite/notification/mail

    Ergebnis: Mehrere Dateien erscheinen:

    • notification-mail-settings.js (die globalen Einstellungen)
    • notification-mail_de.js (sprachabhängige Einstellung für Deutsch)
    • notification-mail_en.js (sprachabhängige Einstellung für Englisch)
    • notification-mail_de.html (sprachabhängiger E-Mail-Body für Deutsch)
    • notification-mail_en.html (sprachabhängiger E-Mail-Body für Englisch)
  3. Öffnen Sie die Datei notification-mail-settings.js mit einem Doppelklick.
  4. Stellen Sie Folgendes ein:

    enabled: true
    Aktiviert die E-Mail-Funktion, sodass diese in den Benachrichtigungseinstellungen zur Verfügung steht.

    from
    Definiert die E-Mail-Adresse, die das System als Absender verwendet.

    baseUrl
    Definiert die URL des agorum core-Servers.

    Innerhalb der E-Mails sind Links enthalten, die zur Suche führen, um direkt in den jeweiligen Filter zu gelangen.
    exports.settings = () => {
      return {
        // enable mail function in notifications, after setup
        enabled: true, 
        
        // the from address of the mails, sent by agorum core notification service
        from: '"agorum core" <notification@agorum.com>',
        
        // the base url of the agorum core server, used as link in the mails
        baseUrl: 'http://acic-dev.docker.agorum.com'
      };
    };

Einstellungen für E-Mails vornehmen


Die Dateien namens notification-mail-[Sprache].js enthalten erweiterte Einstellungen. Für die E-Mail-Benachrichtigungen wird die in den Benutzereinstellungen angegebene Sprache verwendet.

Hinweis: Stellen Sie sicher, dass für die für das System konfigurierten Sprachen (bzw. in den Benutzereinstellungen auswählbaren Sprachen) jeweils eine Datei notification-mail-[Sprache].js gefunden wird. Sonst wird standardmäßig die englische Datei verwendet.

Einstellung Beschreibung
subject Definiert den Betreff der E-Mail.

Das System ersetzt den Platzhalter ${title} durch den Mitteilungsnamen, den der Benutzer bei Einstellung der Mitteilung vergeben hat.
from Überschreibt die Einstellungen from aus den globalen Einstellungen.
body Gibt die Datei an, die für das Erstellen des E-Mail-Inhalts verwendet wird.
listItemPre Definiert ein HTML-Element, das das System am Anfang der Auflistung der Benachrichtigungen verwendet.
listItemPost Definiert zu listItemPre zugehörige schließende Element.
listItemFunction Definiert eine Funktion, die das System je Mitteilungsobjekt aufruft.
  • Sie können in Abhängigkeit des jeweiligen Objekts diverse Informationen erhalten.
  • Der Inhalt der Funktion muss HTML-Code sein.
  • Der HTML-Code erscheint in der E-Mail und dort in der Auflistung.
{
  subject: 'Mitteilung von agorum core: ${title}',
  from: settings.from,
  body: '/agorum/roi/workspace/agorum.composite/notification/mail/notification-mail_de.html',
  listItemPre: '<ul>',
  listItemPost: '</ul>',
  listItemFunction: item => {
    let html = '<li><a href="' + url + '" target="_blank">${item}</a></li>';
    
    // item is an agorum core object
    // return the value, you want to be displayed in the mail
    // return html code
    if (item.className.toLowerCase() === 'noteobject') {
      return html.replace('${item}', 'Notiz von ' + item.creator.fullName);
    }
    else if (item.className.toLowerCase() === 'mailobject') {
      return html.replace('${item}', 'E-Mail von ' + item.fromAddress[0].replace(/</g, '&lt;').replace(/>/g, '&gt;') + ': ' + item.subject.replace(/<.*?>/g, ''));
    }
    else {
      return html.replace('${item}', item.displayName.replace(/<.*?>/g, ''));
    }
  }
}

E-Mail-Bodys anpassen


Die Dateien namens notification-mail_[Sprache].html enthalten die Templates samt Platzhalter für den E-Mail-Inhalt. Für die E-Mail-Benachrichtigungen wird die Datei verwendet, die in der Datei mit den sprachspezifischen Einstellungen notification-mail-[Sprache].js in der Einstellung body angegeben ist.

Platzhalter Beschreibung
counter Definiert die Anzahl der ungelesenen Objekte für die jeweilige Mitteilungskonfiguration, die entstanden sind, seit der Benutzer zuletzt den Filter in der Suche aufgerufen hat.

Das System setzt den Filter erst zurück, nachdem der Benutzer auf den Link geklickt hat, um die Elemente einzusehen.
title Definiert den Namen, den der Benutzer bei Einstellung der Mitteilung vergeben hat.
date Definiert das Datum der letzten Benachrichtigung, d. h., wann das letzte Mal eine E-Mail geschickt wurde.
items Definiert eine Liste aller Objekte, die das System seit der letzten E-Mail zurückgegeben hat, und seitdem der Benutzer das letzte Mal die Mitteilungen eingesehen hat.
Hallo,

es gibt ${counter} ungelesene Benachrichtigungen in agorum core für "${title}".

Seit ${date:dd.MM.yyyy HH:mm} sind  folgende Nachrichten hinzu gekommen: ${items}

Viele Grüße

Ihr agorum core

Einstellungen aktivieren


  1. Starten Sie agorum core neu.
  2. Öffnen Sie im agorum core support tool das Menü Support Tool > Workers > Action> QueryScript : agorum_composite_acic_notifications.
  3. Klicken Sie auf Update worker script.

    Ergebnis: Benutzer können sich jetzt Mitteilungen per E-Mail zusenden lassen. Dazu setzen diese einen gewünschten Filter in der Suche und wählen unter der Mitteilungseinstellung Mitteilung via E-Mail aus.

     

    Mitteilungen per E-Mail versenden