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.

Création du flux

Un projet Maestro est un répertoire avec un project.uiproj, un fichier .bpmn et des fichiers de métadonnées prenant en charge (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>

Création de commandes

Commande	Objectif
uip maestro bpmn init	Élaborer un nouveau projet Maestro (démarrage BPMN)
uip maestro bpmn debug	Charger vers Studio Web et exécuter une session de Debug
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	Créer un déployable .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

Runtime

Lors du runtime, un package Maestro publié devient un processus de type ProcessOrchestration sur Orchestrator. L'étape de démarrage crée une instance; chaque tentative d'exécution est une tâche; les échecs font l'objet d' un incident.

Commande	Objectif
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	Lire les résumés et les détails des incidents
uip maestro bpmn job	Flux des traçages (traces) et inspecter le statut de la tâche

Les tâches et les processus au niveau d'Orchestrator sont manipulés via l'outil Orchestrator — voir Tâches Orchestrator et Processus Orchestrator.

Registre (BPMN)

Maestro fournit également un registre BPMN — uip maestro bpmn registry — pour parcourir les types d'extension, les connecteurs et les processus utilisables dans un .bpmn. Elle n’est pas encore située dans la barre latérale mais est disponible dès aujourd’hui:

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

Formats de données: RegistryPullSuccess (nombre: ExtensionTypeCount, ConnectorCount, ProcessCount), RegistryListSuccess / RegistrySearchSuccess (Data.ExtensionTypes[], Data.Connectors[], Data.Processes[]), RegistryGetSuccess (Data.ExtensionType, facultatif Data.ISEnrichment lorsque les deux --connection-id et --object-name sont fournis).

Conventions

• Chaque sous-commande uip maestro bpmn respecte les options globales (--output, --output-filter, --log-level, --log-file).
• La sortie par défaut est JSON.
• Les codes de sortie suivent le contrat standard.
• La plupart des commandes de runtime nécessitent d'abord uip login - voir Authentification.

Voir également

• uip maestro flow — Lorsqu'un workflow est en forme de graphique
• uip maestro case — Case Management sibling
• Outils (extensions)
• Authentification
• Options globales, codes de sortie