Konfigurieren von E-Mail-Benachrichtigungen

AEM sendet E-Mail-Benachrichtigungen an Benutzer, die:

  • Seitenereignisse wie Änderungen oder Replikationen abonniert haben. Im Abschnitt Benachrichtigungs-Posteingang ist beschrieben, wie solche Ereignisse abonniert werden können.

  • Forenereignisse abonniert haben.

  • einen Schritt innerhalb eines Workflows durchführen müssen. Im Abschnitt Teilnehmer-Schritt ist beschreiben, wie E-Mail-Benachrichtigungen in einem Workflow ausgelöst werden können.

Voraussetzungen:

  • Benutzer müssen über eine in ihrem Profil festgelegte, gültige E-Mail-Adresse verfügen.
  • Der Day CQ Mail Service muss ordnungsgemäß konfiguriert sein.

Wenn ein Benutzer benachrichtigt wird, erhält er eine E-Mail in der Sprache, die in seinem Profil festgelegt ist. Jede Sprache verfügt über eine eigene, anpassbare Vorlage. Für neue Sprachen können neue E-Mail-Vorlagen hinzugefügt werden.

HINWEIS

Beim Arbeiten mit AEM sind mehrere Methoden zum Verwalten der Konfigurationseinstellungen für solche Dienste verfügbar. Weitere Informationen und empfohlene Verfahren finden Sie unter Konfigurieren von OSGi.

Konfigurieren des E-Mail-Diensts

Damit AEM E-Mails versenden kann, muss der Day CQ Mail Service ordnungsgemäß konfiguriert sein. Sie können die Konfiguration in der Web-Konsole anzeigen. Beim Arbeiten mit AEM sind mehrere Methoden zum Verwalten der Konfigurationseinstellungen für solche Dienste verfügbar. Weitere Informationen und empfohlene Verfahren finden Sie unter Konfigurieren von OSGi.

Es gelten die folgenden Beschränkungen:

  • Der SMTP-Server-Anschluss muss 25 oder höher sein.

  • Der Hostname des SMTP-Servers darf nicht leer sein.

  • Die „Von“-Adresse darf nicht leer sein.

Zum Debuggen eines Problems mit dem Day CQ Mail Service können Sie die Protokolle des Diensts betrachten:

com.day.cq.mailer.DefaultMailService

Die Konfiguration sieht in der Web-Konsole wie folgt aus:

chlimage_1-276

Konfigurieren des E-Mail-Benachrichtigungskanals

Wenn Sie entweder Benachrichtigungen zu Seiten- oder Forenereignissen abonniert haben, ist die „Von“-E-Mail-Adresse standardmäßig auf no-reply@acme.com eingestellt. Sie können diesen Wert durch die Konfiguration des Diensts Benachrichtigungs-E-Mail-Kanal in der Web-Konsole ändern.

Fügen Sie zum Konfigurieren der „Von“-E-Mail-Adresse einen sling:OsgiConfig-Knoten zum Repository hinzu. Verwenden Sie das folgende Verfahren, um den Knoten direkt mithilfe von CRXDE Lite hinzuzufügen:

  1. Fügen Sie in CRXDE Lite einen Ordner mit dem Namen config unter Ihrem Anwendungsordner hinzu.

  2. Fügen Sie im Konfigurationsordner einen Knoten mit dem Namen hinzu:

    com.day.cq.wcm.notification.email.impl.EmailChannel vom Typ sling:OsgiConfig

  3. Fügen Sie dem Knoten email.from eine String -Eigenschaft hinzu. Legen Sie zu dem Wert die E-Mail-Adresse fest, die Sie verwenden möchten.

  4. Klicken Sie auf Alle speichern.

Gehen Sie wie folgt vor, um den Knoten in den Inhaltspaketen Ihrer Quellordner festzulegen:

  1. Erstellen Sie in jcr_root/apps/*app_name*/config folder eine Datei mit dem Namen com.day.cq.wcm.notification.email.impl.EmailChannel.xml

  2. Fügen Sie die folgende XML für den Knoten hinzu:

    <?xml version="1.0" encoding="UTF-8"?> <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig" email.from="name@server.com"/>

  3. Ersetzen Sie den Wert des Attributs email.from (name@server.com) durch Ihre E-Mail-Adresse.

  4. Speichern Sie die Datei.

Konfigurieren des Workflow-E-Mail-Benachrichtigungsdiensts

