UIP Maestro フロー プロセスと UIP Maestro フロー プロセス

「uip maestro flow process」および「uip maestro flow processes」の構文とオプションです。フォルダーごとおよびテナント全体でパブリッシュ済みのフロー プロセスの操作をカバーします。

Flow パッケージが Orchestrator にパブリッシュされると、そのパッケージは プロセスになります。このページでは、関連する 2 つのコマンド グループについて説明します。

• uip maestro flow process — 単一のプロセス定義に対するフォルダーごとの操作 (フォルダー内のリスト表示、スキーマの取得、実行)。
• uip maestro flow processes (複数形) — テナント全体の概要とプロセスごとのインシデント検索。

概要

# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

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

---

UIP Maestro フロー プロセスのリスト

特定のフォルダー内の利用可能なフロープロセス (リリース) のリストを取得します。

オプション

オプション	Required	説明
-f, --folder-key <key>	○	フォルダー キー (GUID)。
--filter <odata>	×	サーバー側で追加の OData フィルターを適用します。
--login-validity <minutes>	×	トークン更新のしきい値 (既定 10)。

データシェイプ (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "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

フロー プロセスのエントリ ポイント スキーマ (入力/出力 JSON スキーマ) を取得します。この結果を使用して、process runの有効な--inputs ペイロードを作成します。

引数

• <process-key> (必須) — プロセス キー (例:MyFlow.flow.Flow:1.0.0 または <package-id>:<version>です。
• <feed-id> (必須) — フィード ID ( list 出力から)。

オプション

• -f, --folder-key <key> (必須)
• --login-validity

データシェイプ

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema と OutputSchema は再文字列化された JSON です。それらをJSONスキーマとして解析し、入力の構築を促進します。

---

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

パブリッシュ済みプロセスのフロージョブを開始します。

引数

• <process-key> (必須) — プロセス キー (例:MyFlow.flow.Flow:1.0.0)。
• <folder-key> (必須) — フォルダー キー (GUID)。

オプション

オプション	説明
-i, --inputs <json>	JSON 文字列または @path/to/file.jsonとして入力します。省略して stdin をパイプすると、stdin が入力として解析されます。
--release-key <key>	キー (GUID) — process listから 。
--feed-id <id>	パッケージ検索用のフィード ID (任意)。
--robot-ids <ids>	コンマ区切りのロボット ID (整数)。無効な値はすぐに失敗します。
--attachment <name=path>	ローカル ファイルを Orchestrator にアップロードし、ファイル型の入力変数としてバインドします。繰り返し可能 (例:--attachment file1=./resume.pdfです。同じ変数名が にも存在する場合は、上書き --inputsです。
--wait	ジョブがすぐに で戻るのではなく、ジョブが終了ステートに達するまでブロック Pending。
--timeout <seconds>	待機する最大秒数です。0 = タイムアウトなし。--waitが必要です。
--poll-interval <seconds>	待機中のステータス チェック間の間隔 (秒)。--waitが必要です。
--validate	実行する前に、プロセス スキーマに照らして入力を検証します。基本的なチェックのみを実行します — 必須フィールドが存在し、プリミティブ型が一致します。複雑な制約 (列挙型、パターン、参照) は、このパスでは適用されません。
--login-validity <minutes>	トークン更新のしきい値 (既定 10)。

入力の優先順位: --inputs <json> / --inputs @file.json > stdin >空のオブジェクト {}。

例

# Run with inline JSON
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

データシェイプ

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

次の手順: ストリームの実行またはポーリングuip maestro flow job status <jobKey>uip maestro flow job traces <jobKey>します。

---

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

プロセスのランタイム設定を取得または更新する。

UIP Maestro フローのプロセス設定 Get

引数

• <process-key> (必須) — プロセス定義キー。

オプション

• -f, --folder-key <key> (必須)

データシェイプ

Code: "ProcessSettingsGet"は、プロセス設定オブジェクト Data です。

UIP Maestro フローのプロセス設定セット

引数

• <process-key> (必須)

オプション

オプション	説明
-f, --folder-key <key>	(必須) フォルダー キー (GUID)。
--inputs <value>	設定ペイロードは、JSON 文字列または @file パスとして、または stdin を介してパイプされます。

データシェイプ

Code: "ProcessSettingsSet" です。

uip maestro フロー プロセス variable-tags

プロセスの出力変数 (インスタンスのフィルター処理に使用できる変数) の検索可能性タグを取得または更新します。

uip maestro フロー プロセス variable-tags get

引数

• <process-key> (必須)

オプション

• -f, --folder-key <key> (必須)

データシェイプ

DataCode: "ProcessVariableTagsGet"、 はプロセスのvariableTags マップです (何も設定されていない場合は{})。

UIP Maestro フロー プロセス variable-tags set

相互に排他的な 2 つの入力スタイル: 完全な JSON ペイロードを使用して --inputs 渡す か 、フレンドリーな --variable/--all/--searchable/--tags/--add-tags/--remove-tags フラグを使用します。両方のフラグを失敗とエラーで組み合わせます。

引数

• <process-key> (必須)

オプション

オプション	説明
-f, --folder-key <key>	(必須) フォルダー キー (GUID)。
--variable <name>	タグ付けする変数 (出力) の名前です。Repeatable - 1 回の呼び出しで複数のタグを付けます。
--element-id <id>	変数を所有する要素 — 複数の要素に同じ名前が表示される場合にあいまいさを解消します。1 つの --variableでのみ有効です。
--all	タグ付けできるすべての変数に変更を適用します。
--searchable <bool>	インスタンスのフィルター処理で検索可能な変数をマークします (true/false)。
--tags <csv>	詳細: 変数の現在のタグを完全に置き換えます。値が空の場合、それらはクリアされます。
--add-tags <csv>	変数の現在のタグにタグを追加します。
--remove-tags <csv>	変数の現在のタグからタグを削除します。
--inputs <value>	完全な variable-tags ペイロードを JSON 文字列、 @file パスとして、または stdin 経由でパイプ処理します (上記のフラグの代替手段)。

データシェイプ

Code: "ProcessVariableTagsSet" です。

---

UIP Maestro フロー プロセスのリスト

フロー プロセスのテナント全体の概要 (/processes/summary?processType=Flow。引数はなく、グローバル以外のオプションもありません。

データシェイプ

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}

注:

各プロセス概要の正確なフィールド セットは Maestro ランタイムによって指定され、さらに進化する可能性があります。データがあるテナントに対して --output json でコマンドを 1 回実行して使用するフィールドを確認し、特定のフィールドを解析する場合は CI に @uipath/cli ピン留めします。

---

UIP Maestro フロー: インシデントを処理します。

特定のフロー プロセス定義のすべてのインシデントを取得します (単一のインスタンスではありません)。

引数

• <process-key> (必須) — プロセス定義キー。

オプション

• --folder-key <key> (必須) — 検索のスコープを設定するためのフォルダー キーです。

データシェイプ

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

インシデントごとの形状については、 uip maestro flow incident を参照してください。

UIP Maestro フロー プロセスの診断

プロセスの概要、インシデント、エラー コードを 1 回の呼び出しで関連付けます — 簡単なトリアージ コマンドです。

引数

• <process-key> (必須) — プロセス定義キー。

オプション

• --folder-key <key> (必須)

データシェイプ

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

UIP Maestro フロー プロセス エラー コード

プロセスのインシデント全体に表示される一意のエラー コードのセットを取得します。

引数

• <process-key> (必須)

オプション

• --folder-key <key> (必須)

データシェイプ

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

参照

• uip maestro flow instance — 実行中の実行を検査およびステアリングする
• uip maestro flow job — 単一のジョブのトレースとステータス
• uip maestro flow incident — インシデントの概要と詳細
• Orchestrator のジョブ、 Orchestrator のプロセス
• フローの概要