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 breaks ProcessCount down by discovered process type.

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

Get the full spec for a single extension type. For connector types (Intsvc.ActivityExecution, Intsvc.WaitForEvent, Intsvc.EventTrigger, …), pass both --connection-id and --object-name to enrich the response with live Integration Service field metadata; add --operation to select which operation's fields to return.

Argumentos

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

Opções

ShortLongValorPadrãoDescription
--connection-idIDID de conexão para o enriquecimento do Integration Service. Requer --object-name.
--object-namenameNome do objeto para o enriquecimento do Integration Service. Requer --connection-id.
--operation <name>nameOperation whose request/response fields to return (e.g. Create, INCIDENT_CREATED). For activity types it defaults to the object's sole operation (and the response lists the available operations when there's more than one). For event types it's required — one object can expose several event operations, so it's never inferred.

Validação

  • --connection-id and --object-name must be supplied together — passing only one fails with IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.
  • --connection-id/--object-name only apply to Intsvc.* types — using them against a non-Intsvc extension type fails, naming Intsvc.ActivityExecution/Intsvc.EventTrigger as valid examples.
  • For an event-tagged extension type (extensionTag: "uipath:event"), omitting --operation fails with Event enrichment requires --operation, pointing at uip is activities list <connector> --triggers to discover the valid operation names.

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

When --connection-id and --object-name (and, for event types, --operation) are supplied and the Integration Service call succeeds, the response also includes an ISEnrichment field containing the live metadata payload. If the enrichment call fails — including when Integration Service returns no field metadata for the given object/operation — a warning is logged and ISEnrichment is omitted; the base spec is still returned.

  • 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