- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
uip maestro bpmn registry は Maestro の BPMN レジストリ (Maestro で作成できる、BPMN 拡張機能の種類、Integration Service のコネクタ、Orchestrator で検出されたプロセスのカタログ) を参照および検索します。エージェントは (人間であろうとなかろうと) このパラメーターを使用して、BPMN を生成する前に、存在する拡張機能の種類の検出、その形状の検索、Integration Service のライブ メタデータによるコネクタの種類の強化を行います。
ログインしない場合は、組み込み (OOTB) 拡張機能タイプのみを使用できます。ログインして、Integration Service と Orchestrator から検出されたコネクタとプロセスを確認します。
概要
uip maestro bpmn registry <verb> [options]
uip maestro bpmn registry <verb> [options]
一般的なワークフロー:
uip login(オプション — OOTB 型はオフラインで動作します)。uip maestro bpmn registry pull— レジストリをローカルキャッシュに同期します。uip maestro bpmn registry search <keyword>— エントリを見つけます。uip maestro bpmn registry get <extensionType>— 完全な仕様を検査します。
動詞
| 動詞 | 目的 |
|---|---|
pull | レジストリ (静的 BPMN + 検出されたリソース) をフェッチしてキャッシュします。 |
list | キャッシュされた拡張機能の種類と検出されたリソースを一覧表示します。 |
search | 拡張機能の種類、コネクタ、プロセスにわたってキーワードでエントリを検索します。 |
get | 単一の拡張タイプの完全な仕様を取得します。必要に応じて、IS メタデータで強化します。 |
すべての動詞は 、グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは 標準コントラクトに従います。
UIP Maestro BPMN レジストリ プル
レジストリを取得してキャッシュします。既定では、キャッシュされた結果が新しいときに返されます。 --force を渡して再同期します。
オプション
| Short | 長押し | 値 (Value) | 既定 (Default) | 説明 |
|---|---|---|---|---|
-f | --force | フラグ | 無効 | キャッシュを無視して再取得します。 |
例
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
データシェイプ(--output json)
{
"Code": "RegistryPullSuccess",
"Data": {
"ExtensionTypeCount": 48,
"ConnectorCount": 12,
"ProcessCount": 5,
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
{
"Code": "RegistryPullSuccess",
"Data": {
"ExtensionTypeCount": 48,
"ConnectorCount": 12,
"ProcessCount": 5,
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
キャッシュが使用されている場合、 FromCache は true、 AgeMinutes はキャッシュの経過時間を報告し、 Message は Using cached registry (age: <n>m)です。
UIP Maestro BPMN レジストリ リスト
キャッシュされた拡張機能の種類と検出されたリソースを一覧表示します。デフォルトの制限は 30です。全員に --limit -1 合格します。
オプション
| Short | 長押し | 値 (Value) | 既定 (Default) | 説明 |
|---|---|---|---|---|
-l | --limit | Number | 30 | 返す拡張機能の種類の数 -1 すべての人に。 |
例
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
データシェイプ(--output json)
{
"Code": "RegistryListSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Orchestrator.StartJob",
"Label": "Start Job",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:startJob",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "No"
}
],
"Connectors": [
{
"Key": "slack",
"Name": "Slack",
"Connections": 2,
"Activities": 14,
"Triggers": 3
}
],
"Processes": [
{
"Name": "InvoiceProcessing",
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Type": "Maestro",
"Folder": "Shared"
}
]
}
}
{
"Code": "RegistryListSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Orchestrator.StartJob",
"Label": "Start Job",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:startJob",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "No"
}
],
"Connectors": [
{
"Key": "slack",
"Name": "Slack",
"Connections": 2,
"Activities": 14,
"Triggers": 3
}
],
"Processes": [
{
"Name": "InvoiceProcessing",
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Type": "Maestro",
"Folder": "Shared"
}
]
}
}
結果が切り捨てられると、 Showing first <n> of <total> extension types ノートがログに書き込まれます。
uip maestro BPMN レジストリ検索
拡張機能の種類 ID、ラベル、コネクタ名、プロセス名にわたってキーワードでレジストリを検索します。このキーワードは大文字と小文字を区別せずに一致します。
引数
| 名前 | Required | 目的 |
|---|---|---|
<keyword> | ○ | 検索語句。 |
例
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
データシェイプ(--output json)
{
"Code": "RegistrySearchSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Intsvc.ActivityExecution",
"Label": "Execute Activity",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:activityExecution",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "Yes"
}
],
"Connectors": [
{ "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
],
"Processes": [
{ "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
]
}
}
{
"Code": "RegistrySearchSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Intsvc.ActivityExecution",
"Label": "Execute Activity",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:activityExecution",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "Yes"
}
],
"Connectors": [
{ "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
],
"Processes": [
{ "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
]
}
}
UIP Maestro BPMN レジストリ GET
単一の拡張タイプの完全な仕様を取得します。コネクタの種類 (Intsvc.ActivityExecution、 Intsvc.WaitForEvent、...) の場合は、 --connection-id と --object-name の両方を渡して、Integration Service のフィールドのライブ メタデータで応答を拡充します。
引数
| 名前 | Required | 目的 |
|---|---|---|
<extensionType> | ○ | 拡張子の型識別子 (例: Orchestrator.StartJob)。 |
オプション
| Short | 長押し | 値 (Value) | 既定 (Default) | 説明 |
|---|---|---|---|---|
| — | --connection-id | ID | — | Integration Service エンリッチメントのコネクション ID です。--object-nameが必要です。 |
| — | --object-name | name | — | Integration Service エンリッチメントのオブジェクト名です。--connection-idが必要です。 |
例
uip maestro bpmn registry get Orchestrator.StartJob
# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
--output-filter 'Data.ExtensionType'
uip maestro bpmn registry get Orchestrator.StartJob
# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
--output-filter 'Data.ExtensionType'
データシェイプ(--output json)
基本の応答:
{
"Code": "RegistryGetSuccess",
"Data": {
"ExtensionType": {
"extensionType": "Orchestrator.StartJob",
"label": "Start Job",
"bpmnElement": "bpmn:ServiceTask",
"extensionTag": "uipath:startJob"
}
}
}
{
"Code": "RegistryGetSuccess",
"Data": {
"ExtensionType": {
"extensionType": "Orchestrator.StartJob",
"label": "Start Job",
"bpmnElement": "bpmn:ServiceTask",
"extensionTag": "uipath:startJob"
}
}
}
--connection-id と --object-name の両方が指定され、Integration Service の呼び出しが成功した場合、応答にはライブ メタデータ ペイロードを含む ISEnrichment フィールドも含まれます。エンリッチメント呼び出しが失敗した場合、警告がログに記録され、 ISEnrichment が省略されます — 基本仕様は引き続き返されます。
関連コマンド
uip maestro pack— Maestro プロジェクトをパッケージ化する。レジストリは、使用できる拡張機能の種類を通知します。uip maestro process— レジストリにカタログされている、Orchestrator 向けのプロセスを検出します。uip login—pull前にログインして、コネクタとプロセスを確認してください。
参照
- グローバルオプション —
--output、--output-filter、--log-level、--log-file。 - 終了コード — 標準の終了コード限月。