Wenn Sie Workflow-E-Mail-Benachrichtigungen erhalten, sind beide „Von“-E-Mail-Adressen und das Host-URL-Präfix auf Standardwerte eingestellt. Sie können diese Werte ändern, indem Sie den Day CQ Workflow Email Notification Service in der Web-Konsole konfigurieren. Wenn Sie dies tun, wird empfohlen, die Änderung im Repository beizubehalten.

Die Standardkonfiguration sieht in der Web-Konsole wie folgt aus:

chlimage_1-277

E-Mail-Vorlagen für die Seitenbenachrichtigung

E-Mail-Vorlagen für die Seitenbenachrichtigungen sind zu finden unter:

/etc/notification/email/default/com.day.cq.wcm.core.page

Die standardmäßige englische Vorlage (en.txt) wird wie folgt definiert:

subject=[CQ Page Event Notification]: Page Event

header=-------------------------------------------------------------------------------------\n \
Time: ${time}\n \
User: ${userFullName} (${userId})\n \
-------------------------------------------------------------------------------------\n\n

message=The following pages were affected by the event: \n \
 \n \
${modifications} \n \
 \n\n
footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Seitenbenachrichtigung

Die englische E-Mail-Vorlage für die Seitenbenachrichtigung können Sie wie folgt anpassen:

  1. Öffnen Sie in CRXDE die Datei:

    /etc/notification/email/default/com.day.cq.wcm.core.page/en.txt

  2. Passen Sie die Datei an Ihre Anforderungen an.

  3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Dabei kann <text_x> ein Mix von statischem Text und dynamischen Stringvariablen sein. Die folgenden Variablen können innerhalb der E-Mail-Vorlage für Seitenbenachrichtigungen verwendet werden:

  • ${time}, Datum und Uhrzeit des Ereignisses.

  • ${userFullName}, der vollständige Name des Benutzers, der das Ereignis ausgelöst hat.

  • ${userId}, die ID des Benutzers, der das Ereignis ausgelöst hat.

  • ${modifications}beschreibt den Typ des Seitenereignisses und den Seitenpfad im folgenden Format:

    <page event="" type=""> => <page path="">

    Beispiel:

    PageModified => /content/geometrixx/en/products

E-Mail-Vorlagen für die Forumsbenachrichtigung

E-Mail-Vorlagen für die Forumsbenachrichtigungen sind zu finden unter:

/etc/notification/email/default/com.day.cq.collab.forum

Die standardmäßige englische Vorlage (en.txt) wird wie folgt definiert:

subject=[CQ Forum Notification]

header=-------------------------------------------------------------------------------------\n \
Time: Time: ${time}\n \
Forum Page Path: ${forum.path}\n \
-------------------------------------------------------------------------------------\n\n

message=Page: ${host.prefix}${forum.path}.html\n

footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Forumsbenachrichtigung

Die englische E-Mail-Vorlage für die Forumsbenachrichtigung können Sie wie folgt anpassen:

  1. Öffnen Sie in CRXDE die Datei:

    /etc/notification/email/default/com.day.cq.collab.forum/en.txt

  2. Passen Sie die Datei an Ihre Anforderungen an.

  3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Dabei kann <text_x> eine Mischung aus statischem Text und dynamischen Zeichenfolgenvariablen sein.

Die folgenden Variablen können innerhalb der E-Mail-Vorlage für Forumsbenachrichtigungen verwendet werden:

  • ${time}, Datum und Uhrzeit des Ereignisses.

  • ${forum.path}, der Pfad zur Forumsseite.

E-Mail-Vorlagen für die Workflow-Benachrichtigung

Die (englische) Vorlage für die Workflow-Benachrichtigungen befindet sich unter:

/etc/workflow/notification/email/default/en.txt

Sie wird wie folgt definiert:

subject=Workflow notification: ${event.EventType}

header=-------------------------------------------------------------------------------------\n \
Time: ${event.TimeStamp}\n \
Step: ${item.node.title}\n \
User: ${participant.name} (${participant.id})\n \
Workflow: ${model.title}\n \
-------------------------------------------------------------------------------------\n\n

message=Content: ${host.prefix}${payload.path.open}\n

footer=\n \
-------------------------------------------------------------------------------------\n \
View the overview in your ${host.prefix}/aem/inbox\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Workflow-Benachrichtigung

