HTML-Vorlagen
Für die Erstellung von Berichten können auch Vorlagen im html-Format verwendet werden. Diese werden zum Beispiel verwendet, um den Inhalt einer Nachricht zu generieren, wenn E-Mails über den internen Mail-Client versendet werden sollen.
Erstellung und Bearbeitung von Vorlagen
Im Optionenmodul können HTML-Vorlagen über den diaLIMS-internen HTML-Vorlagen-Editor verarbeitet werden. Die Option HTML-Vorlagen-Editor ist unter der Option Allgemein zu finden.

Die Vorlagendatei kann ohne Kenntnis der HTML-Syntax erstellt und bearbeitet werden. Die Formatierungsmöglichkeiten sind identisch wie in allen Textfeldern mit Formatierungsmöglichkeit. Die Erstellung erweiterter Formatierungen wie z.B. Tabellenansichten sind über den Editor nicht möglich. Bereits existierende Vorlagendateien mit erweiterter Formatierung können jedoch ebenfalls angezeigt und bearbeitet werden.
Es gibt allgemein übliche Funktionen zum Speichern und Öffnen von Dateien:
-
Neue Datei erstellen
Leert den Textbereich, um eine neue Vorlagendatei zu erstellen.
Gibt es ungespeicherte Änderungen, erscheint ein Nachfragedialog zum weiteren Vorgehen: Die vorherige Vorlage kann verworfen, gespeichert oder im Editor behalten werden.
-
Datei öffnen
Zeigt einen Dateiauswahldialog an und lädt den Inhalt der gewählten HTML-Vorlagendatei.
Im Dateiauswahldialog werden nur HTML-Vorlagendateien angezeigt mit dem Präfix "Report." und einer HTML-Dateiendung.
Gibt es ungespeicherte Änderungen, erscheint ein Nachfragedialog zum weiteren Vorgehen: Die vorherige Vorlage kann verworfen, gespeichert oder im Editor behalten werden.
-
Datei speichern
Speichert den angezeigten Inhalt in der Datei.
Handelt es sich um eine neue Vorlage, die bisher noch nicht gespeichert wurde, so erscheint ein Dateiauswahldialog zum Speichern. Das Verzeichnis und der Dateiname können frei gewählt werden. Es wird empfohlen, einen Dateinamen zu wählen, der mit "Report." beginnt, um kenntlich zu machen, dass es sich um eine Vorlagendatei handelt. Die Datei enthält automatisch eine HTML-Dateiendung.
-
Datei speichern unter...
Öffnet einen Dateiauswahldialog zum Speichern. Ist bereits eine Datei geladen, so wird diese Datei als Speicherort vorgeschlagen. Das Verzeichnis und der Dateiname können jedoch frei gewählt werden. Es wird empfohlen, einen Dateinamen zu wählen, der mit "Report." beginnt, um kenntlich zu machen, dass es sich um eine Vorlagendatei handelt. Die Datei enthält automatisch eine HTML-Dateiendung.
Der Dateiname der aktuell geladenen Datei wird rechts neben den Schaltflächen angezeigt. Führt man den Mauszeiger über den Dateinamen, wird im Tooltip-Text der komplette Dateipfad angezeigt.
CAUTION:
Beim Bearbeiten und Speichern bereits vorhandener HTML-Vorlagendateien gehen erweiterte Formatierungen ggf. verloren.
Alternativ lassen sich HTML-Vorlagen mit jedem Textverarbeitungsprogramm erstellen. MS Word und OpenOffice konvertieren die erstellten Dateien beim Speichern automatisch, wenn Sie beim "Speichern unter..." den Eintrag .html wählen.
Weiterhin können Sie Vorlagen über einfache Texteditoren erstellen. Da hier meist nur das .txt-Format zulässig ist und keine Textauszeichnungen möglich sind, müssen hier die Absätze, Überschriften und sonstige Textformatierungen manuell durch Tags definiert werden.
Aufbau der Vorlagen
Der Aufbau der Datei muss den HTML-Richtlinien entsprechen.
Innerhalb der Datei können Funktionen und Berichtscontroller-Methoden wie bei Word-Berichtsvorlagen verwendet werden.
Formatierungen
Damit aufeinanderfolgende oder führende Leerzeichen im fertigen HTML-Bericht angezeigt werden, werden alle Leerzeichen durch ein erzwungenes HTML-Leerzeichen ersetzt.
Optional kann diese Funktion ausgeschaltet werden. Dazu muss in der Vorlagendatei im Run-First-Skript folgende Zeile aufgerufen werden:
Printer.preserveSpaces = false;
Funktionen für E-Mail-Vorlagen
Speziell in HTML-Vorlagen für den E-Mail-Versand gibt es Möglichkeiten, neben dem Inhalt auch weitere E-Mail-Inhalte direkt in der Vorlagendatei zu setzen. Diese werden im Run-First-Skript gesetzt.
Der Betreff der E-Mail kann durch Setzen des Feldes Mail.betreff direkt gesetzt werden.
Beispiel: Mail.betreff = "Bestätigung für " + o.kurzbezeichnung;
Über die Methode Mail.addAttachment() können direkt Anhänge hinzugefügt werden. Durch mehrmaliges Aufrufen der Methode können sogar mehrere Dateien angehängt werden.
Beispiel: Mail.addAttachment("C:/Users/Mustermann/Beispieldatei.pdf");
Benennung der Vorlagen
Die Benennung der Berichtsvorlagen folgt einem einfachen Schema:
-
Report
Kennzeichen, dass es sich bei der Datei um eine Berichts- oder E-Mail-Vorlage handelt.
-
<Modul>
Modul- bzw. Klassenname des Objektes, für welches die Vorlage verwendet wird.
-
<Beschreibung>
Bezeichnung der Vorlage für den Verwendungszweck
Anhand der ersten beiden Angaben wird bei der Auswahl eine Filterung der Vorlagen für das jeweilige Modul vorgenommen.
Das Trennzeichen zwischen den einzelnen Namensbestandteilen ist immer ein Punkt.
Der komplette Name einer Vorlage für eine Info-Mail zu einer Probe könnte also lauten:
Report.Probe.Infomail.html