Enterprise Alert bietet viele verschiedene Schnittstellen, welche es erlauben Ereignisse zu empfangen und daraus Alarme zu generieren. Neben den sogenannten Smart-Konnektoren für Standard-Tools, gibt es zahlreiche offene Schnittstellen, wie zum Beispiel die Kommandozeilen-Schnittstelle. Hierüber können Backend-Systeme einfach und ohne Programmieraufwand angebunden werden.

Konzepte

Das Command Line Interface (CLI) benutzt das Web Service API von Enterprise Alert. Das Web Service API ist eine Ereignisquelle, die dazu genutzt werden kann, neue Ereignisse an Enterprise Alert zu übertragen und so Alarme auszulösen. Über die Kommandozeilen-Schnittstelle können neben IT-Tools auch Systems aus der Produktion, IoT, oder Gebäudemanagement angebunden werden.

Um neue Meldungen mit Hilfe der Kommandozeile zu senden, ist es nötig, einen neuen Ereignisanbieter in Enterprise Alert zu registrieren. Es kann verschiedene Ereignisanbieter für verschiedene Systeme geben, die jeweils ihre eigenen Parameter-Sets verwenden. Wird ein bestimmter Ereignisanbieter nicht mehr benötigt, ist es ebenso möglich diesen wieder zu entfernen. All diese Schritte sind mit der CLI Applikation in der Kommandozeile möglich.

Erste Schritte

Die ausführbare CLI Client Datei befindet sich standardmäßig in dem folgenden Ordner auf dem Enterprise Alert Server:

„C:\Program Files (x86)\Enterprise Alert\CommandLine\RemoteCLI.exe“

Des Weiteren befindet sich in diesem Ordner die dazugehörige Konfigurationsdatei „RemoteCLI.exe.config“. Zu beachten ist, dass diese Datei immer zusammen mit der RemoteCLI.exe verschoben werden muss, wenn der Client beispielsweise auf einem anderen System eingesetzt werden soll.

Um den Einstieg zu erleichtern, wird direkt nach dem Start des Clients eine Beschreibung in der Konsole eingeblendet, in der alle Funktionen erklärt werden. Die fünf wichtigsten Befehlen sind im folgenden beschrieben:

SETURL – Dieser Befehl dient dazu die URL zur Kommunikation mit der Web Service API zu setzen.

SETLOGIN – Dieser Befehl ermöglicht es die Login-Daten für Enterprise Alert festzulegen. Da das Erstellen von Alarmen und Meldungen einen administrativen Prozess darstellt, sollten mit diesem Befehl die Benutzerdaten des Enterprise Alert Administrators hinterlegt werden. Aus Sicherheitsgründen, werden diese Daten unter dem lokalen Windows Benutzerkonto hinterlegt:

“C:\Users\johndoe\AppData\Local\Derdack\RemoteCLI.exe_Url_z2meuhhahzfmdfx3f4gtlcs4b1tggzcd1.0.0.0”

Sobald die Benutzerdaten mit dem SETLOGIN Befehl einmal angelegt wurden, müssen bei weiteren Aufrufen, keine Parameter wir „user“ und „password“ mehr angegeben werden.

REGISTER – Dieser Befehl wird genutz um einen neuen Ereignisanbieter bzw. –quelle zu registrieren. Sobald der Befehl einmal ausgeführt wurde, kann der betreffende Ereignisanbieter mittels des RAISE Befehls, neue Ereignisse auslösen. Der REGISTER Befehl muss nur einmal aufgerufen werden, um einen neuen Ereignisanbieter zu etablieren. Mit dem Befehl können auch weitere Parameter übergeben werden, die dem Ereignisprovider zur Verfügung stehen sollen. Ein Beispiel wären hierbei, Empfänger die als Parameter „Destination“ angelegt werden.

RAISE – Der Befehl kann benutzt werden, um neue Ereignisse für bereits registrierte Erriegnisanbieter zu erzeugen und in Enterprise Alert auszulösen.

UNREGISTER – Dieser Befehl dient dazu bereits registrierte Ereignisanbieter wieder zu löschen und es somit zu unterbinden, dass weitere Ereignisse damit ausgelöst werden können.

Das folgende praktische Beispiel der Syntax, zeigt das CLI typischerweise initail benutzt wird:

RemoteCLI.exe SETURL /url:”http://yourserver/EAWebService/EventProviderAPI.asmx”

RemoteCLI.exe SETLOGIN /user:”Administrator” /password:”something-safe”

RemoteCLI.exe REGISTER /provider:”Automation” /params:”Product;Pressure;Destination”

RemoteCLI.exe RAISE /provider:”Automation” /params Product:”Sensors” Destination:”Conveyor”

RemoteCLI.exe RAISE /provider:”Automation” /params Product:”Actors” Destination:”Unit”

Wird das Kommandozeilen-Tool ohne Parameter aufgerufen, wird eine Hilfe angezeigt, die weitere Informationen enthält. Bitte beachten Sie auch, dass Ihre Firewall HTTP Kommunikation zwischen dem Kommandozeilen-Tool und Enterprise Alert zulässt.

Zusammenfassung

Die Kommandozeile ist eine einfache, aber doch mächtige, Option verschiedene Systeme einfach und ohne Programmier-Aufwand anzubinden. Sie kann auch für die einfache Simulation von Events verwendet werden.