UIP フロー レジストリ

uip flow registry は、 フローノードレジストリ ( .flow ファイル内で使用できるビルディングブロックのカタログ)を参照します。レジストリには、OOTB アクティビティ (uipath.agent、 uipath.http、...) と、サードパーティの API (Slack、Salesforce、Jira など) を呼び出すコネクタ ノードが含まれています。ログインすると、レジストリにはテナントにインストールされているコネクタ ノードも追加で含まれます。

レジストリは UiPath ワークフロー サーフェス間で共有されます。同じ実装で uip maestro がサポートされます (uip maestro bpmn registryを介して公開されている Maestro レジストリを参照)。

すべてのサブコマンドは 、グローバルオプションを優先します。終了コードは 標準コントラクトに従います。

概要

uip flow registry pull   [-f, --force]
uip flow registry list   [-l, --limit <n>] [--local]
uip flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip flow registry get    <nodeType> [--connection-id <id>] [--local]

一般的なワークフロー

# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip flow registry pull

# 2. Search for a candidate node
uip flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"

ログインしない場合は、組み込み (OOTB) ノードのみが返されます。

---

uip フロー レジストリ プル

ノード レジストリをフェッチし、ローカル キャッシュに書き込みます。後続の list、 search、および get 呼び出しは、このキャッシュから読み取られます。

オプション

• -f, --force — キャッシュを無視して強制的に更新します。

Cache behavior

• キャッシュは 30 分後に期限切れになります。キャッシュが期限切れまたは欠落している場合は、ライブ フェッチがトリガーされます。
• ログインしていない場合、OOTB ノードはキャッシュを更新せずに返されます。
• 認証フェッチが失敗すると、このコマンドはキャッシュを更新せずに OOTB ノードにフォールバックします。

Data shape (--output json)

{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}

Source は "ootb" (未認証) または "authenticated" (テナント固有) です。AgeMinutes は FromCache: true時に設定されます。

---

UIP フロー レジストリ リスト

キャッシュされたノードのサンプル。既定では、最初の 20 個のエントリが含まれます。

オプション

オプション	既定 (Default)	説明
-l, --limit <n>	20	返すノードの数。すべての人に -1 を渡します。正の整数または -1である必要があります。
--local	無効	ソリューション内のプロジェクト ノードのみを表示します。CWD、親、または祖父母の .uipx が必要です。

事前pullなしで list が呼び出された場合、サービスは最初にライブ データを取得します。

データシェイプ

{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}

結果が切り捨てられると、totalとshownを示すログ行がstderrに出力されます。

---

UIP フロー レジストリの検索

キーワード、構造化フィルター、またはその両方でノードを検索します。

引数

• [keyword] — nodeType、 category、 tags、 display.label、 descriptionに対して一致した部分文字列 。

オプション

オプション	説明
-f, --filter <expr>	構造化フィールド フィルター (以下の構文を参照)。
--local	ソリューション内のノードのみを検索します (近くに .uipx が必要です)。

<keyword>または--filterのうち少なくとも 1 つが必要です。

フィルターの構文

field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)

演算子: equals (既定)、 contains、 startsWith、 endsWith、 in。

フィルター可能なフィールド (角括弧で囲まれたエイリアス):

• category [cat] — 例connector、 agent、 trigger
• type [nodetype] — ノードタイプ識別子
• tags [tag] — ノードタグ
• displayname [display_name, name, label] — 人間が読める名前

例

uip flow registry search slack
uip flow registry search --filter "category=connector"
uip flow registry search --filter "displayname:contains=send message"
uip flow registry search slack --filter "category=connector"
uip flow registry search --filter "tags:in=ai,automation"
uip flow registry search --filter "category=connector,displayname:contains=slack"

データ形状: list と同じ形状 — Code: "NodeSearchSuccess"、 Data: [flattened nodes…]。

---

uip フロー レジストリ get

1 つのノードの完全な詳細を返します。

引数

• <nodeType> (必須) — ノードタイプ識別子 (大文字と小文字を区別しません)。

オプション

オプション	説明
--connection-id <id>	Integration Service エンリッチメントのコネクション ID です。コネクタ トリガー ノードに必要です。任意: コネクタ アクティビティ ノードの場合。
--local	ソリューション内プロジェクトからのみノードを取得します。

Integration Service のエンリッチメント

"connector"というタグが付いたノードの場合、get は自動的に Integration Service を呼び出してライブ メタデータを結合します。

コネクタのアクティビティ ノード (トリガーではなくuipath.connector.*):

• inputDefinition.fields[] — 設定するフィールドです。それぞれに name、 displayName、 type、 requiredがあり、オプションで reference (ルックアップ: objectName、 path、 lookupValue、 lookupNames、 childPath) または enumがあります。
• outputResponseDefinition — ノードの実行後に生成されるフィールド。
• connectorMethodInfo — HTTPメソッド、パス、operationId。
• --connection-id は任意です。1 つを渡すと、そのアカウントに固有のカスタム フィールドが追加されます。

コネクタ トリガー ノード (uipath.connector.trigger.*):

• eventParameters — トリガーを設定するフィールド (例: 監視するフォルダー)。
• filterFields — トリガーを起動するイベントをフィルター処理するために使用されるフィールドです。
• outputResponseDefinition — イベント ペイロードによって生成されるフィールド。
• eventMode — "webhooks" または "polling"です。
• ログインと--connection-idが必要ですが、両方がなければエンリッチメントは返されません。

入力フィールドごとのメタデータ

inputDefinition.fieldsの下の各エントリ:

プロパティ	説明
name	要求/応答の JSON キーです。
displayName	人間が判読できるラベル。
type	データ型 (string、 boolean、 integer、...)。
required	true 必須の場合 (入力フィールドのみ)。
description	フィールドの機能
enum	許可される値 (制限されている場合)。
reference	オブジェクト参照メタデータ — フィールドには、プレーンな名前ではなく ID が必要です。
responseOnly	true [出力フィールド]

データシェイプ

{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}

例

# Basic activity lookup (anonymous, OOTB)
uip flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json

参照

• uip flow node add と uip flow node configure — ここで検出されたノード タイプを使用します
• フローの概要