UiPath Documentation
uipath-cli
latest
false
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

UiPath CLI ユーザー ガイド

UIP Maestro プロセスと UIP Maestro プロセス

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

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

概要

# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]

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


UIP Maestro プロセス リスト

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

オプション

オプションRequired説明
-f, --folder-key <key>フォルダー キー (GUID)。
-t, --tenant <name>×テナント名。既定では、認証されたテナントが使用されます。
--filter <odata>×サーバー側で追加の OData フィルターを適用します。
--login-validity <minutes>×トークン更新のしきい値 (既定 10)。

Data shape (--output json)

{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "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"
    }
  ]
}
{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "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 process get

Maestro プロセスのエントリ ポイント スキーマ (入力/出力 JSON スキーマ) を取得します。

引数

  • <process-key> (必須) — プロセス キー。
  • <feed-id> (必須) — フィード ID ( listから)。

オプション

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

データシェイプ

{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchemaOutputSchema は、JSON スキーマの文字列を再文字列化したものです。


UIP Maestro プロセスの実行

パブリッシュ済みのプロセスに対して Maestro ジョブを開始します。

引数

  • <process-key> (必須) — プロセス キー。
  • <folder-key> (必須) — フォルダー キー (GUID)。

オプション

オプション説明
-i, --inputs <json>JSON 文字列または @path/to/file.jsonとして入力します。省略して stdin をパイプすると、stdin が解析されます。
-t, --tenant <name>テナント名 (既定値は「認証されたテナント」)。
--release-key <key>キー (GUID) — process listから 。
--feed-id <id>パッケージ検索用のフィード ID (任意)。
--robot-ids <ids>コンマ区切りのロボット ID (整数)。無効な値はすぐに失敗します。
--validate実行する前に、プロセス スキーマに照らして入力を検証します。基本チェックのみ — 必須フィールド + プリミティブ型。
--login-validity <minutes>トークン更新のしきい値 (既定 10)。

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

# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate

データシェイプ

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

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


UIP Maestro プロセス リスト

Maestro プロセスのテナント全体の概要 (このレイヤーでは processType フィルターは適用されていません。複数形のコマンドはツール間で共有され、 ProcessOrchestration サーバー側には適用されません)。

引数

設定はありません。

データシェイプ

{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
注:

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


UIP Maestro によるインシデントの処理

特定の Maestro プロセス定義のすべてのインシデントを取得します。

引数

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

オプション

  • --folder-key <key> (任意) — ルックアップのスコープを設定するフォルダキー。

データシェイプ

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

参照

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得