UIP はコネクタ ビルダーです

Integration Service のコネクタ作成コマンドとライフサイクル コマンドの構文とオプション — ダウンロード、インポート、パブリッシュ、およびローカルの「コネクタ ビルダー」ツールチェーン。

Integration Service のコネクタは、ローカルで作成してテナントにプッシュできます。2 つのコマンド レイヤーがこれをカバーします。

• テナントのライフサイクル — uip is connectors download、import、publish、publish-statusconnectors (builderではない) に直接登録されています。これは、ローカルのファイル ツリーではなくテナントと通信し、デザイン/オーサリングされたコネクタで動作するためです。このページに記載されています。
• ローカル作成 — uip is connectors builder ...です。完全にローカルのコネクタ ディレクトリ ( builder authのオプションのライブ テストを除くテナント呼び出しなし) で動作し、コネクタのファイルをインポートする前に、コネクタのファイルをスキャフォールディング、編集、検証します。ドメインごとに 5 ページに分割 — このリソースは、以下の 6 ページにまたがっています 。

どちらのレイヤーも、uip is connectors でカバーされている読み取り専用カタログ (list、 get、 metadata、 swagger、 event-operations、 audit-logs、 export) には触れません。このページは、カタログに既に存在するコネクタを検出するためのページです。これは、新しいもの、または所有しているものの新しいバージョンを作成することです。

このリソースは 6 ページに及びます

