Zum Hauptinhalt springen

Schnittstellen einrichten

Schnittstellen sind Dienste des diaLIMS, um mit anderen Diensten zu kommunizieren oder eine automatische Auswertung durchzuführen. Es gibt verschiedene Schnittstellen, jede mit unterschiedlichen Aufgaben und bedürfen einer individuellen Konfiguration. Damit Schnittstellen überhaupt ausgeführt werden, müssen sie eingeplant werden: Dies kann über die Aufgabenplanung des Betriebssystem erfolgen, die selbstständig die Ausführung verwaltet und den Anwender dahingehend unterstützt. Wie man eine bereits konfigurierte Schnittstelle unter der Aufgabenplanung einrichtet, wird im folgenden erläutert.

Nötige Konfigurationsdateien​

Damit eine Schnittstelle in die Aufgabenplanung integriert werden kann müssen zwei Dateien vorhanden sein:

  • Ausführungsskript

    Das Ausführungsskript stellt die ausführbare Komponente der Schnittstelle dar. Das Ausführungsskript beinhaltet den Namen der Schnittstelle und den Pfad zu der DBConnection.properties-Datei, auf die im Folgenden eingegangen wird. Unter Windows findet üblicherweise ein Batch-Skript Verwendung, wohingegen auf Unix und davon abgeleiteten Betriebsystemen (Linux, MacOS, etc.) ein Shell-Skript eingerichtet wird. Ist das Ausführungsskript eingerichtet, kann es in die Aufgabenplanung des Betriebssystems integriert und beispielsweise mehrmals am Tage automatisch ausgeführt werden.

  • DBConnection.properties

    Damit das Ausführungsskript die Informationen der Datenbank für eine Ausführung nutzen kann, muss es wissen wie es auf diese Zugreifen kann. Diese Rolle übernimmt die DBConnection.properties-Datei. Sie ist ein essentieller Teil der Schnittstelle. Die Datei enthält dabei diverse Variablen, die über eine Schlüssel-Wert-Kombination gepflegt werden. Zu diesen Variablen zählen:

    • dbname dbname enthält die Adresse der Datenbank, also üblicherweise den Namen oder die IP-Adresse des Datenbankserver-Systems, den Namen der Datenbank und evtl. vom Datenbankserver abhängige, zusätzliche Anweisungen.

      Am Beispiel eines DB2-Servers könnte dbname folgenden Wert haben: dbname=//192.168.0.1:50000/dialims:retrieveMessagesFromServerOnGetMessage=true;

      URL für die Datenbankverbindung. Azure verwendet die selbe Syntax wie SQL-Server.

      Azure: //servername_or_IP:port;DatabaseName=dbname

      Beispiel: -Ddbname=//azure-db.database.windows.net:1433;DatabaseName=dialims

    • dbtype Der dbtype gibt an von welchen Datenbank-Managementssystem die Datenbank verwaltet wird. Dazu zählen DB2NET für DB2, SQLSERVER für Microsoft SQLServer, azure für Microsoft Azure und oracle für Oracles Datenbank-Managementsystem.

    • dbuser Diese Variable enthält den Benutzer, unter dem die Schnittstelle ausgeführt wird. Dieser muss im diaLIMS hinterlegt sein und unter dem Datenbank-Managementsystem administrative Rechte auf die Datenbank haben.

    • dbpwd_crypt Hier wird das Passwort des Benutzers angegeben, damit sich die Schnittstelle als der angegebener Benutzer ausweisen kann. Aus Sicherheitsgründen muss dies immer verschlüsselt eingetragen werden. Eine Funktion, die es erlaubt Passwörter gemäß diaLIMS-Richtlinien zu verschlüsseln findet sich im Optionen-Modul in der Menüleiste.

    • dbrole Analog zu der Anmeldung im diaLIMS muss auch eine Benutzerrolle angegeben sein, die Bedingungen und Berechtigungen spezifiziert. Auch diese muss im diaLIMS vorhanden und dem angegebenen Benutzer zugewiesen sein.

    • mode_Once Schlussendlich gibt es noch die Variablemode_Once. Diese bestimmt, zusammen mit der Konfiguration einmalig ausführen in der Schnittstelle, ob sich der Prozess unter dem die Schnittstelle startet nach der Ausführung gleich beendet oder weiterhin auf Eingaben für die Verarbeitung wartet. Will man, dass die Schnittstelle sofort beendet wird (zum Beispiel um Systemressourcen für andere Prozesse freizugeben), muss man hier den Wert 1 eintragen. Der Wert 0 bewirkt, dass der besagte Prozess weiterhin im Hintergrund ausgeführt wird und regelmäßig auf Eingaben wartet.

