Menü der Dokumentation

Definieren von E-Mail-Benachrichtigungen

Definieren Sie im Bereich E-Mail- Benachrichtigungen, ob E-Mail Benachrichtigungen versendet werden sollen und ob Personen bei ihrer Erwähnung in verfügbaren Feldern per E-Mail darüber benachrichtigt werden sollen.

Hilfe im Eingabefeld erhalten Sie mit der Tastenkombination STRG+Leerzeichen. Sie erhalten z.B. Auswahlmöglichkeiten zum Bestätigen oder Mausklick.

So geht's

  1. Erstellen Sie einen neuen Bereich beginnend mit "{" und abschließend mit "},".

  2. Definieren Sie "enableSending" mit dem Wert true.

    Das bedeutet, dass der gesamte E-Mail-Versand aktviert wird. Deaktivierung erfolgt mit dem Wert false.

  3. Definieren Sie "active" mit dem Wert true oder false.

  4. Fügen Sie die Aufzählung "fields" hinzu.

  5. Fügen Sie für das zu Konfigurierende einen Bereich hinzu.

  6. Sichern Sie die Änderungen mit Speichern.

In folgenden Fällen können Sie Personen benachrichtigen lassen, wenn ihr jeweiliger Name in das Feld eingetragen wurde:

  • Verantwortliche PersonSetzen Sie die Eigenschaft "internalFieldName" auf den Wert "ecsResponsible".Setzen Sie die Eigenschaft "templateName" auf den Wert "ecsResponsible".

  • Zusätzlich lesenden Zugriff gewähren fürSetzen Sie die Eigenschaft "internalFieldName" auf den Wert "ecsPermissionRead".Setzen Sie die Eigenschaft "templateName" auf den Wert "ecsPermissionRead".

  • Zusätzlich schreibenden Zugriff gewähren fürSetzen Sie die Eigenschaft "internalFieldName" auf den Wert "ecsPermissionWrite".Setzen Sie die Eigenschaft "templateName" auf den Wert "ecsPermissionWrite".

Folgende Felder stehen Ihnen sowohl für neu erstellte als auch für geänderte Verträge zur Verfügung. Fügen Sie zum jeweiligen Bereich hinzu:

  • Für geänderte Verträge: Die Eigenschaft "onChange" mit dem Wert true oder false.

  • Für neu erstellte Verträge: Die Eigenschaft "onCreate" mit dem Wert true oder false.

Bitte beachten Sie, für die konfigurierten Felder nur an neu eingetragene Personen eine Benachrichtigung gesendet wird.

Zur vorherigen Bearbeitungsversion zurückkehren

Sie können jederzeit Ihre Änderungen verwerfen und zur vorherigen Bearbeitungsversion zurückkehren.

So geht's

  • Öffnen Sie E-Mail-Benachrichtigungen. Ihre Konfiguration erscheint.

  • Klicken Sie auf Die vorherige Konfiguration anzeigen.

  • Klicken Sie auf Zurücksetzen, um zur vorherigen Version zurückzukehren. Die vorherige Version wird automatisch gespeichert.

Alle Änderungen an der aktuellen Version verwerfen

Sie können jederzeit ihre Änderungen an der aktuellen Version mit einem Klick auf Änderungen verwerfen löschen.

Speichern ist nicht möglich

Prüfen Sie, ob Sie nach dem letzten Speichern keine Änderungen vorgenommen haben. In diesem Fall ist die Speichern-Schaltfläche ausgegraut.

Beispiel

Im folgenden Beispiel werden Benachrichtigungen versendet wenn:

  1. Die Verantwortliche Person bei Vertagsanlage oder -änderung bearbeitet wird.

  2. Die Benutzer unter Zusätzlich lesenden Zugriff gewähren für werden bei einer Vertragsänderung bearbeitet.

  3. Die Benutzer unter Zusätzlich schreibenden Zugriff gewähren für werden bei einer Vertragsänderung bearbeitet.

Beispielkonfiguration

