Makros (ab Version 8)
Ein Makro stellt eine individuelle Funktion dar, die in einem Modul eingebunden und bestimmten Benutzern zugeordnet werden kann. Mittels eines Makros lassen sich kundenindividuelle Erweiterungen im Funktionsumfang eines Moduls realisieren oder die Nutzbarkeit bestehender Funktionen individuell beschränken.
Im Makromodul werden solche Funktionen erstellt und den jeweiligen Benutzern bereitgestellt. Werden einem Benutzer Makros in einem Modul zur Verfügung gestellt, so erscheinen diese im Menü "Makros" auf. Es werden nur zugelassene Makros angezeigt.
Das Makromodul
Das Makromodul befindet sich unter der Modulgruppe Administration. Hier können Makros erstellt und verwaltet werden. Das Modul besteht aus vier Reitern: Makro, Bemerkung, Status und Zusatz.
Der Reiter Makro zeigt die Konfiguration eines Makros an. Über diese Konfiguration wird die Funktionweise eines Makros definiert.
Konfiguration
Ein Makro lässt sich durch einige wenige Kopfdaten konfigurieren. Diese Einstellungen legen fest, wie und wann das Makro in einem Modul angezeigt wird und wie es verarbeitet wird.
Kurzbezeichnung
Die Kurzbezeichnung eines Makros ist eine interne Bezeichnung. Diese ist frei wählbar, muss dabei aber eindeutig sein, es können nicht zwei Makros dieselbe Kurzbezeichnung haben. Die Kurzbezeichnung hat allerdings keine weiteren Auswirkungen auf Darstellung oder Funktionalität des Makros.
Beschreibung
Die Beschreibung eines Makros ist die Bezeichnung, unter der das Makro im Modul angezeigt wird. Der Begriff sollte kurz, präzise und aussagekräftig sein.
Typ
Über den Typ wird gesteuert, wann das Makro (bzw. die entsprechende Schaltfläche) aktiviert wird. Je nach gewählten Typ, wird das Makro erst aktiv, wenn eine bestimmte Anzahl an Datensätzen selektiert wurde.
Der Typ Datensatzvalidierung ist ein spezieller Typ, der nur für die Datensatzvalidierung vorgesehen ist und dementsprechend nur ausgeführt werden soll, wenn ein bestimmter Statuswechsel erfolgt ist (siehe Kapitel Optionen)
In dem Makro-Skript kann die Variable isStatusChange verwendet werden, um zu prüfen, ob auch ein Statuswechsel erfolgt ist oder die Validierung nur durch das Speichern von Datensätzen ausgelöst wurde.
Hilfetext
Hier kann ein Text eingetragen werden, der dem Benutzer als Hilfe am Makro angezeigt wird, wenn er mit der Maus über die Funktion fährt.
Modulmakro
Dieser Schalter bestimmt, ob das Makro im eingestellten Modul angezeigt wird oder als globale Funktion in der diaLIMS-Hauptfunktionsleiste angeboten wird.
Datentyp
Der Datentyp eines Makros bestimmt, in welchem Modul das Makro eingebunden wird. Über eine Auswahlliste kann der Datentyp ausgewählt werden. Ein Makro kann immer nur einem Datentyp bzw. entsprechendem Modul zugewiesen sein. Wählt man beispielsweise den Datentyp Probe aus, so taucht das Makro im Probenmodul auf.
Symbol
Hier kann für das Makro ein passendes Symbol ausgewählt werden, das am Makro im jeweiligen Modul angezeigt wird.
Ordnung
Über die Ordnung kann eingestellt werden, in welcher Reihenfolge die Makro-Menü-Einträge angezeigt werden sollen. Die Ordnung muss dabei pro Modul eindeutig sein.
Hierarchiegruppen
Werden im diaLIMS viele Makros verwendet, so bietet es sich an, eine Struktur zur besseren Organisation und Sortierung dieser Makros anzulegen. Dies kann über die Zuweisung von Hierarchiegruppen erreicht werden. In den jeweiligen Modulen werden die Makros dann nach der zugeordneten Hierarchiegruppe strukturiert angezeigt.
Makros mit Hierarchiegruppen-Zuordnung werden in Untermenüs zuerst aufgeführt. Die Reihenfolge der Menüs ergibt sich aus der alphanumerischen absteigenden Sortierung nach Menüname. Die Reihenfolge der Makros hängt weiterhin von der, am Makro gesetzten, Ordnung ab.
Tastenkürzel
Über die Schaltfläche (rechts neben dem Textfeld) kann das Makro mit dem gewünschten Tastenkürzel (z.B.: Strg+Alt B) verknüpft werden. Es gibt bestimmte Tastenkürzel, die an dieser Stelle nicht erlaubt sind wie z.B.: "Strg S", zum Speichern eines Datensatzes. Eine manuelle Eingabe ist an dieser Stelle nicht möglich!
Benutzer zuweisen
Ein Makro erscheint im eingestellten Modul nur dann, wenn der angemeldete Benutzer diesem auch zugewiesen ist. Benutzer lassen sich über die rechte Tabelle Benutzer einem Makro zuweisen. An der Tabelle stehen drei Funktionen zur Auswahl:
Angemeldeten Benutzer zuordnen
Die Funktion ordnet dem angemeldeten Benutzer das selektierte Makro zu.
Zuordnung erstellen
Die Funktion öffnet einen Auswahldialog, in dem Benutzer ausgewählt werden können. Mit Bestätigen des Dialogs werden dem Makro alle ausgewählten Benutzer zugeordnet. Im Dialog werden nur die Benutzer angezeigt, die dem Makro noch nicht zugeordnet und nicht gesperrt oder storniert sind.
Zuordnung entfernen
Mit der dritten Funktion können selektierte Benutzerzuordnungen wieder entfernt werden. Den entfernten Benutzern steht die Funktion dann nicht mehr zur Verfügung.
Benutzergruppe zuweisen
Über die zweite Tabelle können Makros auch ganzen Benutzergruppen zugeordnet werden. Das Makro steht dann allen Benutzer zur Verfügung, die in dieser Gruppe sind und sich mit dieser Rolle am diaLIMS angemeldet haben.
Makros deaktivieren
Makros können einfach deaktiviert werden, indem sie gesperrt oder storniert werden. Es werden immer nur zugelassene Benutzerfunktionen angeboten, bzw. funktionieren immer nur zugelassene Bedingungsprüfungen.
Erstellen eines Makros
Grundsätzlich kann in das Textfeld für den Code alles reingeschrieben werden. Kann dies allerdings nicht interpretiert werden, so kommt es zu einer Fehlermeldung, das Makro kann so nicht ausgeführt werden. Damit es nicht zu Fehlern kommt, gilt es die Regeln zum Schreiben eines Makros zu beachten. Der Ersteller muss also Kenntnisse in der Programmiersprache Java besitzen.
Die Erstellung des Codes wird durch "Vordefinierte Aufrufe" unterstützt, die rechts neben dem Textbereich für den Code aufgelistet werden. Je Datentyp können im Framework (Controller des jeweiligen Typs) Methoden als vordefinierte Aufrufe deklariert werden (Annotation @Macro). Durch einen Doppelklick wird der Methodenaufruf dem Code hinzugefügt. Dabei werden die Methodenparameterwerte passend gesetzt. So werden z.B. der aktuelle Benutzer oder die ausgewählten Datensätze automatisch in den Methodenaufruf eingebaut, wenn die Methode über entsprechende Parameter verfügt. Wenn kein passender Parameterwert ermittelt werden kann, wird "null" mit dem Parametertypen (in Klammern) übergeben.
Standard-Makros
Swap Analyse
Verfügbar für Proben und Prüfpläne
Mit diesem Makro kann eine Analyse in beliebig vielen Proben oder Prüfplänen durch eine andere ersetzt werden. Dabei erscheint zunächst ein Dialog in dem die zu entfernende Analyse gewählt werden kann. Es findet dabei keine Filterung statt. Anschließend kann die Analyse gewählt werden die hinzugefügt werden soll. Dabei können nur zugelassene Analysen gewählt werden. Wird eine Methode ohne Ergebnisse gewählt, wird die Funktion abgebrochen.
Danach wird die Analyse ausgetauscht. Dabei bleibt die Reihenfolge erhalten, die neue Analyse wird also in die entstandene Lücke in der Ordnung eingefügt.
Handelt es sich um einen Analysenaustausch an Proben, so wird an den neuen Parametern der Prüfplan der entfernten Parameter gesetzt. Fertiggestellte/Stornierte Proben und Parameter werden ignoriert. Sind einzelne Parameter einer Methode an der Probe fertiggestellt oder storniert, kann die ganze Methode nicht getauscht werden.
Das Makro kann auch auf stornierten Prüfplänen nicht angewendet werden.
DBUpdate via Makro
Mit diesem Makro können Datenbank-Updates ausgeführt werden. Im Abschnitt Code müssen die einzelnen Update-Statements geschrieben werden, so als ob ein individueller Updater im UpdateController geschrieben wird. Es ist jedoch nur der Inhalt notwendig!
// Für den DBUpdater ist die Variable 'upd' zu verwenden! upd.executeModifyColumnSQL(ZuordnungPruefplanErgebnis.class, "ordnung"); upd.executeModifyColumnSQL(ZuordnungProbeAnalyseErgebnis.class, "analysenOrdnung"); upd.executeModifyColumnSQL(ZuordnungProbeAnalyseErgebnis.class, "ergebnisOrdnung");
CAUTION:
Die Updates funktionieren nur, wenn die Variable upd verwendet wird!
Wenn das Makro ausgeführt wird, erscheint der "normale" Update-Dialog, jedoch ohne Informationen zur Programmversion (da diese an dieser Stelle uninteressant sind). Nachdem Aktualisieren geklickt wurde, wird die DB-Aktualisierung durchgeführt. Sollte die ALLOW_DB_UPDATES-Berechtigung an dem Benutzer fehlen, so wird das Super-User-Kennwort abgefragt und anschließend das Update durchgeführt. Das Update-Protokoll wird im Update-Dialog und in der Standard-Update-Protokoll-Datei angezeigt. Nach den Updates wird das diaLIMS nicht geschlossen, sodass man direkt im Anschluss weitere Updates ausführen oder den DB-Validator laufen lassen kann.
Makro-Schaltfächen
Modulmakros können in Modulen und Masken als Schalflächen (Actions) hinzugefügt werden. Dabei gleicht die Bezeichnung der Action der Beschreibung bzw. (falls nicht gesetzt) der Kurzbezeichnung des Makros. Der Hilfetext wird samt Beschreibung eingblendet, wenn der Mauszeiger über die Schaltfläche platziert wird.
Jede Makro-Schaltfläche wird intern anhand des Präfixes "Macro_" gefolgt von der Kurzbezeichnung identifiziert. Damit können die Bezeichnung und der Hilfetext für mehrere Sprachen individuell konfiguriert oder die Schaltfläche via Benutzerbedingungen deaktviert werden. Falls die Bezeichnung bzw. der Hilfetext individuell externalisiert werden, werden die Felder Kurzbezeichnung, Beschreibung und Hilfetext nicht an die Makro-Schaltfläche übernommen.
Import von Skript-Dateien
Makros können auch anhand von Skript-Dateien erstellt werden. Diese Skript-Deteien enthalten i.d.R. einen Beanshell- oder Groovy-Code, der beim Import in das Feld "code" übernommen wird. Der Import von Skript-Datei kann aus dem Menü im Modul (Makro `` Skript-Datei-Import...) aufgerufen werden. Über einen Dateiauswahldialog können hier mehrere Dateie selektiert werden. Nach dem Bestätigen des Dialogs wird für jede Datei ein Makro-Datensatz erstellt und dem aktuell angemeldeten Benutzer zugeordnet. Die neu erzeugten Datensätze werden in die Modultabelle geladen.
Beim Import von Datei können weitere Kopfdaten übernommen werden. Diese werden in Form von "Meta-Einträgen" in der Datei angegeben. Jeder Eintrag ist auf eine Zeile beschränkt. Folgende Angaben sind möglich:
- //@meta-name: Der hier angegebene Text wird beim Import in das Feld "Beschreibung" übernommen.
- //@meta-class: Mit diesem Eintrag wird der Datentyp des Makros angegeben.
- //@meta-type: Hierrüber wird der Typ und damit das Verhalten des Makros definiert.
- //@meta-toolTipText: Der hier angegebene Text wird beim Import in das Feld "Hilfetext" übernommen.
- //@meta-icon: Hierüber kann der Pfad zum Symbol angegeben werden.
So kann eine Datei für den Import aussehen: //@meta-name:Probe hinzufügen //@meta-class:Charge //@meta-type:UPDATE_N //@meta-toolTipText:Fügt jeder selektierten Charge eine neue Probe hinzu. //@meta-icon:/icon/probeZuordnen.png /** * Fügt den ausgewählten Chargen eine Probe hinzu. */ import com.dialog.dialims.gui.util.*; for(int i=0;i<selected.length; ++i) selected[i].createProben(1);
Makro-Kontext
In früheren diaLIMS-Versionen steuerte ein Schalter Modulmakro am Makro, ob das Makro in Modulen als ausführbare Funktion eingeblendet wurde. In neueren Versionen (ab 2024.5) wird stattdessen ein Kontext ausgewählt, der zwischen Modulmakros, globalen Makros und Konfigurationsmakros unterscheidet.
Der Kontext bestimmt außerdem, welcher Typ und Datentyp ausgewählt werden können:
-
Global
Das Makro ist in der gesamten Answendung als globale Funktion verfügbar.
Die Auswahl des Datentyps ist nicht möglich.
Wählbare Makro-Typen:
- Verbunden (Standard)
- Getrennt
- Datenbank-Update
-
Modul
Das Makro ist als Funktion in Modulen und eingebetteten Tabellen verfügbar.
Die Auswahl des Datentyps bestimmt das Modul und die Tabellen.
Wählbare Makro-Typen:
- Verbunden (Standard)
- Erzeugen
- Löschen
- Kopieren
- Status 'R'*****
- Status 'A'*****
- Status 'W'*****
- Status 'F'*****
- Status 'S'*****
- Status 'Z'*****
- Status 'G'*****
- Status 'R'*****
- Anzeigen oder Drucken
- Anzeigen von Details
- Datensatz bearbeiten
- Datensätze bearbeiten
- Datenbank-Update * Dieser Makro-Typ ist erst nach Auswahl eines passenden Datentyps verfügbar.
-
Konfiguration
Das Makro erfüllt ausschließlich Konfigurationszwecke und kann nicht manuell ausgeführt werden.
Die Auswahl des Datentyps grenzt u.U. den genaueren Verwendungszweck ein.
wählbare Makro-Typen:
- Datensatzvalidierung
- Sicherer Statuswechsel
- Worker