Die englische E-Mail-Vorlage für die Benachrichtigung über ein Workflow-Ereignis können Sie wie folgt anpassen:

  1. Öffnen Sie in CRXDE die Datei:

    /etc/workflow/notification/email/default/en.txt

  2. Passen Sie die Datei an Ihre Anforderungen an.

  3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
HINWEIS

Dabei kann <text_x> eine Mischung aus statischem Text und dynamischen Zeichenfolgenvariablen sein. Jede Zeile eines Elements <text_x> muss mit einem umgekehrten Schrägstrich ( \) enden, mit Ausnahme der letzten Instanz, wenn das Fehlen des umgekehrten Schrägstrichs das Ende der String-Variable <text_x> anzeigt.

Weitere Informationen zum Vorlagenformat werden von der Methode javadocs der Properties.load()-Methode bereitgestellt.

Die Methode ${payload.path.open} zeigt den Pfad zur Payload des Arbeitselements an. Für eine Seite in Sites wäre payload.path.open beispielsweise /bin/wcmcommand?cmd=open&path=… ähnlich wie .; Dies ist ohne den Servernamen, weshalb der Vorlage ${host.prefix} vorangestellt wird.

Die folgenden Variablen können innerhalb der E-Mail-Vorlage verwendet werden:

  • ${event.EventType}, Ereignistyp

  • ${event.TimeStamp}, Datum und Uhrzeit des Ereignisses

  • ${event.User}, der Benutzer, der das Ereignis ausgelöst hat

  • ${initiator.home}, den Initiator-Knotenpfad

  • ${initiator.name}, den Namen des Initiators

  • ${initiator.email}, die E-Mail-Adresse des Initiators

  • ${item.id}, die ID des Arbeitselements

  • ${item.node.id}, ID des Knotens innerhalb des Workflow-Modells, das mit diesem Arbeitselement verknüpft ist

  • ${item.node.title}, Titel des Arbeitselements

  • ${participant.email}, E-Mail-Adresse des Teilnehmers

  • ${participant.name}, Name des Teilnehmers

  • ${participant.familyName}, Familienname des Teilnehmers

  • ${participant.id}, der Teilnehmerkennung

  • ${participant.language}, die Teilnehmersprache

  • ${instance.id}, die Workflow-ID

  • ${instance.state}, den Workflow-Status

  • ${model.title}, Titel des Workflow-Modells

  • ${model.id}, die ID des Workflow-Modells

  • ${model.version}, die Version des Workflow-Modells

  • ${payload.data}, die Payload

  • ${payload.type}, der Payload-Typ

  • ${payload.path}, Pfad der Payload

  • ${host.prefix}, Host-Präfix, z. B. http://localhost:4502

Hinzufügen einer E-Mail-Vorlage in einer neuen Sprache

Sie können wie folgt eine Vorlage in einer neuen Sprache hinzufügen:

  1. Fügen Sie in CRXDE eine Datei <language-code>.txt unten hinzu:

    • /etc/notification/email/default/com.day.cq.wcm.core.page : für Seitenbenachrichtigungen
    • /etc/notification/email/default/com.day.cq.collab.forum : für Forumsbenachrichtigungen
    • /etc/workflow/notification/email/default : für Workflow-Benachrichtigungen
  2. Passen Sie die Datei an die Sprache an.

  3. Speichern Sie die Änderungen.

HINWEIS

<language-code>, der als Dateiname für die E-Mail-Vorlage verwendet wird, muss ein aus zwei Buchstaben bestehender untergeordneter Sprachcode sein, der von AEM erkannt wird. AEM nutzt die Sprachcodes gemäß ISO-639-1.

Konfigurieren von E-Mail-Benachrichtigungen für AEM Assets

Wenn Sammlungen in AEM Assets freigegeben werden oder ihre Freigabe aufgehoben wird, können Benutzer E-Mail-Benachrichtigungen von AEM erhalten. Um E-Mail-Benachrichtigungen zu konfigurieren, führen Sie diese Schritte aus.

  1. Konfigurieren Sie den E-Mail-Dienst, wie oben unter Konfigurieren des E-Mail-Diensts beschrieben.
  2. Melden Sie sich in AEM als Administrator an. Klicken Sie auf Tools> Vorgänge> Web-Konsole, um die Konfiguration der Web-Konsole zu öffnen.
  3. Bearbeiten Sie das Day CQ DAM-Ressourcensammlungs-Servlet. Wählen Sie E-Mail senden. Klicken Sie auf Speichern.

Auf dieser Seite