- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Generische Aufgabenanforderungen
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Prozessabfragen
- Anforderungen von Warteschlangenelementen
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
Anleitung für die Orchestrator-API
Aufgezählte Typen
Definiert den Status eines Auftrags.
Name |
Wert |
Beschreibung |
---|---|---|
Anstehende |
0 |
Auftrag in der Warteschlange auf einem ausgelasteten oder nicht verbundenen Roboter. |
Running (Wird ausgeführt) |
1 |
Auftrag wird derzeit von einem Roboter verarbeitet. |
Wird angehalten |
2 |
Auftrag wird abgebrochen, sobald dies sicher ist. Das kann in einem Workflow mithilfe der Aktivität Should Stop implementiert werden. |
Wird beendet |
3 |
Auftrag wurde zum erzwungenen Anhalten ausgelöst. Dies kann einige Sekunden dauern und der Prozess wird beendet. Ein sicheres Anhalten ist nicht gewährleistet. |
Fehlgeschlagene (Faulted) |
4 |
Auftrag, der nicht gestartet werden konnte, oder der zugehörige Workflow hat während der Ausführung einen nicht behandelten Fehler ausgelöst. |
Erfolgreich |
5 |
Auftrag, der die Verarbeitung ohne Ausnahmen beendet hat. |
Angehalten (Stopped) |
6 |
Der Auftrag wurde angehalten, bevor die Ausführung ohne Ausgeben von Fehlern abgeschlossen wurde. |
Angehalten |
7 |
Ein Zwischenzustand, der ausgelöst wird, um eine Intervention oder das Abschließen eines Zwischenprozesses durch einen Benutzer zuzulassen. Wird durch die entsprechenden Aktivitäten in Studio ausgelöst. |
Fortgesetzt |
8 |
Ein Zwischenzustand, der ausgelöst wird, wenn die Bedingungen (Benutzereingriff, Abschluss eines Zwischenprozesses) eines fragmentierten Workflows erfüllt sind. Wird durch die entsprechenden Aktivitäten in Studio ausgelöst. |
Name |
Wert |
Beschreibung |
---|---|---|
Manuell |
0 |
Der Auftrag wurde über die Seiten „Aufträge/Trigger/Prozesse“ konfiguriert und mit der Schaltfläche „Start“ gestartet. |
Auslösen |
1 |
Der Auftrag wurde über einen Trigger gestartet, der für die vorgeplante Auftragsausführung verwendet wird. |
Definiert den Roboterverfügbarkeitsstatus.
Name |
Wert |
Beschreibung |
---|---|---|
Verfügbar |
0 |
Ein funktionierender Roboter, der kostenlos verwendet werden kann. |
Beschäftigt |
1 |
Ein Roboter, der einen Prozess ausführt. |
Getrennt |
2 |
Ein Roboter, der vom Orchestrator getrennt ist. |
Unbekannt |
3 |
Ein Roboter, der sich im Status „Unbekannt“ befindet. |
Definiert den Verarbeitungsstatus eines Warteschlangenelements.
Name |
Wert |
Beschreibung |
---|---|---|
Neu (New) |
0 |
Der Status eines neu hinzugefügten Elements. |
InProgress |
1 |
Der Status eines Elements, das verarbeitet wird. |
Fehlgeschlagen (Failed) |
2 |
Der Status eines Elements, dessen Verarbeitung fehlgeschlagen ist. |
Erfolgreich |
3 |
Der Status eines Elements, dessen Verarbeitung erfolgreich war. |
Aufgegeben (Abandoned) |
4 |
Der Status eines Elements, dessen Verarbeitung angehalten wurde, bevor es erfolgreich war oder fehlgeschlagen ist. |
Erneut versucht (Retried) |
5 |
Der Status eines Elements, das mindestens zweimal verarbeitet wurde. |
Deleted (Gelöscht) |
6 |
Der Status eines Elements, das vom Benutzer als gelöscht markiert wurde. |
Definiert Kategorien für die Ausnahme, die ausgelöst wird, wenn die Elementverarbeitung fehlschlägt.
Name |
Wert |
Beschreibung |
---|---|---|
ApplicationException |
0 |
Wird ausgelöst, wenn der Prozess aufgrund eines Anwendungsfehlers fehlschlägt. |
BusinessException |
1 |
Wird ausgelöst, wenn eine Geschäftsanforderung nicht erfüllt ist. |
Name |
Wert |
Beschreibung |
---|---|---|
Keine |
0 |
Standardzustand, der für alle Elementtypen gilt. |
InReview |
1 |
Ein Element in diesem Status ist mit einer Anwendungsausnahme fehlgeschlagen und wurde von einem Benutzer als in der Prüfungsphase markiert. |
Überprüft |
2 |
Ein Element in diesem Status ist mit einer Anwendungsausnahme fehlgeschlagen und wurde von einem Benutzer als verifiziert markiert und kann nicht mehr wiederholt werden. Um einen erneuten Versuch zu starten, muss ein Element manuell für den erneuten Versuch markiert werden. |
Erneut versucht (Retried) |
3 |
Ein Element in diesem Status ist mit einer Anwendungsausnahme fehlgeschlagen und wurde zur Wiederholung markiert. |
Definiert die Sichtbarkeitsebene eines Assets.
Name |
Wert |
Beschreibung |
---|---|---|
Global |
0 |
Wenn ein Asset den Bereich Global hat, ist es für alle Roboter sichtbar. |
PerRobot |
1 |
Wenn ein Asset den Scope PerRobot hat, ist es nur für bestimmte Roboter sichtbar, denen es zugeordnet war, und kann für jeden Roboter unterschiedliche Werte haben. |
Definiert, welcher Werttyp von einem Asset gespeichert wird.
Name |
Wert |
Beschreibung |
---|---|---|
Text |
2 |
Definiert ein Asset, das einen Textwert speichert. |
Bool |
3 |
Definiert ein Asset, das einen booleschen Wert speichert. |
Integer |
4 |
Definiert ein Asset, das einen numerischen Wert speichert. |
Anmeldeinformationen |
5 |
Definiert ein Asset, das einen Benutzernamen und ein Kennwort speichert. |
Definiert den Schweregrad der Protokollierung.
Name |
Wert |
Beschreibung |
---|---|---|
Ablaufverfolgung |
0 |
Detaillierte Informationen. |
Debuggen |
1 |
Detaillierte Informationen zum Flow durch das System. |
Information (Info) |
2 |
Laufzeitereignisse wie Starten oder Herunterfahren. Die überwiegende Mehrheit der Protokolleinträge. |
Warnen |
3 |
Laufzeitsituationen, die unerwünscht oder unerwartet sind, aber nicht unbedingt falsch sind. |
Fehler (Error) |
4 |
Laufzeitfehler oder unerwartete Bedingungen. |
Schwerwiegend (Fatal) |
5 |
Schwere Fehler, die zu einer vorzeitigen Beendigung führen. |
Definiert, wie ein Benutzer erstellt wurde und wie er verwendet werden soll.
Name |
Wert |
Beschreibung |
---|---|---|
Benutzer |
0 |
Ein Benutzer vom Typ Lokaler Benutzer. |
Roboter |
1 |
Wird beim Hinzufügen eines Roboters automatisch erstellt, wird der Roboterrolle zugewiesen und von einem Roboter bei der Kommunikation mit dem Orchestrator verwendet. |
DirectoryUser |
2 |
Ein Benutzer vom Typ Verzeichnisbenutzer |
DirectoryGroup |
3 |
Ein Benutzer vom Typ Verzeichnisgruppe |