AKLAN Device Plugin

Das AKLAN Device Plugin erlaubt es Ihnen, CoDaBix Datenpunktnodewerte bidirektional mit AKLAN Server und Clients auszutauschen.

Voraussetzungen

  • Dieses Plugin funktioniert nur unter Windows.
  • Es müssen zusäztliche AKLAN-Komponenten manuell installiert werden, damit das Plugin funktioniert.
Das AKLAN Device Plugin ermöglicht den Datenaustausch zwischen AKLAN Teilnehmern.

Das Plugin lässt Sie:

  • AKLAN Verbindungen definieren
  • Daten schreiben und lesen
  • Daten schreiben
  • Daten lesen
  • Datenqueueing
  • AkLan
  • AkLan(S)
  • automatischer Datenaustausch von CoDaBix Datennodes z.B. via Script-Plugin
  • erstellen eines AKLAN Connection

Dieses Plugin ist Bestandteil des CoDaBix® Setups. Bitte konsultieren Sie CoDaBix® Setup und erster Start für weitere Informationen darüber, wie dieses Plugin installiert und deinstalliert werden kann.
Beachten Sie: Es müssen zusäztliche AKLAN-Komponenten manuell installiert werden, damit das Plugin funktioniert.

Dieses Plugin ist Bestandteil des CoDaBix® Setups. Bitte konsultieren Sie CoDaBix® Setup und erster Start für weitere Informationen darüber, wie dieses Plugin installiert und deinstalliert werden kann.
Beachten Sie: Es müssen zusäztliche AKLAN-Komponenten manuell installiert werden, damit das Plugin funktioniert.

Anforderungen

  • Die Maschine, die CoDaBix® betreibt, muss Zugang zu einem AKLAN-Service haben.

Übersicht

Die gesamte AKLAN Device Pluginkonfiguration befindet sich unter dem Nodepfad /System/Devices/AKLAN Device.

Der Nodebaum im oberen Bild zeigt einen Nodebaum des AKLAN Device Plugins. Um eine oder mehrere AKLAN Device Channels aufzusetzen, fügen Sie einen Folder Node unter dem Node AKLAN Device / Channels hinzu, oder machen Sie einen Rechtsklick auf den AKLAN Device / Channels Node und wählen Sie Add Channel aus.

AKLAN spezifische Einstellungen

Name Typ Beschreibung
Name String Definiert den „connectionName“ Parameter für die AKLAN-Connection.
Display Name String Der Anzeigename des Channels.
ServerType Enum Verwendeter Servertyp. Bei „Custom“ kann unter CustomServerType ein benutzerdefinierter Typ angegeben werden.
CustomServerType String Falls bei ServerType „Custom“ eingestellt wurde, kann hier ein benutzerdefinierter Typ angegeben werden.
IniFile String Der Speicherort der AKARID INI-Konfigurationsdatei.
TransmitFunction Enum Die zum Senden verwendete Funktion: SendMessage (Infonachricht) oder SendDataRequest (Datenanforderung).
TransmitQueueType Enum Gibt an, wie Daten für AKLAN zwischengespeichert werden sollen:
DirectoryQueue: Nachrichten werden im Dateisystem zwischengespeichert.
MemoryQueue: Nachrichten werden nur im Arbeitsspeicher zwischengespeichert.
QueuePath String Falls TransmitQueueType auf MemoryQueue gestellt ist, kann hier der Pfad zum Verzeichnis eingstellt werden, in dem das Plugin die Daten bis zum erfolgreichen Versand zwischenspeichert. Dabei wird stets auf die Reihenfolge der Datenpakete geachtet und nur die Pakete gelöscht, welche auch erfolgreich versendet werden konnten. Der Standardwert für den QueuePath sieht vor, dass die Pakete im Datenverzeichnis von CoDaBix gespeichert werden, sodass bei einem Backup von CoDaBix diese auch mit gesichert werden. Das Plugin legt hierbei je Channel ein separates Unterverzeichnis mit dem verwendeten Channel-Name an.
Send Timeout Integer Der Timeout in Sekunden, nach dem eine Anforderung zum Datenversand abgebrochen wird.

Nachdem Sie „Save“ geklickt haben, wird die Channelnode erstellt. Sie können sie starten, indem Sie die Channelnode auswählen und den Startbutton klicken:

Ist der Channel angelegt worden, wird das Plugin bei jedem Start von CoDaBix automatisch den Channel starten und somit eine AKLAN Verbindung herstellen sowie versuchen noch ausstehende, wie auch neue Daten per AKLAN zu versenden. Soll der Channel nicht automatisch beim Start gestartet werden, dann können Sie über die Node „Control“ der Channelnode den „StartMode“ auf „Manual“ umstellen.

