Zum Hauptinhalt springen

Vorlagen

Das Modul Vorlagen wird für die Organisation aller Vorlagen genutzt, die im diaLIMS verwendet werden können.

Vorlagen haben, zusätzlich zu den allgemeinen Dokumenteigenschaften, einen Verwendungszweck und Zuordnungen zu Datensatztypen.

Folgende Verwendungszwecke sind für eine Vorlage konfigurierbar:

Zweck

Bemerkung

E-Mail

Diese Vorlage wird in im E-Mail-Versenden Dialog angezeigt.

Bericht

Diese Vorlage wird im Drucken-Dialog angezeigt.

Prüfbericht

Diese Vorlage wird im Prüfbericht-Drucken-Dialog angezeigt.

Etikett

Diese Vorlage wird im Etikett-Drucken-Dialog angezeigt.

Außerdem muss eine Zuordung zu einem Datensatztyp erfolgen. Vorlagen, die einem Datensatztyp zugeordnet sind, werden nur in den Dialogen des jeweiligen Moduls bzw. der jeweiligen Maske angezeigt.

Wird beispielsweise der Drucken-Dialog des Proben-Moduls geöffnet, werden ausschließlich die Vorlagen zur Auswahl angeboten, die den Datensatztyp "Probe" und den Verwendungszweck "Bericht" haben. Ist ein Bericht als E-Mail gekennzeichnet, so wird er dem Benutzer im E-Mail-Senden-Dialog angezeigt.

Berechtigungssteuerung für Vorlagen​

Mit der Funktion können Sie einer Vorlage Benutzer oder Benutzergruppen zuordnen. Die Vorlage wird dann nur den Benutzern für die Verwendung angezeigt, die der Vorlage zugeordnet sind oder deren aktive Benutzergruppe der Vorlage zugeordnet ist.

Funktion benutzen​

  1. Öffnen Sie das Modul Vorlagen
  2. Wechseln sie auf die Notizbuchseite Benutzer/-gruppen
  3. Verwenden sie die Tabellen-Aktionen der angezeigten Tabellen, um die Benutzer und Benutzergruppen hinzuzufügen, die die Vorlage verwenden sollen

Die erstellten Zuordnungen wirken sich auf die im Folgenden angegebenen Funktionen aus:

  • Auswahl einer Vorlage beim Erstellen eines Berichts, Prüfberichts oder von Etiketten
  • Auswahl einer E-Mail-Vorlage
  • Auswahl eines Etiketts für Proben oder Chargen
  • Auswahl einer Vorlage in F4-Dialogen (ausgenommen ist die erweiterte Suche im Modul Vorlagen)

Skriptsprachen für Vorlagen einstellen​

Skriptsprachen für Vorlagen einstellen​

Mit der Funktion können Sie auswählen, mit welcher Skriptsprache eine Vorlage evaluiert wird. Zur Auswahl stehen BSH und Groovy.

  1. Öffnen Sie das Modul Vorlagen.
  2. Wählen Sie die Vorlage, deren Skriptsprache Sie einstellen möchten.
  3. Verwenden Sie die Auswahlschaltfläche Skriptsprache auf der Name-Seite der Vorlage, um die gewünschte Sprache auszuwählen.
  4. Speichern Sie die Änderungen an der Vorlage.

Alle zukünftig mit dieser Vorlage erstellten Dokumente werden nun mit der ausgewählten Skriptsprache evaluiert.

Migration der Skripte​

Schrittweise soll die Skriptsprache BSH durch die Skriptsprache Groovy ersetzt werden. BSH wird nur noch bedingt weiterentwickelt, während Groovy stetig um neue Funktionen erweitert wird. So kann eine sicherere Umsetzung von Vorlagen-Skripten erzielt werden.

Die Skriptsprachen BSH und Groovy unterscheiden sich etwas in der Syntax. Während viele Vorlagen, die in BSH erstellt wurden, ohne Anpassungen mit Groovy verwendet werden können, müssen einige syntaktisch migriert werden.

Migration​

In der folgenden Tabelle werden einige Unterschiede zwischen den Skriptsprachen anhand von Beispiel-Code aufgeführt, die bei der Anpassung der Vorlagen hilfreich sein können.

Code in BSH

Code in Groovy

Erklärung

methodeImRunFirstSkript(zahl) {
return zahl * 3;
}
methodeImRunFirstSkript = (zahl) → {
return zahl * 3;
}

Damit Methoden in der gesamten Vorlage zur Verfügung stehen, müssen diese in Groovy als "Closures" deklariert werden. Andernfalls können diese nur innerhalb des Skripts (z.B. nur im Run-First-Skript) verwendet werden und sind für andere Stellen in der Vorlage nicht sichtbar.

return probe + " Suffix";
return probe.toString() + " Suffix";

// bzw.

return "" + probe + " Suffix";

Der Operator "+" kann in Groovy überladen werden und wird anhand des linken Operanden bestimmt. Damit also eine Zeichenkette aus der Textrepräsentation der Probe und des Textes " Suffix" generiert werden kann, muss der linke Operand vom Typ Text (String) sein.

user = Benutzer;
user = this.Benutzer;

Auf einige Variablen kann in Groovy u.U. nicht direkt zugegriffen werden, wenn diese den gleichen Namen tragen, wie Java-Klassen, die im Skript zur Verfügung stehen. Mit dem Präfix "this." kann dem Interpreter mitgeteilt werden, dass es sich um eine Variable bzw. ein Attribut handelt.

if(probe != void) {
...
}
if(binding.hasVariable('probe')) {
...
}

Die Prüfung, ob eine Variable existiert muss unter Groovy mit einem Methodenaufruf erfolgen.
Wichtig ist hier, dass die Variable mit dem Apostroph-Zeichen (') umschlossen wird.