- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
Guia do usuário da UiPath CLI
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:
- (
uip login— os tipos OOTB funcionam offline). uip maestro bpmn registry pullsincronize o registro no cache local.uip maestro bpmn registry search <keyword>encontre uma entrada.uip maestro bpmn registry get <extensionType>inspecione a especificação completa.
Verbo
| Texto | Finalidade |
|---|---|
pull | Buscar e armazenar em cache o registro (BPMN estático + recursos descobertos). |
list | Listar tipos de extensão em cache e recursos descobertos. |
search | Encontre entradas por palavra-chave em tipos de extensão, conectores e processos. |
get | Obter 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
| Short | Long | Valor | Padrão | Description |
|---|---|---|---|---|
-f | --force | Bandeira | desativada | Ignore 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,
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
{
"Code": "RegistryPullSuccess",
"Data": {
"ExtensionTypeCount": 48,
"ConnectorCount": 12,
"ProcessCount": 5,
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
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
| Short | Long | Valor | Padrão | Description |
|---|---|---|---|---|
-l | --limit | Número | 30 | Nú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"
}
]
}
}
{
"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"
}
]
}
}
Se o resultado for truncado, uma nota Showing first <n> of <total> extension types será gravada nos logs.
pesquisa de registro do uip Maestro bpmn
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
| Name | Required | Finalidade |
|---|---|---|
<keyword> | sim | Termo 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" }
]
}
}
{
"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" }
]
}
}
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, …), passe --connection-id e --object-name para enriquecer a resposta com metadados de campo ao vivo do Integration Service.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<extensionType> | sim | Identificador do tipo de extensão (por exemplo, Orchestrator.StartJob). |
Opções
| Short | Long | Valor | Padrão | Description |
|---|---|---|---|---|
| — | --connection-id | ID | — | ID de conexão para o enriquecimento do Integration Service. Requer --object-name. |
| — | --object-name | name | — | Nome do objeto para o enriquecimento do Integration Service. Requer --connection-id. |
Exemplos
uip maestro bpmn registry get Orchestrator.StartJob
# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
--output-filter 'Data.ExtensionType'
uip maestro bpmn registry get Orchestrator.StartJob
# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# 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 são fornecidos e a chamada do Integration Service é bem-sucedida, a resposta também inclui um campo ISEnrichment contendo a carga de metadados ao vivo. Se a chamada de enriquecimento falhar, um aviso será registrado e ISEnrichment será omitido — a especificação base ainda será retornada.
Comandos relacionados
uip maestro pack— empacotar um projeto do Maestro; o registro informa quais tipos de extensão você pode usar.uip maestro process— descubra processos voltados para o Orchestrator que o registro catálogos.uip login— faça login antes depullpara ver conectores e processos.
Veja também
- Opções globais —
--output,--output-filter,--log-level,--log-file. - Códigos de saída — contrato de código de saída padrão.
- Resumo
- Verbo
- Extração do registro bpmn do uip Maestro
- Opções
- Exemplos
- Formato dos dados (--output json)
- lista de registros bpmn do uip Maestro
- Opções
- Exemplos
- Formato dos dados (--output json)
- pesquisa de registro do uip Maestro bpmn
- Argumentos
- Exemplos
- Formato dos dados (--output json)
- Registro bpmn do uip Maestro Get
- Argumentos
- Opções
- Exemplos
- Formato dos dados (--output json)
- Comandos relacionados
- Veja também