- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
Un flux est un graphique. Les nœuds sont les verticaux (déclencheurs, activités, connecteurs, agents); Les bords sont les connexions directes entre eux. Les commandes uip flow node et uip flow edge modifient un fichier .flow en place — en ajoutant, en configurant, en répertoriant et en supprimant les deux.
Cette page couvre également trois groupes de commandes complémentaires qui modifient le fichier .flow de la même manière: variable, variable-update et binding.
Synthèse
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>
Les options globales sont respectées. Les codes de sortie suivent le contrat standard.
ajout de nœud de flux uip
Ajoutez un nœud à un fichier .flow . Le type de nœud doit exister dans le registre. Utilisez uip flow registry search pour découvrir des valeurs <node-type> valides.
Arguments
<file>(obligatoire) : chemin d'accès au fichier.flow.<node-type>(obligatoire) : identificateur de type de nœud (par ex.core.trigger.manual,uipath.connector.slack.send-message).
Options
| Option | Description |
|---|---|
-i, --input <json> | Objet JSON des valeurs d'entrée à définir sur le nœud (par ex. '{"script":"…"}'). Doit être un objet JSON, et non un tableau ou un scalaire. Pour les nœuds de connecteur (type uipath.connector.*), ne transmettez pas --input ici — exécutez node configure ensuite. |
--position <x,y> | Position de la zone de dessin, par exemple 250,150. X et y sont tous deux des nombres requis. |
--label <label> | Affichez le libellé pour le nœud. |
--source <uuid> | Identifiant source pour les nœuds d'agent en ligne (remplit model.source). |
Exemple
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"
Format des données (--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 est true lors de la première insertion d'un node-type donné — l'entrée correspondante dans le tableau .flow definitions[] est créée.
configuration du nœud de flux uip
Renseignez inputs.detail sur un nœud déjà ajouté et créez les liaisons de workflow dont il a besoin. Exécutez-le après node add pour le connecteur et les nœuds HTTP gérés.
Arguments
<file>(obligatoire) : chemin d'accès au fichier.flow.<node-id>(requis) — ID du nœud à configurer (recherchez-le avecnode list).
Options
--detail <json>(obligatoire) — configuration JSON. La forme dépend du type de nœud:
Nœuds du connecteur
Obtenez method et endpoint de connectorMethodInfo dans la sortie registry get .
- Requis:
connectionId,folderKey,method,endpoint - Facultatif:
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" }
}'
Nœuds HTTP gérés
Deux modes d'authentification:
Mode connecteur (authentication: "connector") — utilise une connexion Integration Service pour l'authentification:
- Requis:
authentication,method,connectionId,folderKey,targetConnector methodⅵGET,POST,PUT,PATCH,DELETE,OPTIONS,HEAD- Facultatif:
url(chemin ajouté à l'URL de base du connecteur),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"
}'
Mode manuel (authentication: "manual") — sans authentification du connecteur, fournissez vous-même l'URL complète et les en-têtes d'authentification:
- Requis:
authentication,method,url(URL complète) - Facultatif:
headers,query,body(chaîne; peut être une expression, par ex.=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>" }
}'
Format des données (--output json)
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
liste des nœuds de flux UiP
Répertorie tous les nœuds dans un fichier .flow .
Arguments
<file>(obligatoire) : chemin d'accès au fichier.flow.
Format des données (--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
}
}
Chaque entrée inclut au minimum id et type; le service joint également les métadonnées d'affichage du tableau .flow definitions[] .
suppression de nœuds de flux uip
Supprimez un nœud et tout ce qu'il contient. Supprime:
- Bords connectés
- Liaisons orphelines
- Définitions orphelines
- Variables de nœud appartenant au nœud supprimé
- Mises à jour des variables appartenant au nœud supprimé
Arguments
<file>(obligatoire) : chemin d'accès au fichier.flow.<node-id>(requis) — L'ID du nœud à supprimer.
Format des données (--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
}
}
ajout de bord de flux uip
Ajoutez un bord entre deux nœuds.
Arguments
<file>(obligatoire) : chemin d'accès au fichier.flow.<source-id>(requis) : ID du nœud source.<target-id>(requis) : ID du nœud cible.
Options
--source-port <port>— nom du port source (par défaut:output).--target-port <port>— nom du port cible (par défaut:input).
Format des données (--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"
}
}
}
liste des bords du flux uip
{
"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
}
}
suppression du bord du flux uip
Supprimez un bord unique par ID. Utilisez edge list pour trouver l'ID.
{
"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" }
}
}
Variables et mises à jour de variables
Deux groupes de commandes compagnons (pas encore dans la barre latérale) modifient les sous-arbres variables et de mise à jour des variables d'un fichier .flow .
variable de flux uip
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(requis).typeⅵstring,number,boolean,object,array,file(par défautstring).--default-valueest analysé par--type—object/arrayLes valeurs doivent être valides JSON de la forme correspondante.--schemadoit être un objet JSON (par ex.'{"type":"string"}').
Formats de données: VariableAddSuccess (Data.Variable), VariableListSuccess (Data.Variables[], Count), VariableDeleteSuccess (Data.DeletedVariable).
mise à jour des variables de flux UiPath
Joignez une expression JS à un nœud qui s'exécute à la fin et s'affecte à une variable globale (qui doit être out ou inout).
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>
L'expression est automatiquement préfixée par =js: si manquant. Exemple: --expression "=js:ctx.output".
Formats de données: VariableUpdateAddSuccess (Data.VariableUpdate), VariableUpdateListSuccess (Data.VariableUpdates[], Count), VariableUpdateDeleteSuccess (Data.DeletedUpdate).
Bindings
Les liaisons déclarent les ressources externes dont un flux a besoin au moment de la publication/du déploiement (un processus cible, un agent, une connexion, une file d'attente, etc.) et la propriété du nœud dans lequel il se connecte.
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>doit être l'un desVALID_RESOURCE_TYPESdu service (affiché dans le message d'erreur de la commandeaddsi une valeur non valide est transmise).--property-attributeest la propriété du nœud cible renseignée par la liaison (par ex.name,folderPath,connection).--resource-sub-typefournit la sous-classification (par ex.Agent,Process).binding deletesupprime toutes les liaisons avec la clé de ressource donnée, et pas une seule entrée par ID.
Formats de données: BindingAddSuccess (Data.Binding), BindingListSuccess (Data.Bindings[], Count), BindingDeleteSuccess (Data.DeletedBindings[], Count).
Classement du flux UIP
Disposition automatique: repositionnez les nœuds dans un fichier .flow pour supprimer les chevauchements et organiser le graphique proprement.
uip flow tidy <file>
uip flow tidy <file>
Format des données: Code: "FlowTidy", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned }
Voir également
uip flow registry— découvrir les types de nœudsuip flow validate— valide le.flowmodifiéuip flow init- Vue d’ensemble du flux
- Synthèse
- ajout de nœud de flux uip
- Arguments
- Options
- Exemple
- Format des données (
--output json) - configuration du nœud de flux uip
- Arguments
- Options
- Nœuds du connecteur
- Nœuds HTTP gérés
- Format des données (
--output json) - liste des nœuds de flux UiP
- Arguments
- Format des données (
--output json) - suppression de nœuds de flux uip
- Arguments
- Format des données (
--output json) - ajout de bord de flux uip
- Arguments
- Options
- Format des données (
--output json) - liste des bords du flux uip
- suppression du bord du flux uip
- Variables et mises à jour de variables
- variable de flux uip
- mise à jour des variables de flux UiPath
- Bindings
- Classement du flux UIP
- Voir également