UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

nó de fluxo do uip Maestro e borda de fluxo do uip Maestro

Sintaxe e opções para "uip Maestro flow node" e "uip Maestro flow Edge", que adicionam, configuram, listam e removem nós e bordas em um arquivo ".flow".

Um fluxo é um gráfico. Os nós são os nós (gatilhos, atividades, conectores, agentes); as bordas são as conexões direcionadas entre elas. Os comandos uip maestro flow node e uip maestro flow edge editam um arquivo .flow no local — adicionando, configurando, listando e removendo ambos.

Esta página também abrange dois grupos de comandos associados que editam o arquivo .flow da mesma maneira: variable e binding.

Resumo​

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>

Recebe opções globais. Os códigos de saída seguem o contrato padrão.


adição de nó do fluxo do uip Maestro​

Adicione um nó a um arquivo .flow . O tipo de nó deve existir no registro — use uip maestro flow registry search para descobrir valores <node-type> válidos.

Argumentos​

  • <file> (necessário) — caminho para o arquivo .flow .
  • <node-type> (obrigatório) — identificador do tipo de nó (por exemplo core.trigger.manual, uipath.connector.slack.send-message).

Opções​

OpçãoDescription
-i, --input <json>Objeto JSON de valores de entrada a ser definido no nó (por exemplo '{"script":"…"}'). Deve ser um objeto JSON, não um array ou escalar. Para nós conectores (tipo uipath.connector.*), não passe --input aqui — execute node configure depois.
--position <x,y>Posição da tela, por exemplo 250,150 X e y são números obrigatórios.
--label <label>Rótulo de exibição para o nó.
--source <uuid>Identificador de origem para nós de agentes embutidos (preenche model.source).
--parent <node-id>ID do nó existente que deve conter esse nó — definido ao criar um corpo de loop cuja contenção não pode ser inferida apenas das bordas (normalmente o id de um nó core.logic.loop).

Exemplo​

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"

Formato dos dados (--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
  }
}

true DefinitionAdded primeira inserção de um determinado node-type — a entrada correspondente na matriz .flow definitions[] é criada.


Configuração de nó do fluxo do uip Maestro​

Preencha inputs.detail em um nó já adicionado e crie as associações de fluxo de trabalho de que ele precisa. Execute isso após node add para nós conectores e HTTP gerenciados.

Argumentos​

  • <file> (necessário) — caminho para o arquivo .flow .
  • <node-id> (necessário) — ID do nó a ser configurado (encontre-o com node list).

Opções​

  • --detail <json> necessário) — configuração JSON. A forma depende do tipo de nó:

Nós de conector (uipath.connector.*)​

Obtenha method e endpoint de connectorMethodInfo na saída registry get .

  • Obrigatório: connectionId, folderKey, method, endpoint
  • Opcional: 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ós HTTP gerenciados (core.action.http.v2)​

Dois modos de autenticação:

Modo de conector (authentication: "connector") — usa uma conexão do Integration Service para autenticação:

  • Obrigatório: authentication, method, connectionId, folderKey, targetConnector
  • method ∈ GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD
  • Opcional url (caminho anexado ao URL base do conector), 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"
}'

Modo manual (authentication: "manual") — sem autenticação de conector, forneça você mesmo o URL completo e quaisquer cabeçalhos de autenticação:

  • Obrigatório: authentication, method, url (URL completa)
  • Opcional: headers, query, body (string; pode ser uma expressão, por exemplo =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>" }
}'

Formato dos dados (--output json)​

{
  "Code": "NodeConfigureSuccess",
  "Data": {
    "NodeId": "node_a1b2c3d4",
    "BindingsCreated": 2,
    "DetailPopulated": true
  }
}
{
  "Code": "NodeConfigureSuccess",
  "Data": {
    "NodeId": "node_a1b2c3d4",
    "BindingsCreated": 2,
    "DetailPopulated": true
  }
}

