UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Nœud du flux uip Maestro et bord du flux uip Maestro

Syntaxe et options pour `uip nœud de flux Maestro` et `uip Maestro flow Edge`, qui ajoutent, configurent, répertorient et suppriment les nœuds et les bords dans un fichier `.flow`.

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 maestro flow node et uip maestro flow edge modifient un fichier .flow en place — ajout, configuration, liste et suppression des deux.

Cette page couvre également deux groupes de commandes complémentaires qui modifient le fichier .flow de la même manière: variable et binding.

Synthèse

uip maestro flow node add       <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip maestro flow node configure <file> <node-id> --detail <json>
uip maestro flow node list      <file>
uip maestro flow node remove    <file> <node-id>

uip maestro flow edge add    <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip maestro flow edge list   <file>
uip maestro flow edge remove <file> <edge-id>
uip maestro flow node add       <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip maestro flow node configure <file> <node-id> --detail <json>
uip maestro flow node list      <file>
uip maestro flow node remove    <file> <node-id>

uip maestro flow edge add    <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip maestro flow edge list   <file>
uip maestro flow edge remove <file> <edge-id>

Les options globales sont respectées. Les codes de sortie suivent le contrat standard.


ajout de nœuds de flux uip maestro

Ajoutez un nœud à un fichier .flow . Le type de nœud doit exister dans le registre. Utilisez uip maestro 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

OptionDescription
-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).
--parent <node-id>ID du nœud existant qui doit contenir ce nœud — défini lors de la création d'un corps de boucle dont le contenu ne peut pas être déduit des bords seuls (généralement l'ID d'un nœud core.logic.loop).

Exemple

uip maestro flow node add invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
uip maestro 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 maestro

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 avec node 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 maestro 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 maestro 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
  • methodGET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD
  • Facultatif: url (chemin ajouté à l'URL de base du connecteur), headers, query, body
uip maestro flow node configure invoice-flow.flow node_abc --detail '{
  "authentication":  "connector",
  "targetConnector": "uipath-microsoft-outlook365",
  "connectionId":    "…",
  "folderKey":       "…",
  "method":          "GET",
  "url":             "/me"
}'
uip maestro 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 maestro flow node configure invoice-flow.flow node_abc --detail '{
  "authentication": "manual",
  "method":         "GET",
  "url":            "https://api.example.com/data",
  "headers":        { "Authorization": "Bearer <token>" }
}'
uip maestro 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 maestro

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 du nœud de flux uip maestro

delete est un alias enregistré pour remove — les deux suppriment un nœud du fichier.

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 Maestro

Ajoutez un bord entre deux nœuds. delete est un alias enregistré pour edge remove.

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 Maestro

{
  "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 Maestro

Supprime un seul bord 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

Un groupe de commandes compagnon (pas encore dans la barre latérale) modifie le sous-arbre variables d'un fichier .flow.

Correction: une version antérieure de cette page documentait également un groupe de commandes variable-update (ajouter/liste/supprimer, association d'une expression JS à un nœud). Ce groupe n'existe nulle part dans le référentiel - il n'a jamais été enregistré et aucun fichier d'implémentation n'existe. Il a été supprimé de cette page.

variable de flux uip maestro

uip maestro flow variable add    <file> <variable-id> -d, --direction <direction> [-t, --type <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>] [--trigger-node-id <nodeId>]
uip maestro flow variable list   <file>
uip maestro flow variable remove <file> <variable-id>
uip maestro flow variable add    <file> <variable-id> -d, --direction <direction> [-t, --type <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>] [--trigger-node-id <nodeId>]
uip maestro flow variable list   <file>
uip maestro flow variable remove <file> <variable-id>
  • directionin, out, inout (requis).
  • typestring, number, boolean, object, array, file (par défaut string).
  • --default-value est analysé par --typeobject/array Les valeurs doivent être valides JSON de la forme correspondante.
  • --schema doit être un objet JSON (par ex. '{"type":"string"}').
  • --trigger-node-id <nodeId> — le nœud de déclencheur auquel appartient une variable d'entrée . La valeur par défaut est le seul nœud de déclencheur du flux; requis lorsque le flux comporte plusieurs points d'entrée.

Formats de données: VariableAddSuccess (Data.Variable), VariableListSuccess (Data.Variables[], Count), VariableRemoveSuccess (Data.DeletedVariable).


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 maestro flow binding add    <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip maestro flow binding list   <file>
uip maestro flow binding remove <file> <resource-key>
uip maestro flow binding add    <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip maestro flow binding list   <file>
uip maestro flow binding remove <file> <resource-key>
  • <resource> doit être l'un des VALID_RESOURCE_TYPES du service (affiché dans le message d'erreur de la commande add si une valeur non valide est transmise).
  • --property-attribute est la propriété du nœud cible renseignée par la liaison (par ex. name, folderPath, connection).
  • --resource-sub-type fournit la sous-classification (par ex. Agent, Process).
  • binding remove (le seul verbe enregistré — il n'y a pas d'alias binding delete , contrairement à node/edge) supprime 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), BindingRemoveSuccess (Data.DeletedBindings[], Count).


Format de flux uip maestro

Disposition automatique: repositionnez les nœuds dans un fichier .flow pour supprimer les chevauchements et organiser le graphique proprement.

uip maestro flow format <file>
uip maestro flow format <file>

Format des données: Code: "FlowFormat", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned, NodesResized, SubflowsTidied, VariableCount }

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour