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.

Erstellungsflow

Ein Maestro-Projekt ist ein Verzeichnis mit einer project.uiproj, einer .bpmn -Datei und unterstützenden Metadatendateien (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>

Erstellen von Befehlen

Befehl	Zweck
uip maestro bpmn init	Gerüst für ein neues Maestro-Projekt (BPMN-Starter)
uip maestro bpmn debug	Laden Sie in Studio Web hoch und führen Sie eine Debug-Sitzung aus
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	Sie können ein bereitstellbares erstellen .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

Laufzeit

Zur Runtime wird ein veröffentlichtes Maestro-Paket zu einem Prozess des Typs ProcessOrchestration in Orchestrator. Beim Starten von eins wird eine Instanz erstellt; Jeder Ausführungsversuch ist ein Auftrag; Fehler als Vorfälle auftreten.

Befehl	Zweck
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	Lesen Sie Zusammenfassungen und Details der Vorfälle
uip maestro bpmn job	Streamen Sie die Ablaufverfolgung (traces) und überprüfen Sie den Auftragsstatus

Aufträge und Prozesse auf Orchestrator-Ebene werden über das Orchestrator-Tool bearbeitet – siehe Orchestrator-Aufträge und Orchestrator-Prozesse.

Registrierung (BPMN)

Maestro liefert auch eine BPMN-Registrierung – uip maestro bpmn registry – zum Durchsuchen der Erweiterungstypen, Connectors und Prozesse, die in einem .bpmn verwendet werden können. Sie befindet sich noch nicht in der Seitenleiste, ist aber noch heute aufrufbar:

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>]

Datenstrukturen: RegistryPullSuccess (Anzahl: ExtensionTypeCount, ConnectorCount, ProcessCount), RegistryListSuccess / RegistrySearchSuccess (Data.ExtensionTypes[], Data.Connectors[], Data.Processes[]), RegistryGetSuccess (Data.ExtensionType, optional Data.ISEnrichment wenn sowohl --connection-id als auch --object-name bereitgestellt sind).

Konventionen

• Jeder uip maestro bpmn -Unterbefehl berücksichtigt die globalen Optionen (--output, --output-filter, --log-level, --log-file).
• Die Standardausgabe ist JSON.
• Austrittscodes folgen dem Standardvertrag.
• Die meisten Runtime-Befehle erfordern zuerst uip login – siehe Authentifizierung.

Siehe auch

• uip maestro flow – diagrammähnliches Workflow
• uip maestro case — Case Management sibling
• Tools (Plugins)
• Authentication
• Globale Optionen, Beendigungscodes