uip maestro bpmn registry

「uip maestro bpmn registry」を使用して、拡張機能の種類、Integration Service のコネクタ、Orchestrator プロセスの Maestro BPMN レジストリを参照します。

uip maestro bpmn registry は Maestro の BPMN レジストリ (Maestro で作成できる、BPMN 拡張機能の種類、Integration Service のコネクタ、Orchestrator で検出されたプロセスのカタログ) を参照および検索します。エージェントは (人間であろうとなかろうと) このパラメーターを使用して、BPMN を生成する前に、存在する拡張機能の種類の検出、その形状の検索、Integration Service のライブ メタデータによるコネクタの種類の強化を行います。

ログインしない場合は、組み込み (OOTB) 拡張機能タイプのみを使用できます。ログインして、Integration Service と Orchestrator から検出されたコネクタとプロセスを確認します。

概要

uip maestro bpmn registry <verb> [options]

一般的なワークフロー:

1. uip login (オプション — OOTB 型はオフラインで動作します)。
2. uip maestro bpmn registry pull — レジストリをローカルキャッシュに同期します。
3. uip maestro bpmn registry search <keyword> — エントリを見つけます。
4. uip maestro bpmn registry get <extensionType> — 完全な仕様を検査します。

動詞

動詞	目的
pull	レジストリ (静的 BPMN + 検出されたリソース) をフェッチしてキャッシュします。
list	キャッシュされた拡張機能の種類と検出されたリソースを一覧表示します。
search	拡張機能の種類、コネクタ、プロセスにわたってキーワードでエントリを検索します。
get	単一の拡張タイプの完全な仕様を取得します。必要に応じて、IS メタデータで強化します。

すべての動詞は 、グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは 標準コントラクトに従います。

uip maestro bpmn registry pull

レジストリを取得してキャッシュします。既定では、キャッシュされた結果が新しいときに返されます。 --force を渡して再同期します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--force	フラグ	無効	キャッシュを無視して再取得します。

例

uip maestro bpmn registry pull
uip maestro bpmn registry pull --force

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

{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "ProcessCountsByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    },
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}

ProcessCountsByType 、検出されたプロセスの種類別に ProcessCount 内訳を示します。

キャッシュが使用されている場合、 FromCache は true、 AgeMinutes はキャッシュの経過時間を報告し、 Message は Using cached registry (age: <n>m)です。

uip maestro bpmn registry list

キャッシュされた拡張機能の種類と検出されたリソースを一覧表示します。デフォルトの制限は 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

データシェイプ(--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"
      }
    ],
    "ProcessesByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

結果が切り捨てられると、 Showing first <n> of <total> extension types ノートがログに書き込まれます。

uip maestro bpmn registry search

拡張機能の種類 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

データシェイプ(--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" }
    ],
    "ProcessesByType": {
      "Process": 1,
      "ProcessOrchestration": 0,
      "Agent": 0,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

uip maestro bpmn registry get

1 つの拡張タイプの完全な仕様を取得します。コネクタの種類 (Intsvc.ActivityExecution、 Intsvc.WaitForEvent、 Intsvc.EventTrigger、...) の場合は、 --connection-id と --object-name の両方を渡して、Integration Service のライブ フィールド メタデータで応答を強化します。 --operation を追加して、返す操作のフィールドを選択します。

引数

名前	Required	目的
<extensionType>	○	拡張子の型識別子 (例: Orchestrator.StartJob)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--connection-id	ID	—	Integration Service エンリッチメントのコネクション ID です。--object-nameが必要です。
—	--object-name	name	—	Integration Service エンリッチメントのオブジェクト名です。--connection-idが必要です。
—	--operation <name>	name	—	返す要求/応答フィールドがある操作 (例:Create、 INCIDENT_CREATED)。アクティビティの種類では、既定でオブジェクトの唯一の操作が使用されます (複数ある場合は、使用可能な操作が応答で一覧表示されます)。イベントの種類の場合は必須です。1 つのオブジェクトで複数のイベント操作が公開される可能性があるため、推測されることはありません。

検証

• --connection-id と --object-name を一緒に指定する必要があります。1 つだけを渡すと失敗します IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.
• --connection-id/--object-name は Intsvc.* 型にのみ適用されます。非Intsvc 拡張子型に対して使用すると失敗し、有効な例として Intsvc.ActivityExecution/Intsvc.EventTrigger という名前を付けます。
• イベント タグ付きの拡張機能の種類 (extensionTag: "uipath:event"の場合、 を省略すると --operation が Event enrichment requires --operationされ、有効な操作名を検出するための uip is activities list <connector> --triggers を指し、 で失敗します。

例

uip maestro bpmn registry get Orchestrator.StartJob

# Connector activity type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts

# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts --operation Create

# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
    --connection-id abc123 --object-name contacts --operation INCIDENT_CREATED

# 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"
    }
  }
}

--connection-id と --object-name (イベントの種類の場合は --operation) が指定され、Integration Service の呼び出しが成功すると、応答にはライブ メタデータ ペイロードを含むISEnrichmentフィールドも含まれます。エンリッチメント呼び出しが失敗した場合 (Integration Service が特定のオブジェクト/操作のフィールド メタデータを返さない場合など)、警告がログに記録され、 ISEnrichment は省略されます。基本仕様は引き続き返されます。

関連コマンド

• uip maestro bpmn pack — Maestro プロジェクトをパッケージ化する。レジストリは、使用できる拡張機能の種類を通知します。
• uip maestro bpmn process — レジストリにカタログされている、Orchestrator 向けのプロセスを検出します。
• uip login — pull前にログインして、コネクタとプロセスを確認してください。

参照

• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• 終了コード — 標準の終了コード限月。