• このページ には、概念とテナント ライフサイクル動詞 ( download、 import、 publish、 publish-statusが含まれています。
• Init &; connector — builder init (新しいコネクタのスキャフォールディング)、 builder connector inspect/validateを指定します。
• 認証 — コネクタの認証スキームである builder auth set/get/system create/listです。
• アクティビティ — builder activity CRUD とその field、 method、および param のサブグループです。コネクタのアクティビティの実際の動作を定義する最大のドメインです。
• アクティビティ フック — builder activity hook — JavaScript の要求前/要求後の変換です。必要なランタイム コンテキストの参照用に専用のページに分割されています。
• トリガーとステート — builder trigger create、 builder state query/patch — イベント ドリブンなトリガーと低レベルの要素ファイルの編集。

概念

• コネクタ ディレクトリ — app/element/element.json (およびアクティビティ、認証、トリガー用の兄弟ファイル) を含むローカル フォルダーです。ほとんどすべてのコマンドは、明示的に 1 つを指す --connector-dir <path> を受け入れます。省略すると、解決は現在のディレクトリからそのファイルを検索します。何も見つからない場合は、直接のサブディレクトリをスキャンして 1 つのコネクタを探します。それでも見つからない場合は、この場所での最後の builder init 実行で記録されたコネクタにフォールバックします (.uip-connector.json)。解決で複数の候補が見つかった場合、コマンドは Code: "connectorAmbiguous" で失敗し、候補を一覧表示します — あいまいさを解消するために明示的に --connector-dir 渡します。
• デザイン コネクタとパブリッシュ済みのコネクタ — アクティブなローカル開発中のコネクタは、 デザイン コネクタ (キーのプレフィックス design-...、作成者専用) です。publish 、すべてのユーザーに表示されるテナント全体の カスタム コネクタに昇格されます。download/import/publish/publish-status はすべて、このテナント側のデザイン/パブリッシュ済み状態で動作します。以下の builder 動詞は、純粋にローカル ファイルに対してのみ動作します。
• 検出 — すべての builder コマンド グループには、AI コーディング エージェントに自動で提供されるuipath-connector-builder スキル (uip skillsを参照) が付属しており、さらにほとんどのコマンドで--help ブロックが提供されており、明示的な "USE WHEN" / "NEVER USE FOR" ガイダンス — 名前だけからスコープを想定する前に、コマンド独自の--help出力を読み取ります。
• 一般的なフロー (CLI 独自の builder --help テキストによる): 任意で builder init → builder auth set → builder activity create → builder activity hook create →任意で builder trigger create → builder connector validate → uip is connectors import → uip is connectors publish。

概要

uip is connectors download <connector-key> [--connector-dir <path>] [--tenant <name>]
uip is connectors import [--connector-dir <path>] [--tenant <name>]
uip is connectors publish [--connector-dir <path>] [--version <semver>] [--connector-id <id>] [--wait [--timeout-seconds <n>]] [--tenant <name>]
uip is connectors publish-status <publish-id> [--tenant <name>]

--tenant は、4 つのライフサイクル動詞に表示される通常のオプションです。

uip is コネクタのダウンロード

デザイン コネクタの編集可能なソース ツリーをキーでダウンロードし、編集のためにローカルで解凍します。

注:

これを使用して、デザイン コネクタをプルダウンしてローカルで編集したり、以前にインポート/パブリッシュしたコネクタの作業コピーをブートストラップしたりします。代わりに、コネクタのレコードを読み取るには、 を使用します connectors get。名前で検索するには、 を使用しますconnectors list --filter。パブリッシュされた要素のパッケージ zip をエクスポートするには、connectors export を使用します。これはこれとは異なる操作です。

引数

名前	Required	目的
<connector-key>	○	正確な設計コネクタ キー (例: design-myorg-acmewidgets)。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	解凍されたソースのターゲット ディレクトリ。既定では現在のディレクトリです。
--tenant <name>	name	API 呼び出しのテナントを上書きします。

例

uip is connectors download design-myorg-acmewidgets --connector-dir ./pulled

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

{
  "Code": "ConnectorDownloaded",
  "Data": {
    "Id": 123,
    "Key": "design-myorg-acmewidgets",
    "ConnectorRoot": "/work/pulled/periodic-design-myorg-acmewidgets"
  }
}

UIP IS コネクタのインポート

ローカル コネクタを zip にパッケージ化し、テナント上でキーで作成または更新します。キーは初めて作成され、その後は実行ごとに更新されます。

注:

ローカル コネクタの変更をテナントにパブリッシュする場合や、テナント コネクタをローカル ディレクトリから初めて作成する場合に使用します。代わりに、テナント コネクタをダウンロードまたは検索するには、 connectors download / connectors listを使用します。

引数

設定はありません。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ、または app/element/element.jsonの親です。既定では現在のディレクトリです。
--tenant <name>	name	API 呼び出しのテナントを上書きします。

例

uip is connectors import --connector-dir ./my-acme-connector

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

{
  "Code": "ConnectorImported",
  "Data": {
    "Id": 123,
    "Key": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Operation": "Created"
  }
}

Operationは、特定のコネクタ キーを初めてインポートするとき"Updated"、以降はインポートされるたびに"Created"されます。

UIP IS コネクタのパブリッシュ

デザイン コネクタをテナント全体のカスタム コネクタに昇格させます。既定で Fire-and-forget — publish-statusでポーリングするPublishIdを返します。代わりに、--waitを渡して内部ポーリングします。

注:

connectors importが成功した後にこのオプションを使用して、コネクタがテナント内のすべてのユーザーに表示されるようにするか、すでにパブリッシュ済みのコネクタの新しいバージョンを再パブリッシュします (最初にelement-metadata.json:latestVersionをバンプ)。これにより、ローカル ファイルの変更がテナントにプッシュされる ことはありません 。これは connectors importです。publish は、すでにインポートされているものに対してのみ動作します。

引数

設定はありません。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタのディレクトリへのパスです。上記の 「概念 」と同じ解決順序です。
--version <semver>	セムバー	element-metadata.json:latestVersionのバージョンを上書きします。必要になることはほとんどありません。
--connector-id <id>	integer	明示的な数値 ID を使用してキーで取得するルックアップをバイパスします。必要になることはほとんどありません。
--wait	フラグ	すぐに戻るのではなく、 SUCCESS/FAILURE/timeout までステータスをポーリングします。
--timeout-seconds <seconds>	integer	--wait を設定するとポーリングがタイムアウトします。既定の 600 (10 分) です。
--tenant <name>	name	ログイン済みの既定値ではなく、このテナントの認証を使用します。

--connector-idと--timeout-secondsはどちらも、ネットワーク呼び出しの前にクライアント側で正の整数として検証されます。

例

# Fire-and-forget — returns a PublishId to poll separately (~5-10 min until Studio Web shows it)
uip is connectors publish

# Block until publish completes (or the 10-minute default timeout)
uip is connectors publish --wait

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

{
  "Code": "ConnectorPublishStarted",
  "Data": {
    "ConnectorKey": "design-acmecorp-stripe",
    "ConnectorId": 42,
    "Version": "1.0.0",
    "PublishId": 99,
    "Status": "IN_PROGRESS",
    "Completed": false
  }
}

--waitの場合、同じCode: "ConnectorPublishStarted"が使用されますが、Dataには、最初のIN_PROGRESSスナップショットではなく、ポーリングされた最終的なステート (Status: "SUCCESS" または "FAILURE"、 Completed: true) が反映されます。

UIP はコネクタです publish-status

パブリッシュ ジョブのステータスを publish-idでポーリングする。サーバーのステータスをそのまま返します。

引数

名前	Required	目的
<publish-id>	○	connectors publishによって返されるパブリッシュ ジョブ ID です。

オプション

長押し	値 (Value)	説明
--tenant <name>	name	ログイン済みの既定値ではなく、このテナントの認証を使用します。

例

uip is connectors publish-status 99

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

{
  "Code": "ConnectorPublishStatus",
  "Data": { "PublishId": "99", "Status": "SUCCESS" }
}

Status は、サーバーから逐語的に渡された IN_PROGRESS、 SUCCESS、または FAILUREのいずれかです。パブリッシュに失敗すると、失敗の詳細を含む Message フィールドが追加されます。

関連

• Init &; connector — 動作 download/import/publish のローカル コネクタをスキャフォールディングします。
• 認証 — コネクタの認証スキームを設定します。
• アクティビティ — コネクタのアクティビティの動作を定義します。
• アクティビティ フック — JavaScript の要求前/要求後の変換。
• トリガーとステート — イベント トリガーと低レベルのファイルの編集を行います。
• uip is connectors — これらのコマンドがパブリッシュされるとフィードされる読み取り専用のカタログです。

参照

• Integration Service ツールの概要
• グローバル オプション
• 終了コード