Ein Gastartikel von Joel Wiesmann.
Mit der Version 12.1 hat die Automation Engine eine neue Methode erhalten, wie sie von Drittanwendungen angesprochen werden kann: ein REST Interface.
REST (kurz für Representational State Transfer) ist eine Sammlung von Leitfäden, wie ein Interface zu einer Anwendung umgesetzt werden soll. Schnittstellen, die sich an diesen Leitfäden orientieren, nennt man “REST Interface”. Tools wie Twitter, JIRA und ServiceNow verfügen schon eine Weile darüber.
Eine moderne Applikation ist webbasiert und hat ein REST Interface für die Integration von Drittanwendungen. Das schöne daran: haben Sie einmal mit REST gearbeitet, dann fällt es leicht, mit REST Schnittstellen von anderen Applikationen zu interagieren.
Was kann das Automic REST Interface?
Der Weg vom “UC4.JAR”, das auf klassischem Wege mit Automic kommuniziert, zu einer webbasierten REST Schnittstelle ist komplex und umfangreich. Deshalb erweitert Automic die Fähigkeiten des REST Interfaces nach und nach.
Neue Features werden zukünftig wahrscheinlich gar nicht mehr in der Java ApplicationInterface API unterstützt.
Folgende Tabelle zeigt den Fortschritt des REST Interfaces (klicken Sie, um die Tabelle zu vergrößern):
Die Angaben in dieser Tabelle sind nicht offiziell, sondern spiegeln nur wieder, was ich in meinen Tests herausfinden konnte.
Wie wird das Automic REST Interface angesprochen?
Das Java API hat ein Automic-spezifisches Protokoll implementiert. Beim Automic REST Interface handelt es sich dagegen um Klartext-Nachrichten im JSON Format, die über HTTP(S) übertragen werden.
Eine lesende Operation können sie mit einem einfachen Browser simulieren indem Sie auf eine URL zugreifen. Fragen Sie ihren Admin, wo er den REST Endpoint für das AWI aufgesetzt hat.
Sofern Sie einen Benutzer haben und keine Firewall im Wege steht, können Sie mit folgender URL die aktuellen Aktivitäten anzeigen lassen:
https://:/ae/v1//executions
Beispielsweise:
https://myRestInterface.internal.ch:8088/ae/v1/1234/executions
Die Antwort kommt im JSON Format, einem Datenformat aus der Javascript-Welt. Es ist für Maschinen einfach zu lesen und zu interpretieren, hat jedoch deutlich weniger Ballast, weshalb es auch für den Menschen einfacher lesbar ist.
Wie arbeite ich mit dem Interface?
Das REST Interface ist sehr einfach anzusprechen. Sie können Code dafür entweder in einer Programmiersprache wie Java oder C# implementieren, aber auch in einfachen Scriptsprachen wie Unix Shellscripts (mithilfe von curl), Python, Powershell oder via Web / Javascript auf das Interface zugreifen. Natürlich geht das ganze auch mit dem REST Webservice Objekt direkt in Automic.
Möchten Sie mehr über das Automic REST Interface und deren Einsatzzweck wissen? Schreiben Sie mir gerne in den Kommentaren, was Sie interessiert.
Joel Wiesmann
Automic Experte
Joel Wiesmann ist diplomierter Informatik Techniker aus der Schweiz und arbeitet seit vielen Jahren mit der Automation Engine.
Er hat den WorkflowCommander erstellt und bietet ihn hier auf der Seite gemeinsam mit einem E-Learning an.