Funktion: Ausführungsskript erzeugen​

Um die oben genannten Dateien nicht jedes Mal von Hand erzeugen zu lassen, gibt es die Funktion "Ausführungsskript erzeugen" im Schnittstellen-Modul. Sie erzeugt automatisch das Ausführungsskript und bei Bedarf eine DBConnection.properties.

Beispielsweise sei die Schnittstelle DokumentImport eingerichtet und konfiguriert. Sie soll nun über die Aufgabenplanung des Bestriebssystems regelmäßig, automatisch ausgeführt werden. Dazu wählt man die Schnittstelle im Modul aus und betätigt den Button Ausführungsskript erzeugen.

![](/bilder/schnittstellen/AusfuehrungsskriptStart.png "Funktion "Ausführungsskript erzeugen"")

Es erscheint nun ein Dialog, in dem der Speicherpfad des Ausführungsskripts spezifiziert werden kann. Der Dialog startet immer im Programm-Verzeichnis des gestarteten diaLIMS und trägt den Namen der ausgewählten Schnittstelle. Der Speicherpfad und Dateiname kann, unter der Voraussetzung dass das Bestriebssystem das Ausführungsskript als ausführbare Datei erkennt, frei verändert werden. Ist bereits eine Datei mit gleichen Namen im Verzeichnis vorhanden muss vorher bestätigt werden, dass diese überschrieben werden soll. Andernfalls muss ein ein neuer Speicherpfad gewählt oder die Funktion abgebrochen werden. Im Beispiel wird die Standard-Konfiguration gewählt.

Anschließend kann entschieden werden, ob die Schnittstelle über die Zentrale Benutzeranmeldung des diaLIMS ausgeführt werden soll. Dies setzt voraus, dass die Zentrale Benutzeranmeldung vorher konfigueriert wurde. Im Beispiel wird die Zentrale Benutzeranmeldung aktiviert.

Auch für die DBConnection.properties kann ein Pfad gewählt werden, Standardpfad und -name der Datei ist analog zum Skript auch das dialIMS-Programmverzeichnis und der Schnittstellenname. Im Beispiel werden auch hier die Standardwerte verwendet.

Ist die Datei DBConnection.properties bereits vorhanden wird diese in das Skript übernommen. Ist die Datei noch nicht da, so kann diese nach Bestätigung eines Dialogs erzeugt werden. Im Beispiel wird eine neue DBConnection.properties erzeugt.

CAUTION:

Ist keine DBConnection.properties vorhanden und wird im Zuge der Funktion keine erzeugt, so wird der gewählte Pfad trotzdem in das Ausführungskript übernommen. Sollte zum Zeitpunkt der Ausführung die im Skript stehende DBConnection.properties nicht existieren, wird die Schnittstelle mit Standardwerten gestartet und sich höchst wahrscheinlich nicht mit der Datenbank verbinden können.

Soll eine DBConnection.properties erzeugt werden, so erscheint ein Formular-Dialog indem die Benutzerdaten der Schnittstelle eingetragen werden können (Benutzer, Passwort und Benutzergruppe). Zur Auswahl stehen alle im diaLIMS gepflegten Benutzer und Benutzergruppen. Das Passwort muss aus Sicherheitsgründen an dieser Stelle noch einmal eingetragen werden und zum Benutzer passen. Nur wenn diese Daten ausgefüllt und korrekt sind, kann der Dialog abgeschlossen werden.

Außerdem kann man hier die Option mode_Once (siehe oben) mit einer CheckBox konfigurieren.

Sind alle Benutzerdaten korrekt wird das Ausführungsskript und bei Bedarf die DBConnection.properties erzeugt und können für die Aufgabenplanung verwendet werden.