Skript für Platzhalter (Serienbriefe und Serienmails)

Erweitern Sie das Plug-in agorum core fill template um eigene Platzhalter für Serienmails und Serienbriefe mithilfe eines Skripts. Anhand eines Beispiels lernen Sie, welche Anpassungen Sie vornehmen müssen.

Den Skript-Editor öffnen

---

Neue Platzhalter und dazugehörige Skripte greifen nicht global, sondern immer für die entsprechende Vorlage. Entscheiden Sie deswegen zuerst, ob Sie Anpassungen an Platzhaltern für eine Dokument- oder E-Mail-Vorlage umsetzen möchten. Anschließend legen Sie für die jeweilige Vorlage ein Skript über den Skript-Editor an.

Voraussetzungen

• Ihr Benutzer muss als Administrator eingerichtet sein, damit Sie den Skript-Editor öffnen können.

Fall 1: Den Skript-Editor der E-Mail-Vorlage öffnen

1. Bearbeiten oder erstellen Sie eine neue E-Mail-Vorlage über die Kontextmenü-Aktion agorum core fill template > Erstellung neuer E-Mail-Vorlage.
   
   Ergebnis: Ein Dialog öffnet sich.

2. Klicken Sie auf die Registerkarte Script.

 

Schaltfläche	Beschreibung
Init Script	Löscht das vorhandene Skript und stellt ein leeres Skript bereit.
Default Script laden	Kopiert den Inhalt des Default-Skripts in den Editor, um als Basis zur Erstellung eigener Platzhalterdefinitionen zu dienen.
Script testen	Öffnet einen Dialog, mit der Sie das Skript mit Adressobjekten testen können.

Fall 2: Den Skript-Editor der Dokumentvorlage öffnen

1. Definieren Sie ein Dokument als Vorlage.

2. Öffnen Sie den Editor über die Kontextmenü-Aktion agorum core fill template > Dokument - Vorlagen-Script anlegen / bearbeiten.
   
   Ergebnis: Ein Dialog öffnet sich.

Ein eigenes Skript definieren

---

Besonderheiten des Skripts

• Wenn der Vorlage kein Skript zugeordnet ist oder das zugeordnete Skript leer ist (0 Zeichen hat), ruft das System das zur Verfügung stehende Default-Skript auf.
• Wenn der Vorlage ein Skript zugeordnet ist, ruft das System dieses Skript auf.
• Beginnen Sie ein Skript immer mit folgender Zeile:

/* global data */

In data wird ein object übergeben, in dem alle Platzhalter stehen, die Sie in Ihrer Platzhalterliste sehen.

Beispiel von data in JSON-Schreibweise

data = {
  "Zip": "",
  "Email": "paula.demo-ticket@ticket-demo-gmbh.com",
  "FamilyName": "Demo-Ticket",
  "ZipPostBox": "",
  "GivenName": "Paula",
  "WelcomeMessage": "",
  "PostBox": "",
  "Salutation": "Frau",
  "CityPostBox": "",
  "PrintDate": "2020-05-09T16:46:13.767Z",
  "Number": 123456789.98765433,
  "Boolean": true,
  "DateOfBirth": "1982-06-20T11:00:00.000Z",
  "Street1": "",
  "Datum": "09.05.2020",
  "Organisation": "Ticket Demo GmbH",
  "HouseNumber1": "",
  "Title": "",
  "Filename": "mail _Paula Demo-Ticket_1172085.html",
  "TextAnrede": "Sehr geehrte",
  "SalutationRaw": "mrs",
  "City": "",
  "State": "",
  "Long": 1172085,
  "Country": "",
  "PhoneNumber": "+49 711 3461060",
  "CountryRaw": "",
  "Link": ""
}

Beispiel zur Wertübergabe eines Platzhalters

data.NeuerPlatzhalter = 'Das ist mein neuer Platzhalter';

Das System gibt das Objekt data mit den ergänzten und / oder geänderten Platzhaltern als Wert zurück. Das Objekt steht dann für die Ersetzung der Platzhalter zur Verfügung.

Das Skript einbauen und die Vorlage überarbeiten

1. Klicken Sie im Skript-Editor auf die Schaltfläche Default Script laden.
2. Passen Sie das Beispielskript an.

   Hinweis: Überprüfen Sie per JavaScript, welche Metadaten im Adressobjekt vorliegen. Basierend auf diesen Metadaten erstellt das System eine entsprechende Ansprache.
   
   • Wenn eine Anrede im Adressobjekt fehlt, setzt das System als Ansprache im Serienbrief / Serienmail automatisch den Text Sehr geehrte Damen und Herren.
   • Wenn Sie das Adressobjekt mit dem Anrede-Wert Familie oder Herr und Frau samt Angabe eines Nachnamens versehen haben, formuliert das System die Ansprache automatisch um zu Sehr geehrte Frau <Nachname> , Sehr geehrter Herr <Nachname>.
   
   Diese abgeänderte Anrede greift, wenn Sie einen neuen Platzhalter namens LetterSalutation1 verwenden.

3. Speichern Sie.

Das Skript testen

---

1. Klicken Sie im Skript-Editor auf die Schaltfläche Script testen.
   
   Ergebnis: Ein Dialog öffnet sich.
2. Wählen Sie links Adressobjekte.
   
   Ergebnis: Sie sehen im rechten Bereich das Skript-Ergebnis.

Fehler beim Testen

Fehler sehen Sie direkt im Editor sowie beim Testen.