Gallery
Die Gallery-Client-Schnittstelle baut eine bidirektionale Verbindung zwischen einem Gallery-Analysegerät und dem diaLIMS auf. Das Analysegerät arbeitet dabei als Server und die Schnittstelle des diaLIMS als Client. Das diaLIMS sendet Analyse-Beauftragungen an das Gerät. Das Gerät sendet ermittelte Messwerte zurück ans diaLIMS.
Die Schnittstelle kommuniziert über das ASTM-Protokoll, das Informationen über eine TCP/IP-Verbindung bereitstellt. Die Kommunikation wird direkt und ohne Übermittlungsdateien durchgeführt.
Das Gallery-Analysegerät muss als Server konfiguriert sein, damit die Verbindung hergestellt werden kann. Bitte lesen Sie hierzu das Gallery-Benutzerhandbuch durch. Der Client arbeitet dauerhaft, unabhängig davon ob die Ausführung des Workers auf einmalig oder dauerhaft konfiguriert ist! Die Schnittstelle kann jedoch über das Schnittstellen-Modul im diaLIMS auf der Seite Status/Steuerung mit der Schaltfläche Schnittstelle beenden gestoppt werden, sofern diese läuft.
Funktionweise der Schnittstelle
Die Schnittstelle besteht aus zwei Teilen:
Ein Makro bereitet Proben für die Übermittlung vor. Diese werden in einer Warteschlange im Hintergrund eingereiht, von der Client-Schnittstelle verarbeitet und an das Analysegerät übertragen.
Die Client-Schnittstelle wird als Hintergrundprozess auf dem diaLIMS-Server eingeplant. Bei jedem Durchlauf werden alle Proben der Warteschlange für das konfigurierte Analysegerät ermittelt und als Analyse-Beauftragung übermittelt. Das Analysegerät antwortet mit den ermittelten Messergebnissen zurück zu der Client-Schnittstelle. Dort werden die Messergebnisse wieder den Proben zugeordnet und wenn möglich gespeichert.
Logging
Die Verarbeitung der Schnittstelle wird in einem Log im Modul Logeinträge festgehalten. Dort können die verarbeiteten Proben (und wenn konfiguriert die gesendeten und empfangen Daten) eingesehen werden. Außerdem werden hier nicht verarbeitbare Daten und Fehler festgehalten.
Aufbau der Schnittstelle
Grundlegender Aufbau
Die Kommunikation zwischen der Client-Schnittstelle und dem Analysegerät erfolgt in „Nachrichten“. Das sind textbasierte Informationen, die in mehrere Einträge aufgeteilt sind. Jeder Eintrag muss nach dem Senden vom Empfänger bestätigt werden. Dabei bestimmt eine Auswahl von ASCII-Steuerzeichen, wo Informationen beginnen und enden. Folgende Steuerzeichen werden verwendet:
-
ENQ
Beginnt eine Nachricht
-
EOT
Beendet eine Nachricht
-
ACK
Wird vom Empfänger gesendet, um einen erfolgreichen Empfang zu signalisieren
-
STX
Beginnt einen Eintrag
-
ETX
Beendet einen Eintrag
-
CR
Ist ein carriage return
Die Kommunikation zwischen der Client-Schnittstelle und dem Analysegerät erfolgt in zwei Schritten:
- Die Client-Schnittstelle sendet Proben und Parameter als Analysen-Beauftragung an das Analysegerät.
- Das Analysegerät sendet die Ergebnisse der Proben und Parameter unmittelbar an die Client-Schnittstelle zurück.
Jede dieser Schritte wird mit einer Nachricht umgesetzt, deren Aufbau im Folgenden beschrieben wird:
Aufbau der Analyse-Beauftragungen (diaLIMS zu Gallery):
Send: <ENQ>
Read: <ACK>
Send: <STX>1H|\^&|||1^[Schnittstelle]^1.0|||||||P<CR><ETX>0D
Read: <ACK>
Send: <STX>2P|1|[Proben-ID]|||[Proben-Bezeichnung]|||||||||||||||||||||<CR><ETX>60
Read: <ACK>
Send: <STX>3O|1|[Proben-ID]||^^^[Test-ID]|[Priorität]||[Probe-Nahmedatum]||||N||||8||||||||||O<CR><ETX>2E
Read: <ACK>
Send: <STX>4L|1|F<CR><ETX>FF
Read: <ACK>
Send: <EOT>
Diese Nachricht wird vom diaLIMS an das Analysegerät gesendet. Hier wird die Probe und eine oder mehrere Analysen angemeldet. Die Analyse wird durch die Test-ID identifiziert, die dem Analysegerät bekannt sein muss.
Angaben in < und > sind ASCII-Steuerzeichen, die die Nachricht gliedern. Angaben innerhalb von eckigen Klammern [ ] ermitteln Datensätze aus dem diaLIMS.
|
Feld |
Bemerkung |
|---|---|
|
|
Dieser Eintrag gibt die Quelle der Analyse-Beauftragung an. |
|
|
Diese Kombination aus Proben-Kurzbezeichnung und Zähler erzeugt eine eindeutige Kennzeichnung, sodass die Proben-ID auch bei mehrfacher Übertragung der Probe eindeutig bleibt. Hierbei wird die Kurzbezeichnung der Probe über einen Bindestrich mit dem Übertragungszähler der Probe verbunden. Der Zähler startet bei 1 und erhöht sich für jede weitere Übertragung um 1. Bsp.: P2020000001-1 für die erste Übertragung von Probe P2020000001. Für jede Probe gibt es einen eigenen Zähler. |
|
|
Hierbei werden die Kurzbezeichnungen der Datensätze jeweils mit einem Komma aneinandergehangen, sofern diese vorhanden sind. Bsp.: C2020000001,ABC für Charge C2020000001, kein Produkt und Kunde ABC. |
|
|
Gallery-ID für die die Untersuchung im Analysegerät. Im diaLIMS wird diese Bezeichnung am Ergerbnis des Parameters gepflegt. Nur Parameter mit einem Ergebnis an dem eine Gallery-ID gesetzt ist, werden übertragen. |
|
|
Die Priorität kann im Makro ausgwählt werden, wenn Proben für eine Analyse-Beauftragung vorbereitet werden. Folgende Werte sind möglich: - stat
|
|
|
Nahmedatum und -zeit werden zu einem Zeitstempel im Format yyyyMMddhhmmss umgewandelt. Bsp: 20200324144613 für den 24.03.2020 um 14:46:13 Uhr. |
Read:<ENQ>
Send:<ACK>
Read:<STX>1H|\^&|||1^[Gallery-Bezeichnung]^|||||||P||20101118104132<CR><ETX>9B
Send:<ACK>
Read:<STX>2P|1|[Proben-ID]|||[Proben-Bezeichnung]|||||||||||||||||||||<CR><ETX>F5
Send:<ACK>
Read:<STX>3O|1|[Proben-ID]^0.0^3^1||^^^[Test-ID]^0|[Priorität]||[Probe-Nahmedatum]||||X||||8|||||||||1|F<CR><ETX>21
Send:<ACK>
Read:<STX>4R|1|^^^[Test-ID]^5|[Messwert]|[Einheit]||||||||[Test-Datum]|[Gallery-Bezeichnung]<CR><ETX>D6
Send:<ACK>
Read:<STX>5L|1|N<CR><ETX>08
Send:<ACK>
Read:<EOT>
Diese Nachricht wird vom Analysegerät als direkte Antwort an das diaLIMS zurück gesendet. Teile der Analyse-Beauftragung werden übernommen, damit die Antwort mit der Analysen-Beauftragung in Beziehung gesetzt werden kann. Hinzu kommen die Ergebnisse aus der Analyse inklusive dem Messwert.
Angaben in < und > sind ASCII-Steuerzeichen, die die Nachricht gliedern. Angaben innerhalb von eckigen Klammern [ ] ermitteln Datensätze aus dem diaLIMS.
|
Feld |
Bemerkung |
|---|---|
|
|
Hier wird die Bezeichnung des Analysegeräts hinterlegt. |
|
|
Entsprechend der Angabe in der Analysen-Beauftragung. |
|
|
Entsprechend der Angabe in der Analysen-Beauftragung. |
|
|
Gallery-ID für die die Untersuchung im Analysegerät. Wird hinterlegt, wenn die entsprechende Analyse dem Analysegerät bekannt ist. |
|
|
Entsprechend der Angabe in der Analysen-Beauftragung. |
|
|
Entsprechend der Angabe in der Analysen-Beauftragung. |
|
|
Der Messwert ist immer ein numerischer Wert mit einem Punkt (.) als Dezimal-Trennzeichen. Dieser Wert wird, wenn möglich, vom diaLIMS an der entsprechenden Probe, an der ersten freien Messung hinterlegt. |
|
|
Einheit in der der Messwert gemessen wurde. Es wird vorausgesetzt, dass diese Einheit auch im diaLIMS vorhanden ist. Bevor der Messwert gespeichert wird, wird er von der empfangenen Einheit in die Einheit die am Parameter gepflegt ist umgerechnet. Nur wenn eine Umrechnung möglich ist, wird der Messwert auch gespeichert. Wurde keine Einheit übertragen oder wenn die Übertragene und die am Parameter gepflegte Einheit identisch sind, wird der Wert ohne Umrechnung an den Parameter übernommen. |
|
|
Datum an dem die Analyse durchgeführt wurde. Wird wenn vorhanden an den Parameter übernommen. Andernfalls wird das Datum des Empfangs gesetzt. |
Konfiguration der Ergebnis-Stammdaten
Analysen/Methoden `` Ergebnisse
Bitte Pflegen Sie zu allen relevanten Ergebnissen das Feld Gallery-ID . Dort kommt die Test-ID des Gallery-Analysegeräts hinein, damit die Zuordnung von Parametern im diaLIMS auf Analysen im Gallery-Analysegerät erfolgen kann. Parameter werden nur übertragen, wenn an dem zugehörigen Ergebnis eine Gallery-ID vorhanden ist.
VORSICHT:
Es ist tendentiell möglich mehreren Ergebnissen im diaLIMS die selbe Test-ID zu vergeben. Allerdings sollten Sie dafür Sorge tragen, dass pro Probe nur ein Parameter mit der selben Test-ID vorhanden ist. Andernfalls kann eine eindeutige Zuordnung nicht mehr gewährleistet werden.
Konfiguration der autom. Schnittstelle
Um die Schnittstelle zu nutzen muss die Funktionlizenz "Gallery_Schnittstelle" aktiviert werden.
Konfiguration der autom. Schnittstelle:
Schnittstellen `Worker` class com.dialog.dialims.limsworker.gallery.DefaultGalleryClientProcess
Bearbeiten Sie folgende Parameter, um die Schnittstelle zu konfigurieren.
Anmerkung: Diese Schnittstelle kann beliebig oft konfiguriert werden. Bitte konfigurieren Sie jedes Gallery-Analysegerät mit einem separaten Worker-Datensatz. Die Kurzbezeichnung des Workers wird mit einer Laufnummer versehen, sodass jeder Worker eindeutig identifizierbar ist (bspw.: „GalleryClientSchnittstelle-1“ für den zuerst eingerichteten Worker). Bitte verwenden Sie die Beschreibung zum festlegen einer internen Bezeichnung, damit die Analysegeräte leichter von Ihren Mitarbeitern unterschieden werden können.
|
Key |
Bemerkung |
|---|---|
|
|
Die Netzwerk-Adresse des Gallery-Analysegeräts. |
|
|
Der Port des Gallery-Analysegeräts. |
|
|
Kurzbezeichnung des Prüfmittels, das einer Analyse/Methode zugeordnet sein muss, damit ihre Parameter an die Schnittstelle gesendet werden. (pflicht) |
|
|
Eine Pause in ms zwischen Probenübertragungen. |
|
|
Legt fest, ob die gesendeten und empfangenen Kommunikations-Nachrichten mitprotokolliert werden sollen. Folgende Werte sind möglich:
|
|
|
Wenn diese Schnittstelle dauerhaft ausgeführt wird, legt dieser Wert die Dauer in Minuten zwischen den Importen fest. |
Makros
Das Einrichten des Makros zum Vorbereiten von Proben für die Analysen-Beauftragung erfolgt im Makro-Modul. Importieren Sie dazu aus dem Ordner bsh/scripts/proben/ folgende Skript-Dateien:
- GalleryEnqueueForProbenAction.groovy
- GalleryEnqueueForZPAEsAction.groovy
- ShowGalleryQueueAction.groovy
- ClearGalleryQueueAction.groovy
und ordnen Sie die Makros den gewünschten Benutzern bzw. Benutzergruppen zu.
Anmerkung: Falls Sie mehrere Schnittstellen zu versch. Gallery-Geräten eingerichtet haben, können Sie die Makros durch das wiederholte Importieren anlegen und in jedem Makro die jeweilige diaLIMS-Schnittstelle (Worker-Kurzbzeichnung) angeben. Dazu kann die Bezeichnung zwischen die Anführungszeichen in Zeile drei (GalleryEnqueueForProbenAction.groovy) eingetragen werden:
Gnew CreateGalleryQueueItemFromProbeUserAction("GalleryClientSchnittstelle-1", selected);
Makros für die Vorbereitung der Übermittlung an Gallery
Vorbereiten der Analysen-Beauftragung
-
Markieren Sie die für die Analysen-Beauftragung relevanten Proben in der Modul-Tabelle und klicken Sie auf das konfigurierte Makro zum Vorbereiten der Analysen-Beauftragung.
Menü`Makros`Eintrag mit Symbol und Beschreibung des Makros (Standard "An Gallery-Gerät senden...")oder -
Markieren Sie die für die Analysen-Beauftragung relevanten einzelnen Probenergebnissse auf der Seite
Ergebnisseund klicken Sie auf das konfigurierte Makro zum Vorbereiten der Analysen-Beauftragung in der SymbolleisteEintrag mit Symbol und Beschreibung des Makros (Standard "An Gallery-Gerät senden..."). -
Wählen Sie einen Worker aus, mit der die Analysen-Beauftragung versendet werden soll. Sie können aus allen konfigurierten Gallery-Workern wählen.
Anmerkung: Diese Auswahl erscheint nur, wenn mehrere Worker für Gallery-Geräte eingerichtet sind und in dem Makro keine gültige Worker-Kurzbezeichnung angegeben ist. Andernfalls wird diese Auswahl übersprungen und direkt der einzelne bzw. der konfigurierte Worker verwendet.
-
Bestätigen Sie die Eingabe mit
Ok. -
Wählen Sie eine Priorität aus, mit der die Analysen-Beauftragung an das Analysegerät versendet werden soll. Sie können aus folgenden Prioritäten wählen:
- stat
- asap
- routine
- callback
- preoperative Anmerkung: Eine genaue Erklärung der Prioritäten finden Sie in der Bedienungsanleitung des Gallery-Analysegeräts.
-
Bestätigen Sie die Eingabe mit
Ok. -
Die Parameter mit gepflegter Gallery-ID der markierten Proben werden für die nächste Analysen-Beauftragung vorgemerkt.
Liste mit vorbereiteten Analysen-Beauftragungen anschauen
- Klicken Sie auf das konfigurierte Makro zum Anschauen der Warteschlange
Menü`Makros`Eintrag mit Symbol und Beschreibung des Makros (Standard "Warteschlange anzeigen"). - Eine Liste von den vorgemerkten Parametern mit gepflegter Gallery-ID der markierten Proben für die nächste Analysen-Beauftragung werden in einem neuen Fenster angezeigt.
Anmerkung: In dieser Liste werden nur für Gallery-Gerät, für das eine Worker-Kurzbezeichnung in dem Makro angegeben ist, vorgemerkte Parameter angezeigt. Andernfalls (wenn keine Kurzbezeichnung eingetragen ist) werden Parameter für alle Gallery-Geräte angezeigt.
Liste mit vorbereiteten Analysen-Beauftragungen leeren
- Klicken Sie auf das konfigurierte Makro zum Anschauen der Warteschlange
Menü`Makros`Eintrag mit Symbol und Beschreibung des Makros (Standard "Warteschlange leeren"). - Alle für die nächste Analysen-Beauftragung vorgemerkten Parametern werden aus der Warteschlange entfernt.
Anmerkung: Es werden nur für Gallery-Gerät, für das eine Worker-Kurzbezeichnung in dem Makro angegeben ist, vorgemerkte Parameter entfernt. Andernfalls (wenn keine Kurzbezeichnung eingetragen ist) werden Parameter für alle Gallery-Geräte entfernt.