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

ローカルの Integration Service コネクタのベースを形成、編集、検査、検証するための構文とオプション — ビルダー、init、init、プリセット、適用、init、ヘッダーの削除、検査、検証です。

uip is connectors builder ローカル作成ツールチェーンの一部です。このページでは、コネクタのディスク上の シェルを所有する 2 つの動詞について説明します。

• builder init — 新しいコネクタを作成するか、現在のディレクトリから解決するコネクタのフィールドを編集します。また、 init preset apply (ベース/ページネーション構成バンドルのシード) と init header delete (グローバル要求ヘッダーの削除) も所有します。
• builder inspect / builder validate — 読み取り専用の構造の概要と、CI で評価可能な合格/不合格チェック セット。これらは builderの直下にあり、コマンド パスに connector ラッパーはありません。

スキャフォールディング アクティビティ、認証、トリガー、または低レベルのファイルの編集については、「兄弟」の ページをご覧ください。

概念

• 作成と編集ディスパッチ — init は、コネクタが --connector-dir (または現在のディレクトリ) から解決するかによってモードを決定します (他のビルダー コマンドのフォールバック解決とは異なり、サブディレクトリ ではなく 、現在のディレクトリ自体のみをスキャンします)。作成→解決されるコネクタはありません (既定値--name、新しいツリーのスキャフォールディング、シードが必要です)。1つは 編集 →解決します(渡したフラグのみが変更され、ディスク上の他のものはすべてそのまま残ります)。複数のコネクタ ディレクトリが一致する場合、 init 推測するのではなく、 Code: "connectorAmbiguous" で失敗します。 --connector-dir 明示的に渡します。
• サブディレクトリinitスキャンしない理由 — 他のすべてのビルダーコマンドは、現在のディレクトリでコネクタが解決されない場合、直接のサブディレクトリのスキャンにフォールバックします (親ページの概念を参照)。init 、そのフォールバックを意図的にスキップしています。スキャンすると、CWD の下にある 兄弟 コネクタ ディレクトリが解決され、新しいディレクトリを作成する代わりにサイレントに編集または名前変更を行うリスクがあります。init をコネクタの独自のディレクトリ内から実行するか、--connector-dir渡して他の場所で編集します。
• この init をまとめるもの — この 1 つのコマンドにより、以前は connector scaffold、 、 metadata set、 global set、およびベース/ページネーション config preset に分かれていたものが置き換えられるため、他の 3 つの作成動詞 (auth、 activity、 trigger) は狭いままです。ここでフラグとして公開されていないロングテール element.json/メタデータ フィールド (displayOrder、 extended、 typeOauth、 cloneable、 tagsなど) は、代わりに [トリガーとステート] ページでstate patchしてください。
• 作成時のログイン要件 — --organization なしでコネクタを作成するには、要素キー (design-{org}-{slug}) によって組織がスタンプされるため、アクティブなログインが必要です。これにより、実際のログイン ステータスがチェックされます。組織名がたまたまローカルにキャッシュされているかどうかだけでなく、実際のログイン ステータスも確認されます。有効期限が切れたセッションや更新に失敗したセッションは、 uip login status 自体が成功を報告していても、チェックに失敗します。オフラインまたは CI ビルドの場合は明示的に --organization <slug> 渡します。
• ヘッダーの作成と削除の非対称性 — グローバル ヘッダーの追加または更新は、 init --header VendorName=value (繰り返し可能) に折りたたまれます。1 つの削除は別のinit header delete <vendor-name>です — 1 つの element.json parameters[] 配列項目を直接アドレス指定できないため、state patch実行できない 1 つのヘッダー操作です。

概要

uip is connectors builder init [--name <name>] [--connector-dir <path>] [options...]
uip is connectors builder init preset apply --kind <base|pagination> [--override <key=value>]... [--connector-dir <path>] [--force]
uip is connectors builder init header delete <vendor-name> [--connector-dir <path>]
uip is connectors builder inspect [--connector-dir <path>]
uip is connectors builder validate [--connector-dir <path>]

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

ディスク上にコネクタのシェルを作成または構成します。

注:

これを使用して、新しいコネクタ (--nameコネクタ) をブートストラップしたり、コネクタ レベルのフィールド (名前、説明、カテゴリ、ベース URL、ヘッダー、ライフサイクル、層) を既存のコネクタに設定したりできます。リソース/アクティビティを追加するには、[アクティビティとフック] ページでactivity createを使用します。インライン --auth sugar 以外の認証を構成するには、[認証] ページの auth set を使用します。このコマンドでフラグとして公開されないロングテール element.json フィールドを編集するには、 を使用します state patchを使用します。