{
    "general": {
        "enableSending": true
    },
    "personalNotification": {
        "active": true,
        "fields": [
            {
                "internalFieldName": "ecsResponsible",
                "templateName": "ecsResponsible",
                "onChange": true,
                "onCreate": false
            },
            {
                "internalFieldName": "ecsPermissionRead",
                "templateName": "ecsPermissionRead",
                "onChange": true,
                "onCreate": true
            },
            {
                "internalFieldName": "ecsPermissionWrite",
                "templateName": "ecsPermissionWrite",
                "onChange": true,
                "onCreate": true
            }
        ]
    }
}

Sie können die E-Mail-Vorlagen über die gesonderte Konfiguration für E-Mail-Vorlagen anpassen.

Übersicht der E-Mail-Vorlagen

Das Vertragsmanagement verfügt über einige Vorlagen für E-Mail-Benachtigungen. Im Folgenden werden diese Vorlagen beschrieben und die verwendeten Platzhalter aufgelistet.

  • Vertrag wurde automatisch verlängert

contract.automaticTermination: Kündigungsstichtag des Vertrags erfordert manuelle Aktion.

contract.subject: Vertragsgegenstand

contract.newContractEnd: Nächstmögliches Vertragsende.

contract.ecsContractEnd: Vorheriges Vertragsende.

contract.newTerminationDate: Nächstmöglicher Kündigungsstichtag.

contract.ecsTerminationDate: Vorheriger Kündigunsstichtag.

contract.url: URL zum Vertrag.

  • Lesezugriff wurde auf einen Vertrag erteilt

contract.ecsSubjectOfContract: Vertragsgegenstand.

contract.contractType: Vertragstyp.

contract.contractualPartner: Vertragspartner.

contract.url: URL zum Vertrag.

  • Schreibzugriff wurde auf einen Vertrag erteilt

contract.ecsSubjectOfContract: Vertragsgegenstand.

contract.contractType: Vertragstyp.

contract.contractualPartner: Vertragspartner.

contract.url: URL zum Vertrag.

  • Neuer Vertrag wurde angelegt

contract.ecsSubjectOfContract: Vertragsgegenstand.

contract.contractType: Vertragstyp.

contract.contractualPartner: Vertragspartner.

contract.url: URL zum Vertrag.

  • Eine Aufgabe wurde zugewiesen

contract.subject: Vertragsgegenstand.

task.title: Titel der Aufgabe.

task.dueDate: Fälligkeitsdatum.

task.dueDate: Fälligkeitsdatum.

task.description: Beschreibung.

task.url: URL zur Aufgabe.

  • Eine Aufgabe ist fällig

contract.subject: Vertragsgegenstand.

task.title: Titel der Aufgabe.

task.dueDate: Fälligkeitsdatum.

task.description: Beschreibung.

task.url: URL zur Aufgabe.

task.note: Weitere Notizen.

  • Laufzeit eines Vertrages endet bald

contract.subject: Vertragsgegenstand.

contract.contractType: Vertragstyp.

contract.ecsNextTermination: Nächstmöglicher Kündigungsstichtag.

contract.ecsNextEnd: Nächstmögliches Vertragsende.

contract.note: Weitere Notizen.

contract.url: URL zum Vertrag.

Definieren und Bearbeiten von E-Mail-Vorlagen

Im Bereich E-Mail-Vorlagen können Sie die vorhandenen Standard-E-Mail-Vorlagen bearbeiten und eigene Texte hinterlegen.

Folgende Standard-E-Mail-Vorlagen stehen Ihnen zur Verfügung:

  • Vertrag wurde automatisch verlängert

  • Lesezugriff wurde auf einen Vertrag erteilt

  • Schreibzugriff wurde auf einen Vertrag erteilt

  • Neuer Vertrag wurde angelegt

  • Eine Aufgabe wurde zugewiesen

  • Eine Aufgabe ist fällig

  • Laufzeit eines Vertrages endet demnächst

Haben Sie eine E-Mail-Vorlage ausgewählt, können Sie nun zwischen den einzelnen Bereichen der E-Mail wechseln.

Sie haben die Möglichkeit, die drei folgenden Bereiche anzupassen:

  • Betreffzeile: Geben Sie hier den Betreff der E-Mail an.

  • HTML-Version: Ändern Sie hier die Darstellung der E-Mail und des inhaltlichen Texts. Hier können Sie z.B. die Textfarbe, Hintergrundfarbe, Schriftgröße und das Schriftformal ändern. Es handelt sich hier um den HTML-formatierten E-Mail-Körper.

  • Text-Version: Geben Sie hier den inhaltlichen Text der E-Mail an. Es handelt sich hier um den E-Mail-Körper mit nur Text.

