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.

オーサリング フロー

Maestro プロジェクトは、 project.uiproj、 .bpmn ファイル、およびサポート メタデータ ファイル (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>

オーサリングコマンド

コマンド	目的
uip maestro bpmn init	新しい Maestro プロジェクトのスキャフォールディング (BPMN スターター)
uip maestro bpmn debug	Studio Web にアップロードしてデバッグ セッションを実行する
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	デプロイ可能な .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

実行時

実行時に、パブリッシュされた Maestro パッケージは、Orchestrator 上でProcessOrchestrationタイプのプロセスになります。1 つ起動する とインスタンスが作成されます。各実行試行は ジョブです。失敗 はインシデントとして表面化します。

コマンド	目的
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	インシデントの概要と詳細を読む
uip maestro bpmn job	トレース (traces) をストリームし、ジョブのステータスを検査する

Orchestrator レベルのジョブやプロセスは、Orchestrator ツールを使用して操作します。詳しくは、「 Orchestrator のジョブ 」および「 Orchestrator のプロセス」をご覧ください。

レジストリ (BPMN)

Maestro には、.bpmn内で使用可能な拡張機能の種類、コネクタ、プロセスを参照するための BPMN レジストリ ( uip maestro bpmn registry ) も付属しています。まだサイドバーにはありませんが、今日呼び出すことができます。

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

データシェイプ:RegistryPullSuccess(カウント:ExtensionTypeCount、ConnectorCount、ProcessCount)、RegistryListSuccess/RegistrySearchSuccess(Data.ExtensionTypes[]、Data.Connectors[]、Data.Processes[])、RegistryGetSuccess(Data.ExtensionType、--connection-idと--object-nameの両方が提供される場合はオプションのData.ISEnrichment)。

命名規則

• すべての uip maestro bpmn サブコマンドは、 グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を尊重します。
• 既定の出力は JSON です。
• 終了コードは 標準コントラクトに従います。
• ほとんどのランタイム コマンドでは、最初に uip login が必要です — 「認証」をご覧ください。

参照

• uip maestro flow — グラフ型のワークフローの兄弟
• uip maestro case — Case Management sibling
• ツール (プラグイン)
• 認証
• グローバル オプション、 終了コード