UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

nó de fluxo uip e borda de fluxo uip

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 flow node e uip flow edge editam um arquivo .flow no local — adicionando, configurando, listando e excluindo ambos.

Esta página também abrange três grupos de comando associados que editam o arquivo .flow da mesma maneira: variable, variable-update e binding.

Resumo

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>

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


adição de nó de fluxo uip

Adicione um nó a um arquivo .flow . O tipo de nó deve existir no registro — use uip 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).

Exemplo

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"

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ó de fluxo uip

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 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ó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
  • methodGET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD
  • Opcional url (caminho anexado ao URL base do conector), 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"
}'

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 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>" }
}'

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 uip

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[] .


exclusão de nó de fluxo uip

Exclua 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ó excluído
  • Atualizações de variáveis de propriedade do nó excluído

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 uip

Adicione uma borda entre dois nós.

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 bordas de fluxo 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
  }
}

exclusão de borda de fluxo de uip

Excluir uma única borda por ID. 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 e atualizações de variáveis

Dois grupos de comando associados (ainda não na barra lateral) editam as subárvores variables e de atualização por variáveis de um arquivo .flow .

variável de fluxo 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>
  • directionin, 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"}').

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

atualização da variável de fluxo da uip

Anexe uma expressão JS a um nó que é executado na conclusão e atribui a uma variável global (que deve ser 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>

A expressão é automaticamente prefixada com =js: se estiver ausente. Exemplo: --expression "=js:ctx.output".

Formas de dados: VariableUpdateAddSuccess (Data.VariableUpdate), VariableUpdateListSuccess (Data.VariableUpdates[], Count), VariableUpdateDeleteSuccess (Data.DeletedUpdate).


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 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> 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 delete 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), BindingDeleteSuccess (Data.DeletedBindings[], Count).


fluxo de uiip organizado

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

uip flow tidy <file>
uip flow tidy <file>

Formato dos dados: Code: "FlowTidy", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned }.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades