uip maestro bpmn

Commands for authoring, packing, debugging, and operating UiPath Maestro BPMN process-orchestration projects using the `uip maestro bpmn` tool.

uip maestro bpmn authors, packs, debugs, and operates UiPath Maestro projects — BPMN 2.0 business-process orchestrations with long-running, human-in-the-loop semantics. Maestro is one of three sibling orchestration surfaces: BPMN (this page), Flow (uip maestro flow), and Case Management (uip maestro case). Pick BPMN for standard BPMN semantics (user tasks, boundary events, timers, sub-processes), Flow for a node-and-edge graph of agentic or connector-heavy steps, and Case Management for a long-running, human-driven unit of work modeled as stages/tasks/SLAs rather than a linear process.

The tool is shipped as the @uipath/maestro-tool plugin. Every command on this page is registered under the bpmn branch — the real invocation is always uip maestro bpmn <verb>, never a bare uip maestro <verb>. See Tools (plugins) for the plugin model.

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	Validate a project's BPMN and metadata without packing
uip maestro bpmn format	Auto-format and tidy a .bpmn file
uip maestro bpmn refresh	Regenerate generated project files from the current .bpmn
uip maestro bpmn update-metadata	(Deprecated — use refresh) Update generated metadata files
uip maestro bpmn pack	Produzir um implantável .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

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	List and run deployed Maestro processes (list, get, run, publish)
uip maestro bpmn processes	Process summaries across folders, per-process incidents, and diagnostics (list, incidents, diagnose, error-codes)
uip maestro bpmn instance	Inspect and steer running instances (list, get, pause, resume, cancel, retry, migrate, goto, variables, message send, element cancel/retry, …)
uip maestro bpmn debug-instance	Debug a specific running instance interactively
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 — Case Management sibling
• Ferramentas ( plugins )
• Autenticação
• Opções globais, Códigos de saída