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>	Upload a local file to Orchestrator and bind it as a file-type input variable. Repeatable, e.g. --attachment file1=./resume.pdf. Overrides the same variable name if also present in --inputs.
--wait	Block until the job reaches a terminal state instead of returning immediately with Pending.
--timeout <seconds>	Maximum seconds to wait. 0 = no timeout. Requires --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 flow process settings

Get or update a process's runtime settings.

uip maestro flow process settings get

引数

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

オプション

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

データシェイプ

Code: "ProcessSettingsGet", Data is the process settings object.

uip maestro flow process settings set

引数

• <process-key> (必須)

オプション

オプション	説明
-f, --folder-key <key>	(required) Folder key (GUID).
--inputs <value>	Settings payload as a JSON string, an @file path, or piped via stdin.

データシェイプ

Code: "ProcessSettingsSet" です。

uip maestro flow process variable-tags

Get or update searchability tags on a process's output variables — which variables can be used to filter instances.

uip maestro flow process variable-tags get

引数

• <process-key> (必須)

オプション

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

データシェイプ

Code: "ProcessVariableTagsGet", Data is the process's variableTags map ({} if none are set).

uip maestro flow process variable-tags set

Two mutually exclusive input styles: pass --inputs with a full JSON payload, or use the friendly --variable/--all/--searchable/--tags/--add-tags/--remove-tags flags — combining both fails with an error.

引数

• <process-key> (必須)

オプション

オプション	説明
-f, --folder-key <key>	(required) Folder key (GUID).
--variable <name>	Name of a variable (output) to tag. Repeatable, to tag several in one call.
--element-id <id>	Element that owns the variable — disambiguates when the same name appears on multiple elements. Only valid with a single --variable.
--all	Apply the change to every taggable variable.
--searchable <bool>	Mark the variable(s) searchable for instance filtering (true/false).
--tags <csv>	Advanced: replace the variable's current tags outright. Empty value clears them.
--add-tags <csv>	Add tags to the variable's current tags.
--remove-tags <csv>	Remove tags from the variable's current tags.
--inputs <value>	Full variable-tags payload as a JSON string, an @file path, or piped via stdin — an alternative to the flags above.

データシェイプ

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> (required) — folder key to scope the lookup.

データシェイプ

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

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

uip maestro flow processes diagnose

Correlate a process's summary, incidents, and error codes in one call — a quick triage command.

引数

• <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 flow processes error-codes

Get the unique set of error codes seen across a process's incidents.

引数

• <process-key> (必須)

オプション

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

データシェイプ

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

参照

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