UIP Maestro: ケース: プロセスとジョブ

「uip maestro case process」、「processes」、「job」、「instance」、「incident」の構文とオプション — ケース管理プロセスとその実行を実行および検査します。

uip maestro caseの実行時コマンド: process ケース プロセスを実行し、その設定/変数タグを管理します。job 1 回の実行試行を検査し、instance結果のプロセス インスタンスを検査/操作し、processesプロセス間の概要ビューを提供し、incidentインシデントを読み取ります。case サブシステム全体で共有される概念については、「ケースの概要」をご覧ください。

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

instance、 incident、および processes は、同等の BPMN コマンドおよび フロー コマンド (@uipath/maestro-sdkの shared-commands モジュール) と実装を共有します。同じ不具合、同じ修正が適用されます。ここでは Case (toolLabel: "Case"、 processType: "CaseManagement"パラメーターを指定します)。実際の動作の違いの 1 つは、 ここではinstanceの--folder-key (folderKeyRequired: false) であり、同等の BPMN/Flow では必須です。

概要

uip maestro case process list --folder-key <key> [--filter <odata>] [--login-validity <minutes>]
uip maestro case process get <process-key> <feed-id> --folder-key <key> [--login-validity <minutes>]
uip maestro case process run <process-key> <folder-key> [--inputs <json|@file>] [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>] [--validate] [--login-validity <minutes>]
uip maestro case process settings get <process-key> --folder-key <key>
uip maestro case process settings set <process-key> --folder-key <key> --inputs <json|@file>
uip maestro case process variable-tags get <process-key> --folder-key <key>
uip maestro case process variable-tags set <process-key> --folder-key <key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <true|false>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

uip maestro case processes list [--folder-key <key>] [--limit <n>] [--offset <n>] [--status <status>]
uip maestro case processes incidents <process-key> --folder-key <key>
uip maestro case processes diagnose <process-key> --folder-key <key>
uip maestro case processes error-codes <process-key> --folder-key <key>

uip maestro case job traces <job-key> [--folder-key <key>] [--poll-interval <ms>] [--traces-service <name>] [--pretty] [--login-validity <minutes>]
uip maestro case job status <job-key> [--folder-key <key>] [--detailed] [--login-validity <minutes>]

uip maestro case instance list --folder-key <key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro case instance get <instance-id> [--folder-key <key>]
uip maestro case instance pause|resume|cancel|retry <instance-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance migrate <instance-id> <new-version> [--folder-key <key>] [--comment <text>]
uip maestro case instance incidents|asset|cursors|element-executions|variables|variables-all|global-variables <instance-id> [--folder-key <key>]
uip maestro case instance variables-set <instance-id> [--folder-key <key>] --inputs <json|@file>
uip maestro case instance goto <instance-id> <transitions> [--folder-key <key>]
uip maestro case instance element cancel|retry <instance-id> <element-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance message send [--folder-key <key>] [--inputs <json|@file>]

uip maestro case incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <k>] [--status <status>] [--severity <severity>]
uip maestro case incident get <incident-id> --folder-key <key>

UIP Maestro のケース プロセス

ケース プロセスの管理: フォルダーにパブリッシュされた内容を一覧表示し、エントリ ポイントの入力/出力スキーマを調べて、実行します。

注:

process run は <folder-key> をフラグではなく 位置引数として取ります — このページの他のすべての動詞 (list/get/settings/variable-tags) とは異なり、すべて --folder-key/-fを使用します。この非対称性は本物であり、タイプミスではありません — コピーして貼り付けた例が失敗しているように見える場合は、独自の CLI バージョンの --help に対して確認してください。

UIP Maestro ケース プロセス リスト

フォルダーにパブリッシュされたケース プロセスの一覧を表示します。

オプション

オプション	Required	説明
-f, --folder-key <key>	○	フォルダー キー (GUID)。
--filter <odata>	×	追加の OData フィルター。
--login-validity <minutes>	×	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。既定 10です。

データシェイプ

{
  "Code": "CaseProcessList",
  "Data": [
    {
      "name": "InvoiceReview",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId": "default",
      "folderId": 42,
      "active": "Yes",
      "latest": "Yes"
    }
  ]
}

UIP Maestro ケース プロセス Get

プロセスのエントリ ポイントのスキーマ ( process run が予期する入力/出力の形状) を取得します。

