uip maestro bpmn debug-instance

「uip maestro bpmn debug-instance」の構文とオプション。アップロード済みの Studio Web ソリューションに対して、ブレークポイント対応の対話型デバッグ セッションを駆動します。

uip maestro bpmn debug-instance は、低レベルの対話型デバッグ セッションを駆動します。つまり、インスタンスを作成し、インスタンスのステータス、変数、インシデントの検査、ブレークポイントの設定、ステップアップを行います。bpmn ブランチに登録されています。

これは uip maestro bpmn debugとは異なる低レベルのサーフェスです。debug は 1 回限りの「アップロードして完了まで実行する」コマンドです。debug-instance 、ソリューションがすでに Studio Web にアップロードされていることを前提としており、1 回のデバッグ実行 (ブレークポイントでの一時停止、実行途中での変数の検査、ステップへのステップ実行) を手動で制御できます。これは、デバッグ セッションでステップレベルの制御が必要な場合に、 debug独自のエラー指示によって参照される対話型のデバッグ実行です。

概要

uip maestro bpmn debug-instance create --solution-id <id> --project-id <id> --entry-point <path>
                                        [--process-type <type>] [--debug-mode <mode>] [--simulation-mode <mode>] [-i, --inputs <json>]
uip maestro bpmn debug-instance status         <instance-id>
uip maestro bpmn debug-instance breakpoints    <instance-id> --inputs <json|@file>
uip maestro bpmn debug-instance cancel         <instance-id>
uip maestro bpmn debug-instance continue       <instance-id> [--inputs <json|@file>]
uip maestro bpmn debug-instance incidents      <instance-id>
uip maestro bpmn debug-instance variables      <instance-id> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-set  <instance-id> --inputs <json|@file> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-all  <instance-id>

すべてのサブコマンドには uip loginが必要で、 グローバル オプションが優先され、 標準の終了コード コントラクトに従います。

UIP Maestro BPMN デバッグインスタンス作成

Studio Web にアップロード済みのソリューションからデバッグ インスタンスを作成し、Orchestrator の個人用ワークスペース フォルダーでデバッグ セッションを開始します。

オプション

オプション	Required	説明
--solution-id <id>	○	以前にアップロードしたソリューション ID または Studio Web から取得したソリューション ID
--project-id <id>	○	ソリューション内の Studio Web プロジェクト ID。
--entry-point <path>	○	エントリ ポイントのパス (例:/Main.bpmn#startです。
--process-type <type>	×	プロセスの種類。既定 processOrchestrationです。
--debug-mode <mode>	×	Noneのいずれか、Default (ブレークポイントで一時停止)、StepByStep (すべてのステップで一時停止)、SingleStep (1 ステップのみ)。既定 Defaultです。無効な値は、受け入れられたセットのリストが表示されてすぐに失敗します。
--simulation-mode <mode>	×	None、All (すべての要素をシミュレート)、Selective (オプトアウトを除くシミュレート) のいずれかです。既定 Noneです。無効な値は、受け入れられたセットのリストが表示されてすぐに失敗します。
-i, --inputs <json>	×	JSON 文字列としての入力引数。既定 {}です。

データシェイプ

{
  "Code": "DebugInstanceCreated",
  "Data": {
    "instanceId": "c3d4e5f6-...",
    "runId": "d4e5f6a7-...",
    "jobKey": "b2c3d4e5-..."
  },
  "Instructions": "Use 'debug-instance status <instance-id>' to check the run. Use 'debug-instance incidents <instance-id>' or 'debug-instance variables <instance-id>' to inspect it."
}

UIP Maestro BPMN デバッグ - インスタンスのステータス

デバッグ インスタンスの現在の要素ごとの実行ステータスを取得します。

引数: <instance-id> (必須)データ図形: Code: "DebugInstanceStatus"。

UIP Maestro: BPMN デバッグ - インスタンスのブレークポイント

デバッグ インスタンスに設定されたブレークポイントを置き換えます。

引数: <instance-id> (必須)

オプション: --inputs <value> — ブレークポイント ペイロードを JSON 文字列、 @file パス、または stdin を介してパイプします。省略すると、空のブレークポイント リスト ({"breakpoints": []}) が送信され、すべてのブレークポイントがクリアされます。

データシェイプ: Code: "DebugInstanceBreakpointsUpdated".

UIP Maestro BPMN デバッグ - インスタンスのキャンセル

デバッグ インスタンスをキャンセルします。

引数: <instance-id> (必須)データ図形: Code: "DebugInstanceCanceled"。

UIP Maestro: BPMN デバッグ - インスタンス続行

一時停止したデバッグ インスタンスで実行を再開します。

引数: <instance-id> (必須)

オプション: --inputs <value> — JSON 文字列、 @file パス、または stdin を介してパイプされたペイロードを続行します。省略すると、 {"nextStep": false} が送信されます (単一のステップではなく、次のブレークポイントまで実行)。

データシェイプ: Code: "DebugInstanceContinued".

UIP Maestro: BPMN デバッグ インスタンスのインシデント

デバッグ インスタンスの実行中に発生したインシデントを取得します。

引数: <instance-id> (必須)データ図形: Code: "DebugInstanceIncidents" Data は配列です (配列がない場合は空)。

UIP Maestro: BPMN デバッグインスタンス変数

デバッグ インスタンスの現在の変数値を取得します。

引数: <instance-id> (必須)

オプション: --parent-element-id <id> — 親要素 ID で変数をフィルター処理します。

データシェイプ: Code: "DebugInstanceVariables".

uip maestro bpmn debug-instance variables-set

実行途中でデバッグ インスタンスの変数にパッチを適用 (更新) する。

引数: <instance-id> (必須)

オプション:

オプション	Required	説明
--inputs <value>	○	Patch-variables ペイロードは、JSON 文字列、 @file パスとして、または stdin を介してパイプされます。ペイロードが解決されない場合は失敗します。
--parent-element-id <id>	×	パッチのスコープを親要素 ID に設定します。

データシェイプ: Code: "DebugInstanceVariablesSet".

uip maestro bpmn debug-instance variables-all

デバッグ インスタンスのすべての変数 (サブプロセス変数を含む) を取得します。

引数: <instance-id> (必須)データ図形: Code: "DebugInstanceVariablesAll"。

例

# Create a debug session, stepping through one element at a time
uip maestro bpmn debug-instance create \
  --solution-id <solution-id> --project-id <project-id> \
  --entry-point "/Main.bpmn#start" --debug-mode StepByStep

# Check status, then step forward
uip maestro bpmn debug-instance status <instance-id>
uip maestro bpmn debug-instance continue <instance-id>

# Inspect and patch a variable mid-run
uip maestro bpmn debug-instance variables <instance-id>
uip maestro bpmn debug-instance variables-set <instance-id> --inputs '{"amount": 250}'

# Clean up
uip maestro bpmn debug-instance cancel <instance-id>

参照

• uip maestro bpmn debug — 1 回のみのアップロードと実行のデバッグ セッションです
• uip maestro bpmn instance — デバッグ セッションではなく、パブリッシュ済みのプロセス インスタンスに対する同等の操作です
• Maestro の概要