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.

registro bpmn do uip Maestro

Navegue pelo registro BPMN do Maestro de tipos de extensão, conectores do Integration Service e processos do Orchestrator usando o "registro UIP Maestro bpmn".

uip maestro bpmn registry navega e pesquisa o registro BPMN do Maestro — um catálogo dos tipos de extensão BPMN, conectores do Integration Service e processos descobertos pelo Orchestrator que o Maestro pode criar. Agentes (humanos ou não) o usam para descobrir quais tipos de extensão existem, pesquisar suas formas e enriquecer tipos de conectores com metadados em tempo real do Integration Service antes de gerar BPMN.

Sem o login, apenas os tipos de extensão integrados (OTB) estão disponíveis. Faça login para ver conectores e processos descobertos no Integration Service e no Orchestrator.

Resumo​

uip maestro bpmn registry <verb> [options]
uip maestro bpmn registry <verb> [options]

Fluxo de trabalho típico:

  1. ( uip login — os tipos OOTB funcionam offline).
  2. uip maestro bpmn registry pull sincronize o registro no cache local.
  3. uip maestro bpmn registry search <keyword> encontre uma entrada.
  4. uip maestro bpmn registry get <extensionType> inspecione a especificação completa.

Verbo​

TextoFinalidade
pullBuscar e armazenar em cache o registro (BPMN estático + recursos descobertos).
listListar tipos de extensão em cache e recursos descobertos.
searchEncontre entradas por palavra-chave em tipos de extensão, conectores e processos.
getObter as especificações completas para um único tipo de extensão; opcionalmente, enriqueça com metadados IS.

Todos os verbos honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Extração do registro bpmn do uip Maestro​

Buscar e armazenar em cache o registro. Por padrão, retorna resultados em cache quando novos; passe --force para sincronizar novamente.

Opções​

ShortLongValorPadrãoDescription
-f--forceBandeiradesativadaIgnore o cache e busque novamente.

Exemplos​

uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force

Formato dos dados (--output json)​

{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "ProcessCountsByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    },
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}
{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "ProcessCountsByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    },
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}

ProcessCountsByType divide ProcessCount pelo tipo de processo descoberto.

Quando o cache é usado, FromCache é true, AgeMinutes relata a idade do cache e Message é Using cached registry (age: <n>m).

lista de registros bpmn do uip Maestro​

Listar tipos de extensão em cache e recursos descobertos. O limite padrão é 30; passar --limit -1 para todos.

Opções​

ShortLongValorPadrãoDescription
-l--limitNúmero30Número de tipos de extensão a serem retornados; -1 todos.

Exemplos​

uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1

Formato dos dados (--output json)​

{
  "Code": "RegistryListSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Orchestrator.StartJob",
        "Label": "Start Job",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:startJob",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "No"
      }
    ],
    "Connectors": [
      {
        "Key": "slack",
        "Name": "Slack",
        "Connections": 2,
        "Activities": 14,
        "Triggers": 3
      }
    ],
    "Processes": [
      {
        "Name": "InvoiceProcessing",
        "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
        "Type": "Maestro",
        "Folder": "Shared"
      }
    ],
    "ProcessesByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}
{
  "Code": "RegistryListSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Orchestrator.StartJob",
        "Label": "Start Job",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:startJob",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "No"
      }
    ],
    "Connectors": [
      {
        "Key": "slack",
        "Name": "Slack",
        "Connections": 2,
        "Activities": 14,
        "Triggers": 3
      }
    ],
    "Processes": [
      {
        "Name": "InvoiceProcessing",
        "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
        "Type": "Maestro",
        "Folder": "Shared"
      }
    ],
    "ProcessesByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

Se o resultado for truncado, uma nota Showing first <n> of <total> extension types será gravada nos logs.

Pesquise o registro por palavra-chave em IDs de tipo de extensão, rótulos, nomes de conectores e nomes de processos. A correspondência da palavra-chave é insensível a maiúsculas e minúsculas.

Argumentos​

NameRequiredFinalidade
<keyword>simTermo de pesquisa.

Exemplos​

uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent

Formato dos dados (--output json)​

