Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.42 KB

README_German.md

File metadata and controls

55 lines (41 loc) · 2.42 KB

Mateo Orchestrator

Repository für den Mateo-Orchestrator

Der Mateo-Orchestrator ist eine eigenständige Anwendung, die es ermöglicht mateo Instanzen zu orchestrieren.

Funktionsweise

Der Mateo-Orchestrator besitzt eine Liste von Mateo-Instanzen. Per Rest-Api können Testskripte zur Ausführung an den Orchestrator übergeben werden. Es wird eine Id zurückgegeben mit welcher der Status des Jobs abgefragt werden kann.

Job

Ein Job besteht aus:

  • Einer Uuid
  • Dem auszuführenden Testskriptnamen (inkl. Pfad)
  • Einer Map von Variablen für das Testskript (Eingabe und Ausgabe)
  • Dem JobStatus (In Warteschlange, Wird ausgeführt, Beendet)
  • Ergebnis von mateo (Report)

Warnung

Die Jobs werden (aktuell) nicht persistiert und sind nach Beenden der Anwendung gelöscht.

Voraussetzungen und unterstützte Umgebungen

  • Mindestens eine laufende Mateo-Instanz
  • Jede Mateo-Instanz muss dieselben Testskripte enthalten

Konfiguration

Der Mateo-Orchestrator ist über die Datei application.yml konfigurierbar.

Präfix Eigenschaften Beschreibung
de.viadee.mateo.orchestrator.mateo-api urls Die URLs (kommasepariert) zu den Mateo-Instanzen (z.B. http://localhost:8123, http://localhost:8124)

Nutzung

Zunächst wird ein Job per POST (und den entsprechenden Parametern) mit dem Endpunkt /api/jobEntity/start gestartet. Als Antwort wird die Uuid des erstellten Jobs zurückgegeben. Mit dieser Uuid kann per GET über den Endpunkt /api/jobEntity{uuid} der Status abgefragt werden. Für weitere Informationen, siehe Rest Dokumentation.

Wichtig: Wenn Variablen übergeben werden sollen, muss die Map sowohl die Inputvariablen (inkl. des Variablenwerts) als auch die Ergebnisvariablen (ohne Wert möglich) enthalten. Alle angegebenen Variablen werden inkl. Wert in den Storage geschrieben und nach der Ausführung des Skripts ausgelesen und zurückgegeben.

Beispiel

POST:
http://localhost:8083/api/jobEntity/start?scriptFile=/opt/mateo/Scripts/Beispiel Chrome/Beispiel Chrome.xlsm

Body:
{ "scriptVariable": "Hallo", "result" : "" }

Mit der zurückgegebenen Id kann nun der Status abgefragt werden:
GET: http://localhost:8083/api/jobEntity?uuid=4c74d8c4-1c0c-4e43-8725-32e867e76b23