UIP Maestro、BPMN

「uip maestro bpmn」ツールを使用して、UiPath Maestro BPMN プロセス オーケストレーション プロジェクトをオーサリング、パッケージ化、デバッグ、および操作するためのコマンドです。

uip maestro bpmn は、 UiPath Maestro プロジェクト (長期実行の人間参加型のセマンティクスを備えた BPMN 2.0 業務プロセス オーケストレーション) の作成、パッケージ化、デバッグ、運用を行います。Maestro は、BPMN (このページ)、フロー (uip maestro flow)、ケース管理 (uip maestro case) の 3 つの兄弟オーケストレーション サーフェスのうちの 1 つです。標準的な BPMN セマンティクス (ユーザー タスク、境界イベント、タイマー、サブプロセス) には BPMN、エージェンティック ステップやコネクタを大量に使用するステップのノードとエッジのグラフには Flow、線形プロセスではなくステージ/タスク/SLA としてモデル化された、人間が主導する長期実行の作業単位にはケース管理を選択します。

このツールは @uipath/maestro-tool プラグインとして同梱されています。このページのすべてのコマンドは bpmn ブランチに登録されます。実際の呼び出しは常に uip maestro bpmn <verb>であり、決して裸の uip maestro <verb>ではありません。プラグイン モデルについては、「 ツール (プラグイン) 」をご覧ください。

オーサリング フロー

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	パッケージ化せずにプロジェクトの BPMN とメタデータを検証する
uip maestro bpmn format	.bpmn ファイルを自動フォーマットして整理する
uip maestro bpmn refresh	生成されたプロジェクト ファイルを現在のプロジェクト ファイルから再生成する .bpmn
uip maestro bpmn update-metadata	(非推奨 — refreshを使用してください) 生成されたメタデータ ファイルを更新する
uip maestro bpmn pack	デプロイ可能な .nupkg
uip maestro bpmn process publish	パッケージ化して Orchestrator にパブリッシュする手順を 1 ステップで完了

実行時

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

コマンド	目的
uip maestro bpmn process	デプロイ済みの Maestro プロセスを一覧表示して実行します (list、 get、 run、 publish)
uip maestro bpmn processes	フォルダー、プロセスごとのインシデント、診断にわたるプロセスの概要 (list、 incidents、 diagnose、 error-codes)
uip maestro bpmn instance	実行中のインスタンスを検査および管理します (list、 get、 pause、 resume、 cancel、 retry、 migrate、 goto、 variables、 message send、 element cancel/retryなど)
uip maestro bpmn debug-instance	実行中の特定のインスタンスを対話形式でデバッグする
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 — ケース管理の兄弟
• ツール (プラグイン)
• 認証
• グローバル オプション、 終了コード