{
  "Code": "RegistrySearchSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Intsvc.ActivityExecution",
        "Label": "Execute Activity",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:activityExecution",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "Yes"
      }
    ],
    "Connectors": [
      { "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
    ],
    "Processes": [
      { "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
    ],
    "ProcessesByType": {
      "Process": 1,
      "ProcessOrchestration": 0,
      "Agent": 0,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}
{
  "Code": "RegistrySearchSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Intsvc.ActivityExecution",
        "Label": "Execute Activity",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:activityExecution",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "Yes"
      }
    ],
    "Connectors": [
      { "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
    ],
    "Processes": [
      { "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
    ],
    "ProcessesByType": {
      "Process": 1,
      "ProcessOrchestration": 0,
      "Agent": 0,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

Registro bpmn do uip Maestro Get​

Obtenha as especificações completas para um único tipo de extensão. Para tipos de conector (Intsvc.ActivityExecution, Intsvc.WaitForEvent, Intsvc.EventTrigger, …), passe --connection-id e --object-name para enriquecer a resposta com metadados de campo ao vivo do Integration Service; adicione --operation para selecionar quais campos da operação retornar.

Argumentos​

NameRequiredFinalidade
<extensionType>simIdentificador do tipo de extensão (por exemplo, Orchestrator.StartJob).

Opções​

ShortLongValorPadrãoDescription
—--connection-idID—ID de conexão para o enriquecimento do Integration Service. Requer --object-name.
—--object-namename—Nome do objeto para o enriquecimento do Integration Service. Requer --connection-id.
—--operation <name>name—Operação cujos campos de solicitação/resposta serão retornados (por exemplo Create, INCIDENT_CREATED). Para tipos de atividade, o padrão é a única operação do objeto (e a resposta lista as operações disponíveis quando há mais de uma). Para tipos de eventos, é necessário — um objeto pode expor várias operações de evento, portanto, nunca é inferido.

Validação​

  • --connection-id e --object-name devem ser fornecidos juntos — apenas um falha com IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.
  • --connection-id/--object-name aplicam-se apenas a tipos Intsvc.* — usá-los contra um tipo de extensão que nãoIntsvc falha, nomeando Intsvc.ActivityExecution/Intsvc.EventTrigger como exemplos válidos.
  • Para um tipo de extensão marcado de evento (extensionTag: "uipath:event"), a omissão de --operation falha com Event enrichment requires --operation, apontando para uip is activities list <connector> --triggers para descobrir os nomes de operações válidos.

Exemplos​

uip maestro bpmn registry get Orchestrator.StartJob

# Connector activity type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts

# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts --operation Create

# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
    --connection-id abc123 --object-name contacts --operation INCIDENT_CREATED

# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
    --output-filter 'Data.ExtensionType'
uip maestro bpmn registry get Orchestrator.StartJob

# Connector activity type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts

# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts --operation Create

# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
    --connection-id abc123 --object-name contacts --operation INCIDENT_CREATED

# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
    --output-filter 'Data.ExtensionType'

Formato dos dados (--output json)​

Resposta base:

{
  "Code": "RegistryGetSuccess",
  "Data": {
    "ExtensionType": {
      "extensionType": "Orchestrator.StartJob",
      "label": "Start Job",
      "bpmnElement": "bpmn:ServiceTask",
      "extensionTag": "uipath:startJob"
    }
  }
}
{
  "Code": "RegistryGetSuccess",
  "Data": {
    "ExtensionType": {
      "extensionType": "Orchestrator.StartJob",
      "label": "Start Job",
      "bpmnElement": "bpmn:ServiceTask",
      "extensionTag": "uipath:startJob"
    }
  }
}

Quando --connection-id e --object-name (e, para tipos de evento, --operation) são fornecidos e a chamada do Integration Service é bem-sucedida, a resposta também inclui um campo ISEnrichment contendo a carga de metadados em tempo real. Se a chamada de enriquecimento falhar — incluindo quando o Integration Service não retorna nenhum metadados de campo para o objeto/operação fornecido — um aviso é registrado e ISEnrichment é omitido; a especificação base ainda é retornada.

  • uip maestro bpmn pack — empacotar um projeto do Maestro; o registro informa quais tipos de extensão você pode usar.
  • uip maestro bpmn process — descubra processos voltados para o Orchestrator que o registro catálogos.
  • uip login — faça login antes de pull para ver conectores e processos.

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