Anmerkung

Ändern Sie immer sowohl die HTML-Version als auch die Text-Version.

Standard-E-Mail-Vorlagen für E-Mail ändern - So geht's

  1. Wählen Sie die gewünschte Vorlage aus.

  2. Wählen Sie im Auswahlfeld Textvorschlag, ob die die deutsche oder englische Vorlage überschreiben wollen.

    Die Standardvorlage bleibt im Hintergrund erhalten.

  3. Bestätigen Sie die Sicherheitsabfrage Sprache wechseln.

  4. Passen Sie die Betreffzeile, HTML-Version und Text-Version an.

  5. Speichern die die geänderte Vorlage.

Wie erkenne ich, ob die Standard-E-Mail-Vorlage oder einer bereits geänderte Vorlage benutzt wird?

Sie erkennen dies daran, dass Sie eine bereits geänderte Vorlage löschen können. Neben der Speichern-Schaltfläche erscheint eine neue Schaltfläche Anpassungen verwerfen und Standardvorlage verwenden.

Außerdem ist das Auswahlfeld Textvorschlag nicht verfügbar.

Mit einem Klick auf Anpassungen verwerfen und Standardvorlage verwenden gelangen Sie zur Standardvorlage zurück.

Zur Standard-E-Mail-Vorlage zurückzukehren - So geht's

  1. Wählen Sie eine von Ihnen geänderte Vorlage aus.

  2. Löschen Sie diese Vorlage, indem Sie auf Anpassungen verwerfen und Standardvorlage verwenden klicken.

  3. Die entsprechende Standard-E-Mail-Vorlage ist wieder verfügbar.

Auswahl der Benutzersprache

Standardmäßig können Sie die Texte in Deutsch oder Englisch verwenden.

Anpassung der Übersetzungen in Deutsch oder Englisch

Sobald Sie Änderungen an einer Vorlage in Deutsch oder Englisch vornehmen, wird ausschließlich diese geänderte E-Mail-Vorlage verwendet.

Verwenden von E-Mail-Vorlagen in einer anderen Sprache

Sie haben die Möglichkeit eine andere Sprache als Deutsch oder Englisch zu verwenden.

So geht's

  1. Wählen Sie eine Vorlage aus.

  2. Wählen Sie im Auswahlfeld Textvorschlag, ob die die deutsche oder englische Vorlage überschreiben wollen.

    Die Standardvorlage bleibt im Hintergrund erhalten.

  3. Bestätigen Sie die Sicherheitsabfrage Sprache wechseln.

  4. Editieren Sie die Betreffzeile, HTML-Version und Text-Version in der gewünschten Sprache.

  5. Sichern Sie die Änderungen mit einem Klick auf Speichern.

Verwenden von E-Mail-Vorlagen in mehreren Sprachen

Sie haben die Möglichkeit eine E-Mail-Vorlage mit mehreren Sprachen zu verwenden. In der E-Mail, die der Benutzer erhält, sind die einzelnen Sprachen untereinander aufgeführt.

So geht's

  1. Wählen Sie eine von Ihnen geänderte Vorlage aus.

  2. Wählen Sie im Auswahlfeld Textvorschlag, ob die die deutsche oder englische Vorlage überschreiben wollen.

    Die Standardvorlage bleibt im Hintergrund erhalten.

  3. Bestätigen Sie die Sicherheitsabfrage Sprache wechseln.

  4. Kopieren Sie auf den Registerkarten Betreffzeile, HTML-Version und Text-Version den Inhalt.

  5. Fügen Sie diesen Inhalt für jede zu verwendende Sprache unter den bestehenden Inhalt.

  6. Editieren Sie die Betreffzeile, HTML-Version und Text-Version in den gewünschten Sprachen.

  7. Sichern Sie die Änderungen mit einem Klick auf Speichern.

Welche Platzhalter können in E-Mail-Benachtigungen verwendet werden?

