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.

Flujo de creación

Un proyecto de Maestro es un directorio con un project.uiproj, un archivo .bpmn y archivos de metadatos compatibles (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>

Comandos de creación

Comando	Propósito
uip maestro bpmn init	Andamiar un nuevo proyecto de Maestro (iniciador BPMN)
uip maestro bpmn debug	Cargar en Studio Web y ejecutar una sesión de depuración
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	Producir un implementable .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

Tiempo de ejecución

En runtime, un paquete de Maestro publicado se convierte en un proceso de tipo ProcessOrchestration en Orchestrator. Al iniciar uno se crea una instancia; cada intento de ejecución es un trabajo; los fallos emergen como incidentes.

Comando	Propósito
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	Leer resúmenes y detalles de incidentes
uip maestro bpmn job	Seguimientos de transmisión (traces) e inspección del estado del trabajo

Los trabajos y procesos en el nivel de Orchestrator se manipulan a través de la herramienta de Orchestrator — consulta Trabajos de Orchestrator y Procesos de Orchestrator.

Registro (BPMN)

Maestro también incluye un registro BPMN — uip maestro bpmn registry — para explorar los tipos de extensión, conectores y procesos utilizables dentro de un .bpmn. Todavía no está en la barra lateral, pero ya se puede llamar:

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 datos: RegistryPullSuccess (recuentos: ExtensionTypeCount, ConnectorCount, ProcessCount), RegistryListSuccess / RegistrySearchSuccess (Data.ExtensionTypes[], Data.Connectors[], Data.Processes[]), RegistryGetSuccess (Data.ExtensionType, opcional Data.ISEnrichment cuando se proporcionan tanto --connection-id como --object-name ).

Convenciones

• Cada subcomando uip maestro bpmn respeta las opciones globales (--output, --output-filter, --log-level, --log-file).
• La salida predeterminada es JSON.
• Los códigos de salida siguen el contrato estándar.
• La mayoría de los comandos de runtime requieren uip login primero: consulta Autenticación.

Ver también

• uip maestro flow : flujo de trabajo relacionado en forma de gráfico
• uip maestro case — Case Management sibling
• Herramientas (complementos)
• Autenticación
• Opciones globales, Códigos de salida