オプション

長押し	値 (Value)	説明
--name <name>	string	表示名 (例:'Acme Widgets'です。作成時に必須です。要素キーと既定のフォルダーはここから派生します。
--connector-dir <path>	パス	コネクタ ディレクトリ。initに固有の解像度の動作については、上記の「概念」をご覧ください。
--organization <name>	Slug	要素キーの組織スラグ (design-{org}-{name})。作成モードのみ。既定値はログインしている組織です。
--description <text>	string	コネクタの説明を 1 行で表示します。
--categories <csv>	csv	コンマ区切りのカテゴリ リストです。一致では大文字と小文字が区別されません。承認された値は、承認されたスペルに正規化されます (例:crm → CRM)。認識されないカテゴリは、後で validateで失敗するのではなく、ここですぐに失敗します。
--activity-color <hex>	Hex	Studio アクティビティの UI の Hexcolor です。
--base-url <url>	url	既定のベース URL — base.url 構成エントリを設定します。テンプレート化された URL (https://{environment}/api) を指定すると、必要なバッキング補間構成エントリが自動的にシードされます。
--accept-type <value>	string	Accept ヘッダー値。
--content-type <value>	string	Content-Type ヘッダー値。
--header <kv>	VendorName=value	グローバル要求ヘッダー。繰り返し可能。
--lifecycle-stage <stage>	string	ライフサイクル ステージ (例:GA、 BETAです。
--tier <tier>	string	コネクタ ティア。
--auth <type>	string	認証をインラインで設定します (作成モードのみ): 任意の auth set --auth-type 値 (oauth2、 customApiKey、 none、 jwtOauth、 firstPartyService、 など)。oauth2では、--authorization-url、--token-url、--scopeが必要です。以下のフラグ以外のタイプ固有のフラグには、 が必要です auth set。
--authorization-url <url>	url	OAuth2 のログイン/同意 URL です。--auth oauth2で必須です。
--token-url <url>	url	OAuth2 トークン エンドポイント。--auth oauth2で必須です。
--token-refresh-url <url>	url	OAuth2 更新エンドポイント。既定値は --token-urlです。
--token-revoke-url <url>	url	OAuth2 トークン取り消しエンドポイント。
--scope <scope>	string	OAuth2 のスペースで区切られたスコープ文字列です。--auth oauth2で必須です。
--api-key-param-name <name>	string	customApiKey — ベンダーのヘッダーまたはクエリ パラメーター名です。
--api-key-location <where>	header | query	customApiKey — キーが送信される場所です。既定 headerです。
--api-key-prefix <prefix>	string	customApiKey — リテラルプレフィックス。
--key-config-name <key>	string	customApiKey — 内部構成キーです。既定 custom.api.keyです。
--key-config-display-name <name>	string	customApiKey — UI ラベル。既定 API Keyです。
--force	フラグ	エラーを発生させるのではなく、既存のエントリに差分を適用します。

例

# Create a new connector (auth configured later)
uip is connectors builder init --name 'Acme Widgets'

# Create + OAuth2 + base URL in one call
uip is connectors builder init --name 'Acme Widgets' --base-url https://api.acme.com \
  --auth oauth2 --authorization-url https://acme.com/oauth/authorize \
  --token-url https://acme.com/oauth/token --scope 'read write'

# Edit an existing connector — only the passed flags change
uip is connectors builder init --description 'Acme Widgets connector' --categories crm,sales

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

{
  "Code": "ConnectorInitialized",
  "Data": {
    "Mode": "created",
    "ElementKey": "design-myorg-acmewidgets",
    "RepoName": "acme-widgets",
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets",
    "FilesCreated": ["app/element/element.json", "..."],
    "OrganizationName": "myorg",
    "OrganizationNameSource": "login",
    "HeadersSeeded": [],
    "BaseUrlSet": false,
    "MetadataChanges": [],
    "AuthConfigured": null
  }
}

Mode が "created" か "edited"です。編集モードでは、より狭い Data 形状 ( Mode、 ConnectorRoot、 HeadersChanged、 MetadataChanges、 BaseUrlSet が返されます。 FilesCreated、 OrganizationName、 AuthConfiguredはありません。これらは新しいスキャフォールドにのみ適用されるためです。

UIP is コネクタ ビルダー Init Preset 適用

設定エントリの正規バンドルを適用します。 base (ベース URL と select/nulls/インスタンス キー) または pagination (4 つのページネーション キー) を適用します。

注:

これを使用して、ベース キーまたはページネーション構成キーを 1 回の呼び出しでシードします。イベント/ポーリング バンドルは、このコマンドではなく trigger create --event-kindを介してアクセスする個別のプリセットです。バンドルの代わりにオーダーメイドの設定エントリを 1 つ追加するには、 を使用します state patch element.json/configuration/<key>。

オプション

長押し	値 (Value)	説明
--kind <kind>	base | pagination	必須。適用するプリセット。
--override <kv>	key=value	エントリごとの defaultValue の上書き。繰り返し可能。
--connector-dir <path>	パス	コネクタ ディレクトリ。
--force	フラグ	エラーを発生させるのではなく、既存のエントリに差分を適用します。

例

uip is connectors builder init preset apply --kind pagination

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

{
  "Code": "ConfigPresetApplied",
  "Data": {
    "Kind": "pagination",
    "Added": ["pagination.max"],
    "Updated": [],
    "Unchanged": [],
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets"
  }
}

UIP はコネクタ ビルダーです。 Init ヘッダーの削除

ベンダー名によるグローバル要求ヘッダーを削除します。

注:

送信しなくなったグローバル ヘッダーを削除するには、このルールを使用します。追加または更新するには、 init --header VendorName=value を使用します。 init header createはありません。その操作は init そのものに生きています。

引数

名前	Required	目的
<vendor-name>	○	削除するベンダーのヘッダー名。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ。

例

uip is connectors builder init header delete X-Tenant

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

{
  "Code": "GlobalHeaderRemoved",
  "Data": { "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets", "VendorName": "X-Tenant" }
}

UIP is コネクタ ビルダーの検査

コネクタの読み取り専用の構造化の概要 (認証の種類、設定、リソース (標準リソースのファイルとフックを含む)、グローバル フック、イベント、メタデータ) を作成します。

注:

これを使用して、既存のコネクタを編集する前にそのマップを素早く取得したり、存在するリソース、フック、認証の種類を確認したりできます。構造の概要の代わりに合格/不合格チェックには、 を使用します validate。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ。

例

uip is connectors builder inspect --connector-dir ./my-acme-connector

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

{
  "Code": "ConnectorInspected",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Description": "Acme Widgets connector",
    "AuthTypes": ["oauth2"],
    "ConfigCount": 5,
    "ConfigKeys": ["base.url", "..."],
    "ResourceCount": 12,
    "ResourceSummary": {
      "/auth_validation": { "Methods": ["GET"], "Type": "standard", "StandardResourceFile": "auth_validation.json", "Hooks": [] }
    },
    "GlobalHooks": [],
    "HasEvents": false,
    "EventTypes": [],
    "Categories": ["CRM"],
    "LifecycleStage": "GA",
    "Metadata": { "...": "verbatim element-metadata.json content" }
  }
}

ResourceSummary は、リソースの実際のディスク上のパス (/auth_validation)、 Metadata は element-metadata.jsonの逐語的な内容です。どちらも CLI の通常の PascalCase キー正規化から除外されます — 生のキーはディスク上に表示されているとおりに保持されるため、この出力から構築されたセレクター (たとえば、/auth_validation、 {sys_id}) は、マングルされた /authValidation / {sysId} バリアントではなく実際のファイル パスに一致します。

UIP is コネクタ ビルダーの検証

コネクタ上で完全なチェック セットを実行し、構造化されたレポートを出力します。コネクタが無効な場合は、ゼロ以外で終了するため、CI はそのコネクタをゲートできます。

注:

これを使用して、インポートまたはリリース前に CI でコネクタをゲートしたり、 element.json、標準リソース ファイル、フック、メタデータ全体でエラー、警告、提案を検索したりします。チェックを実行する代わりにコネクタの構造を参照するには、 を使用します inspect。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ。

例

uip is connectors builder validate

uip is connectors builder validate --connector-dir ./my-acme-connector

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

{
  "Code": "ConnectorValidation",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Valid": true,
    "Errors": [],
    "Warnings": [],
    "Info": ["Configuration entries: 5"],
    "Summary": "PASS: 0 error(s), 0 warning(s)"
  }
}

レポートは pass と fail の両方で発行されます — 失敗したレポートは Data で Valid: false でResult: "Success"を返しますが (コマンド自体はエラーではありません)、プロセスはゼロ以外の終了コードで終了するため、CI は本文を解析せずに結果をゲートできます。

関連

• UI はコネクタ ビルダーです — 概念、およびテナント ライフサイクル動詞 (download/import/publish/publish-status)
• 認証 — コネクタの認証スキームを設定します。
• アクティビティとフック — コネクタのアクティビティの動作を定義します。
• トリガーとステート — イベント トリガーと低レベルの要素ファイルの編集を行います。

参照

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