In E-Mail-Benachrichtigungen stehen Ihnen Platzhalter zur Verfügung. Sie können Platzhalter sowohl im Betreff als auch im Text der E-Mail verwenden.

Welche es gibt und welche Metadaten vom Vertrag bzw. der Aufgaben wofür stehen, entnehmen Sie bitte der nachfolgenden Liste.

So geht's

  1. Achten Sie auf die casesensitive Schreibweise.

  2. Setzen Sie einen Platzhalter in der E-Mail-Vorlage in doppelt geschweifte Klammern.

    Beispiel: {{ contract.subjectOfContract }}

  3. Verwenden Sie immer nur genau einen Platzhalter innerhalb der geschweiften Klammern.

  4. Setzen Sie Datumswerten den Befehl formateDate voran.

    Beispiel: {{ formatDate contract.newDateOfCancelation }}

Verfügbare Platzhalter für Vertrags-bezogene Benachrichtigungen:

contract.subjectOfContract: Vertragsgegenstand.

contract.url: Link zum Vertrag.

contract.contractStartDate: Vertragsbeginn.

contract.calculatePeriods: Zeigt an, ob Berechnungen für diesen Vertrag aktiviert sind. (Mögliche Werte: true / false)

contract.endOfContract: Manuell hinterlegtes Vertragsende (wenn Berechnungen deaktiviert). Berechnetes Vertragsende (wenn Berechnungen aktiviert).

contract.dateOfCancelation: Manuell hinterlegter Kündigungsstichtag (wenn Berechnungen deaktiviert). Berechneter Kündigungsstichtag (wenn Berechnungen aktiviert).

contract.contractType: Vertragstyp.

contract.contractualPartner: Name des Vertragspartners.

contract.contactPersonOfTheContractualPartner: Kontaktperson des Vertragspartners.

contract.additionalNoteInTheTextOfTheEMail: Zusätzlicher Text, welcher in der versendeten E-Mail dargestellt werden soll.

contract.notificationStart: Startdatum der Benachrichtigung.

contract.responsiblePersonInternal: Name des Vertragsverantwortlichen.

contract.contractId: Automatisch vergebene ID des Vertrags.

In der Benachrichtigung nach automatischer Verlängerung eines Vertrages stehen zusätzliche Platzhalter zur Verfügung:

contract.newEndOfContract: Neues, berechnetes Vertragsende (wenn Berechnungen für dieses Feld möglich sind).

contract.newDateOfCancelation: Neuer, berechneter, nächstmöglicher Kündigungsstichtag (wenn Berechnungen für dieses Feld möglich sind).

Verfügbare Platzhalter für Aufgaben-bezogene Benachrichtigungen:

contract.subjectOfContract: Vertragsgegenstand.

task.contractId: Automatisch vergebene ID des Vertrags.

task.title: Titel der Aufgabe.

task.dueDate : Fälligkeitsdatum der Aufgabe.

task.description: Beschreibung der Aufgabe.

task.url: Link zur Aufgabe bzw. deren Vertrag.

task.note: Zusätzlicher Text, welcher in der versendeten E-Mail dargestellt werden soll.

Wie werden alle E-Mail-Benachrichtigungen deaktiviert?

Innerhalb der Konfiguration ist es nun möglich, die E-Mail-Benachrichtigungen vollständig zu deaktivieren. Diese Einstellung kann über true oder false am Parameter enableSending aktiviert oder deaktiviert werden.

Im Standard sind die E-Mail-Benachrichtigungen aktiviert.

Beispielkonfiguration:

Beispielkonfiguration für E-Mails (Auszug)

...
"mailSettings": {
        "general": {
            "enableSending": true
        },
        "personalNotification": {
            "active": true,
            "fields": [
                {
                    "internalFieldName": "ecsResponsible",
                    "templateName": "ecsResponsible",
                    "onChange": true,
                    "onCreate": false
                },
                {
                    "internalFieldName": "ecsPermissionRead",
                    "templateName": "ecsPermissionRead",
                    "onChange": true,
                    "onCreate": true
                },
                {
                    "internalFieldName": "ecsPermissionWrite",
                    "templateName": "ecsPermissionWrite",
                    "onChange": true,
                    "onCreate": true
                }
            ]
        }
    }
...