UIP Maestro Bpmn

Comandos para criar, empacotar, depurar e operar projetos de orquestração de processos BPMN do UiPath Maestro usando a ferramenta "uip Maestro bpmn".

uip maestro bpmn autores, pacotes, depura e opera projetos do UiPath Maestro — orquestrações de processos de negócios BPMN 2.0 com semântica de intervenção humana de longa duração. O Maestro é uma das três superfícies de orquestração irmãs: BPMN (esta página), Fluxo (uip maestro flow) e Gerenciamento de casos (uip maestro case). Escolha BPMN para semântica BPMN padrão (tarefas de usuários, eventos de limite, temporizadores, subprocessos), Fluxo para um gráfico de nó e borda de etapas agênticos ou com muitos conectores, e Gerenciamento de caso para uma unidade de longa duração e orientada por humanos de trabalho modelado como estágios/tarefas/SLAs em vez de um processo linear.

A ferramenta é enviada como o plug-in @uipath/maestro-tool. Cada comando nesta página é registrado na ramificação bpmn — a invocação real é sempre uip maestro bpmn <verb>, nunca um simples uip maestro <verb>. Consulte Ferramentas ( plugins ) para obter o modelo de plug-in.

Fluxo de criação

Um projeto do Maestro é um diretório com um project.uiproj, um arquivo .bpmn e arquivos de metadados de suporte (operate.json, entry-points.json, bindings_v2.json, package-descriptor.json).

# 1. Scaffold
uip maestro bpmn init invoice-orchestration

# 2. Edit the .bpmn in Studio Web or your IDE
#    (BPMN is validated at init time via bpmn-moddle)

# 3. Smoke-test via Studio Web
uip maestro bpmn debug ./invoice-orchestration

# 4. Validate the .bpmn file before packing
uip maestro bpmn validate ./invoice-orchestration/invoice-orchestration.bpmn

# 5. Pack for deployment
uip maestro bpmn pack ./invoice-orchestration ./dist --version 1.0.0

# ...or pack + publish straight to Orchestrator in one step
uip maestro bpmn process publish ./invoice-orchestration --folder-key <key>

Criando comandos

Command	Finalidade
uip maestro bpmn init	Estruture um novo projeto do Maestro (iniciador BPMN)
uip maestro bpmn debug	Faça upload para o Studio Web e execute uma sessão de depuração
uip maestro bpmn validate	Validar o BPMN e os metadados de um projeto sem empacotar
uip maestro bpmn format	Formatar e organizar automaticamente um arquivo .bpmn
uip maestro bpmn refresh	Gerar novamente arquivos de projeto gerados a partir do arquivo atual .bpmn
uip maestro bpmn update-metadata	(Obsoleto — use refresh) Atualizar arquivos de metadados gerados
uip maestro bpmn pack	Produzir um implantável .nupkg
uip maestro bpmn process publish	Empacotar e publicar no Orchestrator de uma só vez

Runtime

No runtime, um pacote Maestro publicado se torna um processo do tipo ProcessOrchestration no Orchestrator. Iniciar um cria uma instância; cada tentativa de execução é um trabalho; as falhas aparecem como incidentes.

Command	Finalidade
uip maestro bpmn process	Listar e executar processos implantados do Maestro (list, get, run, publish)
uip maestro bpmn processes	Resumos de processos em pastas, incidentes por processo e diagnóstico (list, incidents, diagnose, error-codes)
uip maestro bpmn instance	Inspecionar e orientar instâncias em execução (list, get, pause, resume, cancel, retry, migrate, goto, variables, message send, element cancel/retry, …)
uip maestro bpmn debug-instance	Depurar uma instância em execução específica de forma interativa
uip maestro bpmn incident	Ler resumos e detalhes de incidentes
uip maestro bpmn job	Transmitir rastreamentos (traces) e inspecionar o status dos trabalhos

Os trabalhos e processos no nível do Orchestrator são manipulados por meio da ferramenta do Orchestrator — consulte Trabalhos do Orchestrator e Processos do Orchestrator.

Registro (BPMN)

O Maestro também envia um registro BPMN — uip maestro bpmn registry — para navegar nos tipos de extensão, conectores e processos utilizáveis dentro de um .bpmn. Ela ainda não está na barra lateral, mas pode ser chamada hoje:

uip maestro bpmn registry pull   [-f, --force]
uip maestro bpmn registry list   [-l, --limit <n>]
uip maestro bpmn registry search <keyword>
uip maestro bpmn registry get    <extensionType> [--connection-id <id>] [--object-name <name>] [--operation <name>]

Formas de dados: RegistryPullSuccess (contagens: ExtensionTypeCount, ConnectorCount, ProcessCount), RegistryListSuccess / RegistrySearchSuccess (Data.ExtensionTypes[], Data.Connectors[], Data.Processes[]), RegistryGetSuccess (Data.ExtensionType, opcional Data.ISEnrichment quando --connection-id e --object-name forem fornecidos).

Convenções

• Cada uip maestro bpmn subcomando honra as opções globais (--output, --output-filter, --log-level, --log-file).
• A saída padrão é JSON.
• Os códigos de saída seguem o contrato padrão.
• A maioria dos comandos de runtime requer uip login primeiro — consulte Autenticação.

Veja também

• uip maestro flow — fluxo de trabalho irmãos em forma de gráfico
• uip maestro case — irmãos do gerenciamento de casos
• Ferramentas ( plugins )
• Autenticação
• Opções globais, Códigos de saída