引数

名前	Required	目的
<process-key>	○	プロセス キー。
<feed-id>	○	process listの [feedId] フィールドのフィード ID。

オプション

オプション	Required	説明
-f, --folder-key <key>	○	フォルダー キー (GUID)。
--login-validity <minutes>	×	既定 10です。

データシェイプ

{
  "Code": "CaseProcessGet",
  "Data": [
    {
      "Path": "/content/caseplan.json.bpmn#Trigger_1",
      "DisplayName": "Start",
      "Type": "CaseManagement",
      "InputSchema": "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

Data は配列です。プロセスが公開するエントリ ポイントごとに 1 つのエントリであり、単一のオブジェクトではありません。プロセスのエントリ ポイントがゼロの場合は、明示的なエラーで失敗します。

UIP Maestro ケース プロセスの実行

ケース プロセス インスタンスを開始します。

引数

名前	Required	目的
<process-key>	○	プロセス キー。
<folder-key>	○	フォルダー キー (GUID) — ここでは位置であり、フラグではありません。

オプション

オプション	Required	説明
-i, --inputs <json>	×	パラメーターは JSON 文字列または @file.jsonとして入力できます。代わりにstdinからの読み取りを省略します。空の入力の場合は両方を省略します ({})。
--release-key <key>	×	リリース キー (GUID) process listから。
--feed-id <id>	×	パッケージ検索用のフィード ID。
--robot-ids <ids>	×	コンマ区切りの数値のロボット ID です。数値でないエントリがある場合はすぐに失敗します。
--validate	×	送信する前に、プロセスの入力スキーマに対して基本的なクライアント側の検証 (必須フィールド + プリミティブ型) を実行します。/ を❌出力し、✅ジョブを開始せずに失敗した場合に 1 を終了します。
--login-validity <minutes>	×	既定 10です。

例

uip maestro case process run a1b2c3d4-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001 \
  --inputs '{"amount":100}'

データシェイプ

{
  "Code": "CaseJobStarted",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

成功メッセージが表示されると、実行を監視する uip maestro case job traces <jobKey> が示されます。

UIP Maestro ケースのプロセスの設定

プロセスの未加工の設定オブジェクト (1 つのフィールドの読み取り/書き込み variable-tags 同じオブジェクト) を読み取るか置換します。

動詞	引数	オプション	備考
get	<process-key>	-f, --folder-key <key> 必須	Code: "ProcessSettingsGet".
set	<process-key>	-f, --folder-key <key> 必須、 --inputs <json|@file>	読み取り/変更/書き込み: 現在の設定を取得し、ペイロードを新しいオブジェクトとして PUT します。Code: "ProcessSettingsSet"です。

UIP Maestro ケース プロセス variable-tags

プロセスの出力変数にタグを付けます (たとえば、インスタンス リストのフィルター処理で 1 つを検索可能にする)。2 つの独立したモード — 両方ではなく、どちらかを選択します。

• フレンドリーモード: --variable <name> (繰り返し可能)+ターゲットへの --element-id/--all 、さらに --searchable <true|false> または下位レベルの --tags/--add-tags/--remove-tags で変異します。
• 未加工モード: フル variableTags ペイロードで--inputs <json|@file>。

動詞	引数	オプション	備考
get	<process-key>	-f, --folder-key <key> 必須	variableTags オブジェクトのみを返します。Code: "ProcessVariableTagsGet"です。
set	<process-key>	-f, --folder-key <key> 必須に加えて、上記のフレンドリー/未加工フラグ	--inputsとフレンドリ フラグを混在させるとエラーになります。--element-id は、 1 つの --variableでのみ機能します。--searchable--tags/--add-tags/--remove-tagsと組み合わせることはできません。Code: "ProcessVariableTagsSet"です。

例

# Mark the "amount" output searchable
uip maestro case process variable-tags set a1b2c3d4-… --folder-key <key> --variable amount --searchable true

UIP Maestro のケース プロセス

複数のプロセスにわたる概要ビュー — すべてのプロセスの集計数を一覧表示するか、キーで 1 つドリルダウンします。BPMN processes および同等のフローと実装を共有します。フィルター処理は processType: "CaseManagement"です。

動詞	引数	オプション	備考
list	—	--folder-key <key>、-l/--limit <n>、--offset <n>、--status <status>	Code: "ProcessList".
incidents	<process-key>	--folder-key <key> 必須	Code: "ProcessIncidents".
diagnose	<process-key>	--folder-key <key> 必須	概要 + インシデント + エラー コードを 1 回の呼び出しで関連付けます。FaultedCount/RunningCount/IncidentCount/ErrorCodeCount ロールアップでCode: "ProcessDiagnostics"します。
error-codes	<process-key>	--folder-key <key> 必須	Code: "ProcessIncidentErrorCodes".

UIP Maestro ケースのジョブ

ケース プロセスの 1 回の実行試行 (ジョブ) を検査します。

UIP Maestro ケースのジョブのトレース

実行中のジョブまたは最近完了したジョブのストリーム実行トレース イベント。

オプション

オプション	既定 (Default)	説明
--folder-key <key>	—	任意 — トレース要求のスコープを設定します。
--poll-interval <ms>	2000	ポーリング間隔。
--traces-service <name>	llmopstenant_	トレース サービス名。
--pretty	無効	生の JSON の代わりに人間が判読できるトレース線。
--login-validity <minutes>	10	トークン更新のしきい値。

トレースは出力に直接ストリーミングされ、最終的な Data ペイロードはありません。成功した場合 0 終了コード 1 成功した場合に終了コードが表示されます。

UIP Maestro ケースのジョブのステータス

ジョブのステータスを取得します。

オプション

オプション	Required	既定 (Default)	説明
--folder-key <key>	×	認証されたフォルダー	フォルダー キー (GUID、 process listから)。ここでは任意です。既定 のフォルダーをバックエンドで解決させる場合は省略します。
--detailed	×	無効	選定された要約ではなく完全な回答。
--login-validity <minutes>	×	10	トークン更新のしきい値。

データ形状 (既定のサマリー)

{
  "Code": "CaseJobStatus",
  "Data": {
    "key": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Successful",
    "runtimeType": "…",
    "processType": "CaseManagement",
    "startTime": "2025-04-15T10:30:00Z",
    "endTime": "2025-04-15T10:32:11Z",
    "creationTime": "…",
    "inputArguments": "…",
    "outputArguments": "…",
    "info": "…",
    "releaseName": "InvoiceReviewProcess",
    "processKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "robotName": "…",
    "hostMachineName": "…"
  }
}

UIP Maestro のケース インスタンス

個々の プロセス インスタンスを 検査して操作する — 1 つのケース プロセスの 1 回の実行。BPMN instance および Flow instanceと実装を共有します。動詞ごとの完全な参照については、いずれかのページをご覧ください (list、 get、 pause、 resume、 cancel、 retry、 migrate、 variables、 variables-set、 variables-all、 global-variables、 incidents、 asset、 cursors、 goto、 element-executions、 element cancel/retry、message send) — すべてのオプション名、既定値、およびデータ図形が同一です。

実際の違いの 1 つは、BPMN とフローで必要な場合の Case (共有コマンド構成のfolderKeyRequired: false ) のすべての instance サブコマンドで-f, --folder-keyオプションであることです。スコープを認証された既定のフォルダーにするには、省略します。

UIP Maestro ケースのインシデント

インシデントをプロセス間で、または ID 別に読み取ります。BPMN incident/Flow の同等の実装と同一の実装です。6 フラグの summary オプションの完全な表と、getの必要な--folder-keyについては、いずれかのページをご覧ください。

例

# Publish check, then run
uip maestro case process list --folder-key <key>
uip maestro case process get a1b2c3d4-… default --folder-key <key>
uip maestro case process run a1b2c3d4-… <key> --inputs '{"amount":100}'

# Watch it through to completion
JOB_KEY=$(uip maestro case process run a1b2c3d4-… <key> --inputs '{}' --output-filter "Data.jobKey" --output plain)
uip maestro case job traces "$JOB_KEY" --pretty
uip maestro case job status "$JOB_KEY" --detailed

# Diagnose a failing process in one call
uip maestro case processes diagnose a1b2c3d4-… --folder-key <key>

参照

• ケースの概要
• uip maestro bpmn instance / uip maestro flow instance — 共有インスタンスの完全なリファレンス
• uip maestro bpmn incident — 共有インシデントの完全なリファレンス
• Orchestrator のジョブ