Schritt-Bibliothek
Die Step Library enthält JavaScript-basierte Workflow-Schritte. Diese können als Schritte innerhalb von Workflows verwendet werden.
Schritte aus der Step Library haben Zugriff auf eine Avantra JavaScript-API, die vom überwachten System abhängig ist, auf dem der Schritt ausgeführt wird. Weitere Informationen zu den verfügbaren APIs finden Sie in unseren API documentation.
Schritte
Das Erstellen eines neuen Schritts kann einfach über die Step Library durchgeführt werden.
-
Wählen Sie Menü:Automation[Step Library].
-
Klicken Sie auf die Neu-Schaltfläche.
-
Geben Sie einen Namen und ein Namensraum an, um den Schritt zu benennen.
Beim Benennen eines Schritts in der Step Library muss eine eindeutige Kombination aus Name und Namensraum verwendet werden.
-
Optional setzen Sie einen Kunden, um diesen Schritt in der Step Library weiter zu gruppieren.
-
Klicken Sie auf die Erstellen-Schaltfläche, um den Schritt zu erstellen.
Die Konfiguration eines Schritts besteht aus einem JavaScript-Editor auf der linken Seite und Konfigurationseigenschaften auf der rechten Seite. In diesen Konfigurationseigenschaften können Sie grundlegende Einstellungen ändern, Parameter hinzufügen und entfernen, Dokumentationen bearbeiten und den Schritt auf einem laufenden Agenten testen, je nach Ihren Anforderungen.
Die folgenden Abschnitte erläutern, wie ein Schritt konfiguriert wird.
Parameter
Ein Schritt kann Eingabe- und Ausgabeparameter haben. Eingabeparameter ermöglichen es dem Workflow, Informationen an den Schritt zu übergeben, um dessen Verarbeitung zu steuern. Dies kann entweder von den Eingabeparametern des Workflows selbst oder von den Ausgabeparametern eines vorherigen Schritts im Workflow stammen.
Schrittparameter können im Parameters-Tab konfiguriert werden.
Jeder Schritt hat einige eingebaute Parameter, die vom Workflow-Engine selbst verwendet werden und Nachrichten sowie den Erfolg der Ausführung des Schritts melden.
-
Eingabe
-
systemId: das überwachte System, auf dem der Schritt ausgeführt werden soll (dies kann in JavaScript nicht abgerufen werden)
-
timeout: die Zeit in Sekunden, die gewartet wird, bevor ein lang laufender Schritt beendet wird (dies kann in JavaScript nicht abgerufen werden)
-
-
Ausgabe
-
success: true, wenn der Schritt erfolgreich ausgeführt wurde
-
message: kurze Nachricht zur Schrittausführung (wird im Ausführungsprotokoll angezeigt)
-
details: detaillierte Nachricht zur Schrittausführung (wird im detaillierten Ausführungsprotokoll angezeigt)
-
Diese eingebauten Parameter sind vordefiniert und müssen nicht manuell in der Benutzeroberfläche hinzugefügt werden. Benutzerdefinierte Parameter können jedoch hinzugefügt werden, um die Anforderungen des Schritts zu erfüllen.
-
Wählen Sie Menü:Automation[Step Library].
-
Doppelklicken Sie auf den erforderlichen Schritt aus der Step Library.
-
Klicken Sie auf den Parameters-Tab.
-
Fügen Sie eine neue Zeile hinzu, indem Sie oben rechts in der Parametertabelle die +-Schaltfläche auswählen.
-
Geben Sie einen eindeutigen Namen für den Parameter ein. Wir empfehlen, Parameter im
camelCasezu benennen und mit einem Buchstaben zu beginnen. -
Wählen Sie entweder
Eingabe,Eingabe (Pflicht)oderAusgabefür den Parameter Typ, um den Verwendungszweck dieses Parameters zu bestimmen. -
Wählen Sie einen geeigneten Parameter Typ aus der Parameter Types-Liste.
Derzeit sind nicht alle Parametertypen für die Verwendung in Schritten der Step Library verfügbar. Bitte beachten Sie die Dokumentation zu Parameter Types.
-
Optional geben Sie einen Standardwert und eine Dokumentation (Hinweis) ein, um den Schritt für zukünftige Workflow-Entwickler verständlicher zu machen.
Weitere Informationen zur Verwendung von Parametern in JavaScript finden Sie in unseren API documentation.
Dokumentation
Der Documentation-Tab ermöglicht es dem Schrittentwickler, weitere Informationen zur Verwendung des Schritts, zu den vorgesehenen Eingaben und Einschränkungen sowie zu anderen hilfreichen Informationen bereitzustellen, die zukünftigen Workflow-Entwicklern das Verständnis des Schritts erleichtern.
Die Dokumentation wird in der Benutzeroberfläche als Teil des Prozesses angezeigt, wenn ein Schritt bei der Erstellung von Workflows ausgewählt oder ein bestehender Schritt bearbeitet wird.
Test
Der Test-Tab kann verwendet werden, um nur diesen Schritt auf einem laufenden Agenten auszuführen und dessen Ausgabe im Rahmen des Entwicklungsprozesses zu testen.
-
Wählen Sie Menü:Automation[Step Library].
-
Doppelklicken Sie auf den erforderlichen Schritt aus der Step Library.
-
Klicken Sie auf den Test-Tab.
-
Alle Eingaben für den Schritt werden aufgelistet (einschließlich der eingebauten Eingaben), und verpflichtende Werte müssen eingegeben werden, bevor der Schritt ausgeführt werden kann. Der eingebaute Parameter
systemIdist verpflichtend und ermöglicht es dem Tester, auszuwählen, auf welchem Agent der Schritt getestet werden soll. -
Klicken Sie auf die Skript ausführen- oder Skript debuggen-Schaltflächen, um die Ausführung des Schritts zu starten.
Um das Debuggen auf einem Agenten zu aktivieren, muss der Wert
JS_DEBUG=onzum Überwachungsparameter AgentEnvironment hinzugefügt werden.Wenn die Skript debuggen-Schaltfläche verwendet wird, wird eine URL angezeigt, die in einem Chromium-basierten Browser geöffnet werden muss, um durch den Skriptcode zu gehen.
Nachdem der Code ausgeführt oder das Debugging abgeschlossen ist, können die Ausgabeparameter im Ergebnistextfeld eingesehen werden.
Import und Export
Zum Teilen von Schritten zwischen Systemen können die Export- und Import-Schaltflächen verwendet werden.
Export
Wählen Sie alle Schritte aus, die in den Export einbezogen werden sollen, und klicken Sie auf Exportieren. Geben Sie einen Dateinamen an und klicken Sie auf Exportieren. Danach wird die Exportdatei erstellt und heruntergeladen.
Dateiformat
Siehe Workflow export.