registro de fluxo uip

Sintaxe e opções para "uip flow registry", que navega no catálogo de atividades integradas e nós conectores disponíveis no Fluxo.

uip flow registry no registro de nós do fluxo — o catálogo de blocos de construção utilizáveis dentro de um arquivo .flow . O registro contém atividades OOTB (uipath.agent, uipath.http, …) e nós de conector que chamam APIs de terceiros (Slack, Salesforce, Jira, …). Quando conectado, o registro inclui também nós de conectores instalados em seu tenant.

The registry also includes document-extraction nodes for published UiPath IXP models (uipath.ixp.*).

O registro é compartilhado entre superfícies de fluxo de trabalho da UiPath; a mesma implementação suporta uip maestro (consulte registro do Maestro, exposto por meio de uip maestro bpmn registry).

Todos os subcomandos honram as opções globais. Os códigos de saída seguem o contrato padrão.

Resumo

uip flow registry pull   [-f, --force]
uip flow registry list   [-l, --limit <n>] [--local]
uip flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip flow registry get    <nodeType> [--connection-id <id>] [--local]

Fluxo de trabalho típico

# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip flow registry pull

# 2. Search for a candidate node
uip flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"

Sem o login, apenas os nós integrados (OTB) são retornados.

---

pull do registro de fluxo uip

Busca o registro do nó e o grava em um cache local. As chamadas list, search e get subsequentes são lidas a partir desse cache.

Opções

• -f, --force forçar a atualização, ignorando o cache.

Comportamento do cache

• O cache expira após 30 minutos. Um cache expirado ou ausente dispara uma busca ao vivo.
• Quando não conectados, os nós OOTB são retornados sem atualizar o cache.
• Em uma falha de busca autenticada, o comando retorna aos nós OOTB sem atualizar o cache.

Formato dos dados (--output json)

{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}

Source é "ootb" (não autenticado) ou "authenticated" (específico do tenant). AgeMinutes é preenchido quando FromCache: true.

---

lista de registros de fluxo uip

Exemplo de nós em cache. O padrão são as 20 primeiras entradas.

Opções

Opção	Padrão	Description
-l, --limit <n>	20	Número de nós a serem retornados. Passar -1 para todos. Deve ser um número inteiro positivo ou -1.
--local	desativada	Mostrar apenas nós do projeto na solução. Requer um .uipx no CWD, pai ou av.

Se list for chamado sem um pull anterior, o serviço buscará dados ativos primeiro.

Formato dos dados

{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}

Se o resultado for truncado, uma linha de log será emitida em stderr mostrando total versus mostrado.

---

pesquisa de registro de fluxo uip

Encontre nós por palavra-chave, por filtro estruturado ou ambos.

Argumentos

• [keyword] — substring correspondente a nodeType, category, tags, display.label, description.

Opções

Opção	Description
-f, --filter <expr>	Filtro de campo estruturado (consulte a sintaxe abaixo).
--local	Pesquisar apenas nós na solução (requer .uipx nas próximas).

Pelo menos um dos <keyword> ou --filter é necessário.

Sintaxe de filtro

field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)

Operadores: (padrão), equals , contains, startsWith, endsWith in

Campos filtráveis (aliases mostrados entre parênteses):

• category [cat] — por exemplo connector, agent, trigger
• type [nodetype] — identificador de tipo de nó
• tags [tag] — tags de nó
• displayname [display_name, name, label] — nome legível por humanos

Exemplos

uip flow registry search slack
uip flow registry search --filter "category=connector"
uip flow registry search --filter "displayname:contains=send message"
uip flow registry search slack --filter "category=connector"
uip flow registry search --filter "tags:in=ai,automation"
uip flow registry search --filter "category=connector,displayname:contains=slack"
uip flow registry search uipath.ixp

Formato dos dados: mesmo formato que list — Code: "NodeSearchSuccess", Data: [flattened nodes…].

---

Obtenção de registro de fluxo uip

Retorna detalhes completos de um único nó.

Argumentos

• <nodeType> (exigido) — identificador de tipo de nó (sem diferenciação entre maiúsculas e minúsculas).

Opções

Opção	Description
--connection-id <id>	ID de conexão para o enriquecimento do Integration Service. Obrigatório para nós do gatilho de conector; opcional para nós de atividade de conector.
--local	Obtenha nó apenas de projetos na solução.

Enriquecimento do Integration Service

Para nós com a tag "connector", get chama automaticamente o Integration Service e mescla metadados ao vivo:

Nós de atividade de conector (uipath.connector.*, não gatilho):

• inputDefinition.fields[] — campos para configurar. Cada um tem name, displayName, type, required e, opcionalmente reference (pesquisa: objectName, path, lookupValue, lookupNames, childPath) ou enum.
• outputResponseDefinition — campos produzidos após a execução do nó.
• connectorMethodInfo — método HTTP, caminho e id da operação.
• é opcional --connection-id passar um adiciona campos personalizados específicos a essa conta.

Nós de gatilho de conector (uipath.connector.trigger.*):

• eventParameters — campos que configuram o gatilho (por exemplo, qual pasta observar).
• filterFields campos usados para filtrar quais eventos disparam o gatilho.
• outputResponseDefinition — campos produzidos pela carga do evento.
• eventMode — "webhooks" ou "polling".
• O login e --connection-id são obrigatórios — sem ambos, nenhum enriquecimento é retornado.

Metadados por campo de entrada

Cada entrada em inputDefinition.fields:

Propriedade	Description
name	Chave JSON para a solicitação/resposta.
displayName	Rótulo legível por humanos.
type	Tipo de dados (string, boolean, integer, …).
required	true se obrigatório (somente campos de entrada).
description	O que o campo faz.
enum	Valores permitidos (se restrito).
reference	Metadados de referência do objeto — o campo espera um ID, não um nome simples.
responseOnly	true em campos de saída.

Formato dos dados

{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}

Exemplos

# Basic activity lookup (anonymous, OOTB)
uip flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json

IXP model nodes

Published UiPath IXP extraction models appear in the registry as node types under the uipath.ixp.* namespace. The identifier encodes the model — for example:

• uipath.ixp.invoice-model.shared-invoice-model
• uipath.ixp.birth-certificates-oob.shared-birth-certificates-oob

A namespace search returns them:

uip flow registry search uipath.ixp

uip flow registry get <nodeType> returns the deployment coordinates under inputDefaults (inputDefaults.modelName and inputDefaults.folderKey), which populate the node's inputs.model block when the node is added to a flow.

Instance shape

An uipath.ixp.* node added to a .flow file must follow this shape:

Campo	Requisito
inputs.model	Object with non-empty string modelName and folderKey.
inputs.fileRef	A =js:$vars.… expression referencing an upstream output, in the form =js:$vars.<upstream>.output.<field>.
outputs.output	Present on the instance. Downstream nodes read $vars.<nodeId>.output.
outputs.error	Present on the instance. Downstream nodes read $vars.<nodeId>.error.

To wire discovered nodes into a flow, see uip flow node add and uip flow node configure.

Veja também

• uip flow node add e uip flow node configure — tipos de nó de consumo descobertos aqui
• Visão geral do fluxo