Endpoints

Über die Nodes unterhalb des Endpoints-Nodes können Sie für die Übertragung den gewünschten Channel und den VCode (= Verarbeitungscode) konfigurieren. Sie können z.B. via einem Skript die erstellten Daten in die „Buffer“-Node schreiben. Worauf das AKLAN Device Plugin diese entgegen nimmt und im konfigurierten QueuePath speichert, bis sie erfolgreich versendet werden konnten.

Im Receive Node können Sie hingegen die Antworten auf die gesendeten Daten einsehen.

Channel Name des AkLan Kanals oder die SubId die beim Datenversand verwendet werden.
VCode Der Verarbeitungscode der beim Datenversand übermittelt wird.
Buffer Der Speicher der Daten die versendet werden sollen.
Das AKLAN Device Plugin liefert verschiedene Statusinformationen. Diese werden kanalbasiert durch den Verbindungsstatus des Channels zum AkLan Dienst produziert.

Kanal

Um den Status der verschiedenen Kanäle zu überwachen und zu diagnostizieren, werfen Sie einen Blick auf das folgende Bild:

Das obige Bild zeigt das Bedienfeld des AKLAN Kanals, das alle statusrelevanten Informationen anzeigt. Das Bedienfeld aktualisiert automatisch seine Statusinformationen, wenn ein neuer Status verfügbar ist.

Statuskreis

Farbe Bedeutung
Der Kanal wird angehalten. Klicken Sie den Button, um ihn zu starten.
Der Kanal startet oder stoppt gerade oder wartet auf den Verbindungsaufbau.
Der Kanal läuft und es wurde erfolgreich eine Verbindung hergestellt. Sie können ihn durch Klick auf den Button stoppen.
Der Kanal läuft, aber die Verbindung ist momentan fehlerhaft. Bitte überprüfen Sie den Statustext für weitere Informationen.

Logdatei

Alle kanalbezogenen Statusinformationen werden auch in die kanalspezifische Logdatei im [LoggingFolder] protokolliert. Jede Logdatei wird nach dem Namensschema AKLAN Device.<KanalName>.log benannt. Der Inhalt einer solchen Logdatei kann wie folgt aussehen:

...
[14:55:34 25.07.2017] - Error (Severity=High): Code=[-1], Text=[Access denied for user 'abc'@'localhost' (using password: YES)], Details=[]
...

Wie jedes Device Plugin erweitert das AKLAN Device Plugin das grundlegende CoDaBix® Device Modell.

Wie jedes Device Plugin erweitert das AKLAN Device Plugin das grundlegende CoDaBix® Device Modell.

Device

Der Devicetyp AklanDevice des Plugins definiert auch den AklanDeviceChannel und erweitert somit die grundlegenden CodabixDevice und CodabixDeviceChannel Entities. Während das AklanDevice lediglich eine Konkretisierung des CodabixDevice repräsentiert, erweitert der AklanDeviceChannel den CodabixDeviceChannel mit AKLAN Endpunkte.

Channel

Jeder Channel wird von einem Channel Worker behandelt, der eine physische Verbindung zum AKLAN-Dienst herstellt. Zum Zweck der Fehlerdiagnose überwacht der Worker die AKLAN-Verbindung, um den Statuscode des Channels und die Beschreibung zu aktualisieren, damit Verbindungsausfälle aufgespürt werden.

Der Worker übermittelt Daten an die AKLAN-Verbindung, wenn in den Buffer-Node des Transmit-Endpoints Daten geschrieben werden. Wenn über die Verbindung Daten empfangen werden, werden diese in den Buffer-Node des Receive-Endpoints geschrieben.

Ordner

Inhalt Pfad Zweck / Verwendung
AssemblyFolder <CodabixInstallDir>/plugins/AklanDevicePlugin/ Beinhaltet die Plugin Assembly Datei.
ConfigFolder <CodabixDataDir>/plugins/AklanDevicePlugin/ Beinhaltet die Plugin Konfigurationsdatei.
LoggingFolder <CodabixDataDir>/log/ Beinhaltet die Plugin Logdateien.

Dateien

Typ Pfad Zweck / Verwendung
Assembly [AssemblyFolder]/CoDaBix.AklanDevicePlugin.dll Die Plugin Assembly Datei.
Logging [LoggingFolder]/AKLAN Device.<ChannelName>.log Die Log Datei.

Dieses Dokument

Datum 2018-03-20
Version 1.0

Plugin

Name AKLAN Device Plugin
Node /System/Device/AKLAN Device
Version 1.0.0

Assembly

Name CoDaBix.AklanDevicePlugin.dll
Datum 2018-03-20
Version 1.0.0.0