- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
Ein Flow ist ein Diagramm. Knoten sind die Knoten (Trigger, Aktivitäten, Connectors, Agents); Kanten sind die ausgerichteten Verbindungen zwischen ihnen. Die Befehle uip flow node und uip flow edge bearbeiten direkt eine .flow -Datei – Hinzufügen, Konfigurieren, Auflisten und Löschen von beiden.
Diese Seite behandelt auch drei begleitende Befehlsgruppen, die die .flow -Datei auf die gleiche Weise bearbeiten: variable, variable-update und binding.
Zusammenfassung
uip flow node add <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip flow node configure <file> <node-id> --detail <json>
uip flow node list <file>
uip flow node delete <file> <node-id>
uip flow edge add <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip flow edge list <file>
uip flow edge delete <file> <edge-id>
uip flow node add <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip flow node configure <file> <node-id> --detail <json>
uip flow node list <file>
uip flow node delete <file> <node-id>
uip flow edge add <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip flow edge list <file>
uip flow edge delete <file> <edge-id>
Beachten Sie globale Optionen. Austrittscodes folgen dem Standardvertrag.
UIP-Flow-Knoten hinzufügen
Fügen Sie einen Knoten zu einer .flow -Datei hinzu. Der Knotentyp muss in der Registrierung vorhanden sein – verwenden Sie uip flow registry search um gültige <node-type> -Werte zu erkennen.
Argumente
<file>(erforderlich) – Der Pfad zur.flow-Datei.<node-type>(erforderlich) – Bezeichner des Knotentyps (z. Bcore.trigger.manual,uipath.connector.slack.send-message).
Optionen
| Option | Beschreibung |
|---|---|
-i, --input <json> | JSON-Objekt von Eingabewerten, die auf dem Knoten festgelegt werden sollen (z. B '{"script":"…"}'). Muss ein JSON-Objekt sein, kein Array oder Skalar. Übergeben Sie bei Connector- Knoten (Typ uipath.connector.*) hier nicht --input – führen Sie node configure anschließend aus. |
--position <x,y> | Position der Arbeitsfläche, z. B 250,150. Sowohl x als auch y sind erforderliche Zahlen. |
--label <label> | Anzeigebeschriftung für den Knoten. |
--source <uuid> | Quellbezeichner für Inline-Agentknoten (füllt model.source aus). |
Beispiel
uip flow node add invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
uip flow node add invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
Data shape (--output json)
{
"Code": "NodeAddSuccess",
"Data": {
"Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
"DefinitionAdded": true,
"BindingsCreated": 0,
"VariableCount": 0
}
}
{
"Code": "NodeAddSuccess",
"Data": {
"Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
"DefinitionAdded": true,
"BindingsCreated": 0,
"VariableCount": 0
}
}
DefinitionAdded ist true beim ersten Einfügen eines bestimmten node-type – der entsprechende Eintrag im .flow definitions[] -Array wird erstellt.
Konfigurieren des UIP-Flowknotens
Füllen Sie inputs.detail auf einem bereits hinzugefügten Knoten aus und erstellen Sie die benötigten Workflowbindungen. Führen Sie dies nach node add für Connector- und verwaltete HTTP-Knoten aus.
Argumente
<file>(erforderlich) – Der Pfad zur.flow-Datei.<node-id>(erforderlich) – ID des zu konfigurierenden Knotens (finden Sie unternode list).
Optionen
--detail <json>(erforderlich) – Konfigurations-JSON. Die Form hängt vom Knotentyp ab:
Connector-Knoten (uipath.connector.*)
Rufen Sie method und endpoint von connectorMethodInfo in der registry get -Ausgabe ab.
- Erforderlich:
connectionId,folderKey,method,endpoint - Optional:
bodyParameters,queryParameters,pathParameters
uip flow node configure invoice-flow.flow node_a1b2c3d4 --detail '{
"connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
"folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
"method": "POST",
"endpoint": "/issues",
"bodyParameters": { "summary": "Bug" }
}'
uip flow node configure invoice-flow.flow node_a1b2c3d4 --detail '{
"connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
"folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
"method": "POST",
"endpoint": "/issues",
"bodyParameters": { "summary": "Bug" }
}'
Verwaltete HTTP-Knoten (core.action.http.v2)
Zwei Authentifizierungsmodi:
Connector-Modus (authentication: "connector") – verwendet eine Integration Service-Verbindung für die Authentifizierung:
- Erforderlich:
authentication,method,connectionId,folderKey,targetConnector method∨GET,POST,PUT,PATCH,DELETE,OPTIONS,HEAD- Optional:
url(Pfad an Connector-Basis-URL angefügt),headers,query,body
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "connector",
"targetConnector": "uipath-microsoft-outlook365",
"connectionId": "…",
"folderKey": "…",
"method": "GET",
"url": "/me"
}'
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "connector",
"targetConnector": "uipath-microsoft-outlook365",
"connectionId": "…",
"folderKey": "…",
"method": "GET",
"url": "/me"
}'
Manueller Modus (authentication: "manual") – keine Connector-Authentifizierung, geben Sie die vollständige URL und alle Authentifizierungsheader selbst an:
- Erforderlich:
authentication,method,url(vollständige URL) - Optional:
headers,query,body(Zeichenfolge; kann ein Ausdruck sein, z. B=js:({…}))
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "manual",
"method": "GET",
"url": "https://api.example.com/data",
"headers": { "Authorization": "Bearer <token>" }
}'
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "manual",
"method": "GET",
"url": "https://api.example.com/data",
"headers": { "Authorization": "Bearer <token>" }
}'
Data shape (--output json)
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
UIP-Flow-Knotenliste
Listen Sie alle Knoten in einer .flow -Datei auf.
Argumente
<file>(erforderlich) – Der Pfad zur.flow-Datei.
Data shape (--output json)
{
"Code": "NodeListSuccess",
"Data": {
"Nodes": [
{ "id": "start", "type": "core.trigger.manual" },
{ "id": "node_a1b2c3d4", "type": "core.action.http.v2" }
],
"Count": 2
}
}
{
"Code": "NodeListSuccess",
"Data": {
"Nodes": [
{ "id": "start", "type": "core.trigger.manual" },
{ "id": "node_a1b2c3d4", "type": "core.action.http.v2" }
],
"Count": 2
}
}
Jeder Eintrag enthält mindestens id und type; der Dienst fügt auch Anzeigemetadaten aus dem .flow definitions[] -Array an.
Löschen des UIP-Flowknotens
Löschen Sie einen Knoten und alles, was dazu gehört. Entfernt:
- Verbundene Edges
- Verwaiste Bindungen
- Verwaiste Definitionen
- Knotenvariablen, die sich im Besitz des gelöschten Knotens befinden
- Variablenaktualisierungen, die dem gelöschten Knoten gehören
Argumente
<file>(erforderlich) – Der Pfad zur.flow-Datei.<node-id>(erforderlich) – ID des zu löschenden Knotens.
Data shape (--output json)
{
"Code": "NodeDeleteSuccess",
"Data": {
"DeletedNode": { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
"EdgesRemoved": 1,
"BindingsRemoved": 0,
"DefinitionsRemoved": 0,
"VariablesRemoved": 0,
"VariableUpdatesRemoved": 0
}
}
{
"Code": "NodeDeleteSuccess",
"Data": {
"DeletedNode": { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
"EdgesRemoved": 1,
"BindingsRemoved": 0,
"DefinitionsRemoved": 0,
"VariablesRemoved": 0,
"VariableUpdatesRemoved": 0
}
}
UIP-Flow Edge Add
Fügen Sie eine Edge zwischen zwei Knoten hinzu.
Argumente
<file>(erforderlich) – Der Pfad zur.flow-Datei.<source-id>(erforderlich) – ID des Quellknotens.<target-id>(erforderlich) – ID des Zielknotens.
Optionen
--source-port <port>– Name des Quellports (Standard:output).--target-port <port>– Zielportname (Standard:input).
Data shape (--output json)
{
"Code": "EdgeAddSuccess",
"Data": {
"Edge": {
"id": "edge_a1b2c3d4",
"source": "Node_1",
"target": "Node_2",
"sourcePort": "output",
"targetPort": "input"
}
}
}
{
"Code": "EdgeAddSuccess",
"Data": {
"Edge": {
"id": "edge_a1b2c3d4",
"source": "Node_1",
"target": "Node_2",
"sourcePort": "output",
"targetPort": "input"
}
}
}
UIP-Flow-Edge-Liste
{
"Code": "EdgeListSuccess",
"Data": {
"Edges": [
{ "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
],
"Count": 1
}
}
{
"Code": "EdgeListSuccess",
"Data": {
"Edges": [
{ "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
],
"Count": 1
}
}
UIP-Flow-Edge löschen
Löschen Sie eine einzelne Edge nach ID. Verwenden Sie edge list um die ID zu finden.
{
"Code": "EdgeDeleteSuccess",
"Data": {
"DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
}
}
{
"Code": "EdgeDeleteSuccess",
"Data": {
"DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
}
}
Variablen und Variablenaktualisierungen
Zwei begleitende Befehlsgruppen (noch nicht in der Seitenleiste) bearbeiten die Unterstrukturen variables und variable-update einer .flow -Datei.
UIP-Flow-Variable
uip flow variable add <file> <variable-id> -d <direction> [-t <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>]
uip flow variable list <file>
uip flow variable delete <file> <variable-id>
uip flow variable add <file> <variable-id> -d <direction> [-t <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>]
uip flow variable list <file>
uip flow variable delete <file> <variable-id>
direction∨in,out,inout(erforderlich).type∨string,number,boolean,object,array,file(Standard:string).--default-valuewird pro--typegeparst –object/array-Werte müssen gültige JSON der übereinstimmenden Form sein.--schemamuss ein JSON-Objekt sein (z. B'{"type":"string"}').
Datenstrukturen: VariableAddSuccess (Data.Variable), VariableListSuccess (Data.Variables[], Count), VariableDeleteSuccess (Data.DeletedVariable).
Aktualisierung der UIP-Flow-Variable
Fügen Sie einen JS-Ausdruck an einen Knoten an, der nach Abschluss ausgeführt und einer globalen Variablen zugewiesen wird (die out oder inout sein muss).
uip flow variable-update add <file> --node-id <id> --variable-id <id> --expression <expr>
uip flow variable-update list <file> [--node-id <id>]
uip flow variable-update delete <file> <node-id> <variable-id>
uip flow variable-update add <file> --node-id <id> --variable-id <id> --expression <expr>
uip flow variable-update list <file> [--node-id <id>]
uip flow variable-update delete <file> <node-id> <variable-id>
Dem Ausdruck wird automatisch =js: vorangestellt, wenn er fehlt. Beispiel: --expression "=js:ctx.output".
Datenstrukturen: VariableUpdateAddSuccess (Data.VariableUpdate), VariableUpdateListSuccess (Data.VariableUpdates[], Count), VariableUpdateDeleteSuccess (Data.DeletedUpdate).
Bindings
Bindungen deklarieren die externen Ressourcen, die ein Flow zum Zeitpunkt der Veröffentlichung/Bereitstellung benötigt (einen Zielprozess, ein Agent, eine Verbindung, eine Warteschlange, …) und welche Knoteneigenschaft sie verknüpfen.
uip flow binding add <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip flow binding list <file>
uip flow binding delete <file> <resource-key>
uip flow binding add <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip flow binding list <file>
uip flow binding delete <file> <resource-key>
<resource>muss einer vonVALID_RESOURCE_TYPESdes Dienstes sein (wird in der Fehlermeldung des Befehlsaddangezeigt, wenn ein ungültiger Wert übergeben wird).--property-attributeist die Zielknoteneigenschaft, die die Bindung ausfüllt (z. Bname,folderPath,connection).--resource-sub-typebietet eine Unterklassifizierung (z. BAgent,Process).binding deleteentfernt alle Bindungen mit dem angegebenen Ressourcenschlüssel, nicht einen einzelnen Eintrag nach ID.
Datenstrukturen: BindingAddSuccess (Data.Binding), BindingListSuccess (Data.Bindings[], Count), BindingDeleteSuccess (Data.DeletedBindings[], Count).
UIP-Flow aufgeräumt
Automatisches Layout: Positionieren Sie Knoten in einer .flow -Datei neu, um Überlappungen zu entfernen und das Diagramm sauber anzuordnen.
uip flow tidy <file>
uip flow tidy <file>
Datenform: Code: "FlowTidy", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned }.
Siehe auch
uip flow registry– Knotentypen erkennenuip flow validate– das bearbeitete.flowvalidierenuip flow init- Flow-Übersicht
- Zusammenfassung
- UIP-Flow-Knoten hinzufügen
- Argumente
- Optionen
- Beispiel
- Data shape (
--output json) - Konfigurieren des UIP-Flowknotens
- Argumente
- Optionen
- Connector-Knoten (uipath.connector.*)
- Verwaltete HTTP-Knoten (core.action.http.v2)
- Data shape (
--output json) - UIP-Flow-Knotenliste
- Argumente
- Data shape (
--output json) - Löschen des UIP-Flowknotens
- Argumente
- Data shape (
--output json) - UIP-Flow Edge Add
- Argumente
- Optionen
- Data shape (
--output json) - UIP-Flow-Edge-Liste
- UIP-Flow-Edge löschen
- Variablen und Variablenaktualisierungen
- UIP-Flow-Variable
- Aktualisierung der UIP-Flow-Variable
- Bindings
- UIP-Flow aufgeräumt
- Siehe auch