lista de nós do fluxo do UIP Maestro​

Lista todos os nós em um arquivo .flow .

Argumentos​

  • <file> (necessário) — caminho para o arquivo .flow .

Formato dos dados (--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
  }
}

Cada entrada inclui no mínimo id e type; o serviço também anexa metadados de exibição da matriz .flow definitions[] .


remoção de nó de fluxo do uip Maestro​

delete é um alias registrado para remove — ambos removem um nó do arquivo.

Remova um nó e tudo o que ele contém. Remove:

  • Bordas conectadas
  • Associações órfãs
  • Definições órfãs
  • Variáveis de nó que pertencem ao nó removido
  • Atualizações de variáveis de propriedade do nó removido

Argumentos​

  • <file> (necessário) — caminho para o arquivo .flow .
  • <node-id> (necessário) — ID do nó a excluir.

Formato dos dados (--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
  }
}

adição de borda de fluxo do uip Maestro​

Adicione uma borda entre dois nós. delete é um alias registrado para edge remove.

Argumentos​

  • <file> (necessário) — caminho para o arquivo .flow .
  • <source-id> (necessário) — ID do nó de origem.
  • <target-id> (necessário) — ID do nó de destino.

Opções​

  • --source-port <port> — nome da porta de origem (padrão: output).
  • — nome input --target-port <port> .

Formato dos dados (--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"
    }
  }
}

lista de borda de fluxo de Maestro do 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
  }
}

remoção de borda de fluxo do uip Maestro​

Remove uma única borda por ID. Use edge list para encontrar o 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" }
  }
}

Variáveis​

Um grupo de comando associado (ainda não na barra lateral) edita a variables subárvore de um .flow arquivo.

Correção: uma versão anterior desta página também documentou um grupo de comando variable-update (adicionar/listar/remover, anexando uma expressão JS a um nó). Esse grupo não existe em nenhum lugar do repositório — nunca foi registrado e não existe nenhum arquivo de implementação. Ele foi removido desta página.

variável de fluxo do Maestro uip​

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>
  • direction ∈ in, out, inout (necessário).
  • ∈ type , string, number, boolean, object, array ( string file .
  • --default-value é analisado por --type — os valores object/array devem ser JSON válido da forma de correspondência.
  • --schema ser um objeto JSON (por exemplo '{"type":"string"}').
  • --trigger-node-id <nodeId> o nó do gatilho ao qual uma variável de entrada pertence. O padrão é o único nó de gatilho do fluxo; necessário quando o fluxo tem mais de um ponto de entrada.

Formas de dados: VariableAddSuccess (Data.Variable), VariableListSuccess (Data.Variables[], Count), VariableRemoveSuccess (Data.DeletedVariable).


Bindings​

As associações declaram os recursos externos de que um fluxo precisa no momento de publicar/implantar (um processo de destino, um agente, uma conexão, uma fila, …) e em qual propriedade de nó eles se conectam.

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> deve ser um dos VALID_RESOURCE_TYPES do serviço (exibido na mensagem de erro do comando add se um valor inválido for passado).
  • --property-attribute a propriedade do nó de destino que a associação preenche (por exemplo name, folderPath, connection).
  • --resource-sub-type fornece subclassificação (por exemplo Agent, Process).
  • binding remove (o único verbo registrado — não há alias binding delete , ao contrário de node/edge) remove todas as associações com a chave de recurso fornecida, não uma única entrada por ID.

Formas de dados: BindingAddSuccess (Data.Binding), BindingListSuccess (Data.Bindings[], Count), BindingRemoveSuccess (Data.DeletedBindings[], Count).


formato de fluxo do uip Maestro​

Layout automático: reposicione os nós em .flow arquivo para remover sobreposições e organizar o gráfico de forma limpa.

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

Formato dos dados: Code: "FlowFormat", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned, NodesResized, SubflowsTidied, VariableCount }.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades