DB-Templates kennenlernen
Dieser Artikel erklärt, was DB-Templates sind, wofür Noahworks sie nutzt und wie sie funktionieren.
Inhalte des Artikels: Springe durch Klick auf das Thema direkt zum jeweiligen Absatz.
Was sind DB-Templates?
DB-Templates sind gespeicherte, datenbasierte Vorlagen in Noahworks. Sie legen fest, wie eine spätere Ausgabe aufgebaut ist, welche Inhalte sie enthält und wie sie dargestellt wird. Dazu gehören nicht nur Texte, sondern auch Gestaltungselemente wie Logos, Farben, Kopfzeilen und Fußzeilen. Noahworks ruft diese Vorlagen ab, wenn eine bestimmte Ausgabe erstellt wird.
Jedes DB-Template enthält feste Bestandteile und dynamische Platzhalter. Feste Bestandteile bleiben in jeder Ausgabe gleich. Platzhalter ersetzt Noahworks durch Daten aus dem jeweiligen Vorgang, zum Beispiel die Ansprache einer zu kontaktierenden Person.
Noahworks unterscheidet drei Kategorien von DB-Templates
- E-Mail-Vorlagen
- Dokumenten-Vorlagen
- View-Vorlagen (Vorlagen für die Ansicht im Browser)
E-Mail-Vorlagen nutzt Noahworks für E-Mails. Dazu gehören zum Beispiel Bestätigungen, Benachrichtigungen oder andere automatisch erzeugte Nachrichten.
Dokumenten-Vorlagen nutzt Noahworks für Dateien oder Dokumente. Dazu gehören zum Beispiel PDFs, Bescheide, Anträge, Bestätigungen oder andere erzeugte Dokumente.
View-Vorlagen nutzt Noahworks für Ansichten im Browser. Eine View ist eine Seite oder Ansicht, die im Browser angezeigt wird.
Prüfe deshalb zuerst, welche Kategorie von Ausgabe du ändern möchtest:
- Soll eine E-Mail anders aussehen? Dann suche nach einer E-Mail-Vorlage.
- Soll ein erzeugtes Dokument anders aussehen? Dann suche nach einer Dokumenten-Vorlage.
- Soll eine Ansicht im Browser anders aussehen? Dann suche nach einer View-Vorlage.
Was bedeuten die Zahlen 0, 1 und 2?
Vor jedem DB-Template steht eine Zahl. Diese Zahl zeigt, auf welcher Ebene die Vorlage gilt. Es gibt drei Ebenen:
- Ebene 0
- Ebene 1
- Ebene 2
Die Zahl für die Ebene steht an erster Stelle (rosa markiert). Nicht jedes Noahworks-Modul nutzt alle Ebenen. Aktuell gibt es die Ebenen vor allem bei NoahFörderung und NoahHaus. NoahEvent nutzt diese Ebenen derzeit nicht vollständig.
Ebene 0: Vorlage gilt allgemein
Eine Vorlage auf Ebene 0 gilt allgemein. Sie ist global und nicht auf einen bestimmten Mandanten begrenzt.
Das bedeutet:
Wenn du eine Vorlage auf Ebene 0 änderst, wirkt sich die Änderung auf mehrere oder alle Mandanten aus. Nutze Ebene 0 nur, wenn die Änderung wirklich für alle betroffenen Mandanten gelten soll.
Beispiel:
Die allgemeine Struktur einer Bestätigungs-E-Mail soll überall gleich sein. Dann kann die Vorlage auf Ebene 0 passen.
Ebene 1: Vorlage gilt für einen bestimmten Mandanten
Eine Vorlage auf Ebene 1 gilt für genau einen Mandanten.
Das bedeutet:
Du überschreibst die allgemeine Vorlage nur für diesen einen Mandanten. Andere Mandanten verwenden weiter die allgemeine Vorlage oder ihre eigene angepasste Vorlage. Nutze Ebene 1, wenn ein Mandant (eine Einrichtung, ein Standort oder ein Arbeitsbereich) eine eigene Formulierung braucht.
Beispiel:
Ein Mandant möchte eine eigene Grußformel oder eigene Kontaktdaten in einer E-Mail verwenden. Dann kann eine Vorlage auf Ebene 1 passen.
Ebene 2: Vorlage gilt noch spezifischer
Eine Vorlage auf Ebene 2 ist noch genauer. Sie ist app-spezifisch oder bezieht sich auf eine konkrete Art von Vorgang.
Das bedeutet:
Die Vorlage gilt nicht nur für einen bestimmten Mandanten. Sie gilt zusätzlich für einen bestimmten fachlichen Zusammenhang. Das kann zum Beispiel eine bestimmte Art von Maßnahme, Belegung oder Vorgang sein. Nutze Ebene 2 nur, wenn die Änderung wirklich nur für diesen speziellen Mandanten gelten soll.
Beispiel:
Eine bestimmte Art von Maßnahme braucht eine andere Formulierung als andere Maßnahmen desselben Mandanten. Dann kann eine Vorlage auf Ebene 2 passen.
Ein Beispiel für eine E-Mail-Vorlage
Bei Hallo {{ first_name }} ersetzt Noahworks den Inhalt der geschweiften Klammer (den Platzhalter) durch den passenden Vornamen. In der rausgeschickten E-Mail steht dann bspw. Hallo Anna.
DB-Templates steuern damit nicht nur den Text. Sie bestimmen auch Aufbau und Darstellung.
Was wird meist in DB-Templates eingesetzt?
DB-Templates enthalten meist Bestandteile, die wiederkehren. Dazu gehören zum Beispiel in einer E-Mail:
- Kopf- und Fußzeile
- Logo (rot markiert)
- Farben
- Gruß- und Schlussformel (blau markiert)
- Impressum und Kontaktangaben (orange markiert)
Diese Bestandteile sorgen für einen einheitlichen Aufbau. Sie helfen außerdem, wichtige Angaben in jeder Vorlage einzubinden.
Ein DB-Template kann zum Beispiel festlegen, dass eine E-Mail in der Kopfzeile das Logo zeigt. Danach folgt die Anrede mit Namen. Am Ende stehen Grußformel, Kontaktdaten und Impressum. So entsteht aus einer Vorlage eine E-Mail, die zum Design deiner Einrichtung passt.
DB-Templates basieren auf HTML oder RML
Die DB-Templates für E-Mails und Views (Online-Ansichten) basieren auf HTML, während die Vorlagen für Dokumente auf RML basieren. Der Grund dafür liegt in dem Ziel.
HTML
HTML ist keine Programmiersprache im klassischen Sinn. Man schreibt damit keine komplexe Logik wie „Wenn dies passiert, dann tue das“. Stattdessen beschreibt HTML, welche Inhalte in einer Vorlage vorkommen und welche Bedeutung sie haben.
Mit HTML lassen sich zum Beispiel Überschriften, Absätze, Zeilenumbrüche, Verlinkungen, Hervorhebungen und Listen einfügen. Die HTML-Tags sorgen dafür, dass die spätere E-Mail oder das View basierend auf der Vorlage lesbar erscheint.
Mehr dazu erfährst du im Artikel Einfache HTML-Tags nutzen.
RML
RML ist ein XML-Dialekt zur Erstellung von PDF-Dateien, eine Art Bauplan für Dokumente. Noahworks liest diesen Bauplan und erzeugt daraus zum Beispiel ein PDF. Hier geht es um feste Seiten: A4, Seitenränder, Kopfzeile, Fußzeile, Seitenumbruch.
Platzhalter und HTML
In den DB-Templates für E-Mail- und View-Vorlagen gibt es einen Unterschied zwischen HTML-Tags und Platzhaltern.
- Ein
HTML-Tag wie <p>beschreibt den Aufbau der E-Mail, zum Beispiel beschreibt <p>: „Dieser Text ist ein Absatz.“ - Ein Platzhalter wie {{ first_name }} steht dagegen für eine Information, die später automatisch ersetzt wird, zum Beispiel durch den Vornamen des Empfängers.
-
Platzhalter markieren Stellen, an denen Noahworks konkrete Daten einfügt. Du erkennst sie an doppelten geschweiften Klammern.
-
HTML bestimmt also die Struktur und Darstellung, während Platzhalter die passenden Daten aus dem jeweiligen Vorgang einfügen.
Hinweis: Platzhalter haben eine feste Schreibweise. Ändere sie nur, wenn du ihre Bedeutung kennst.
Mehr dazu erfährst du im Artikel Platzhalter in Vorlagen verwenden.
Wo findest du die DB-Templates?
DB-Templates findest du in der Administration von Noahworks. Nutze am besten die Suchleiste. So findest du den Bereich leichter, auch wenn du ihn nicht regelmäßig öffnest.
- Öffne Noahworks.
- Klicke links im Menü in die Suchleiste.
- Suche nach DB-Templates.
- Öffne den Treffer.
- Setze dir bei Bedarf ein Lesezeichen.
Das Lesezeichen hilft dir, die DB-Templates später schneller aufzurufen.