UIP はコネクタ ビルダー、トリガー、ステートです。

ポーリング/Webhook トリガーをワイヤリングしたり、Integration Service コネクタ ビルダーを使用してコネクタのファイルへの低レベルの構造化された読み取り/書き込みアクセスを行うための構文とオプション (トリガーの作成、ステート クエリ、ステート パッチ) です。

uip is connectors builder ローカル作成ツールチェーンの一部です。このページでは、サイズが大きいためにページを共有する 2 つの無関係だが小さなコマンド グループについて説明します。

• builder trigger create — 既存のアクティビティをイベント ソース (ポーリングまたは Webhook) としてワイヤリングし、ベンダー レコードが作成、更新、削除されたときに Studio でプロセスをトリガーできるようにします。
• builder state query/patch — コネクタのディスク上のファイル上の汎用のポインターアドレスの読み取り/書き込み画面。これは、上位レベルのコマンド (init、 auth、 activity) では専用フラグとして公開されないもののエスケープ ハッチです。

コネクタ ディレクトリの解決、デザインとパブリッシュの違い、および全体的な作成フローについては、親ページの 「概念 」をご覧ください。トリガーがアタッチするアクティビティについては、「 アクティビティとフック」をご覧ください。

概要

uip is connectors builder trigger create --resource-name <name> --updated-date-field <field> [options...]
uip is connectors builder state query <pointer> [--connector-dir <path>]
uip is connectors builder state patch <pointer> [--value <json> | --value-file <path>] [--op upsert|remove] [--connector-dir <path>]

UIP is コネクタ ビルダー トリガーの作成

既存のアクティビティ/リソースをトリガー ソースとしてワイヤリングします。イベント構成バンドルをシードします (--event-kind)、[ポーリング メタデータ] (標準リソースのメタデータ、ポーリングの設定エントリ、コネクタのhasEvents フラグ) を設定します (CREATED/UPDATED/DELETED)。

trigger には 1 つの動詞があります。trigger list/get/deleteはありません。代わりに、リソースのelement.jsonエントリに対してstate patch/state queryを使用してトリガーを削除するか検査します。

注:

これを使用して、既存の GET アクティビティをポーリング トリガーのソースに変換します。アクティビティがすでに存在している必要があります — --resource-nameの標準リソース ファイルがまだ存在しない場合、このコマンドは Code: "resourceNotFound" でハード フェイルされます。最初にactivity createを実行します。

オプション

長押し	値 (Value)	説明
--resource-name <name>	string	必須。トリガーとしてワイヤリングする既存のアクティビティ/標準リソース。
--updated-date-field <field>	string	必須。最終更新日を指定したベンダー フィールド (例: LastModifiedDate)。
--event-kind <kind>	polling | webhook | all	シードするイベント構成バンドル。既定 pollingです。検証済みのクライアント側 — 認識されない値は、 Code: "invalidEventKind" で迅速に失敗し、警告なしにフォールバックします。
--override <kv>	key=value、 繰り返し可能	シードされたイベント プリセットのエントリごとの defaultValue の上書き。
--created-date-field <field>	string	[Vendor creation-date] フィールド既定値は --updated-date-fieldです。
--id-field <field>	string	[主キー] フィールド既定値は Idです。
--date-format <mask>	string	更新されたタイムスタンプの日付形式のマスク。
--created-date-format <mask>	string	作成されるタイムスタンプの日付形式のマスクです。既定値は --date-formatです。
--event-types <csv>	コンマ区切り	有効化するイベントの種類。既定値は CREATED,UPDATED,DELETEDです。
--polling-url <url>	url	明示的なポーリング URL。省略する場合は、アクティビティの GET パスから自動生成されます。
--date-timezone <tz>	string	日付比較のタイムゾーン。既定値は GMT です。
--polling-resource-label <label>	string	elementMetadata.pollingResourcesで使用されるラベル。
--connector-dir <path>	パス	コネクタ ディレクトリ。概念と同じ解決順序です。

--event-kind 、以前は別個の config preset --kind event ステップだったものを折りたたんで、ポーリングメタデータをワイヤリングする前に、イベント構成バンドル (ポーリングに必要なポーラー構成エントリ) を 1 回の呼び出しでシードします。

例

uip is connectors builder trigger create --resource-name Account \
  --updated-date-field LastModifiedDate --id-field Id

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

{
  "Code": "TriggerCreated",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ResourceName": "Account",
    "EventKind": "polling",
    "EventTypes": ["CREATED", "UPDATED", "DELETED"],
    "PollingUrl": "/accounts?where=LastModifiedDate>'<gmtDate>'",
    "PollerConfigKey": "polling.interval",
    "PollingConfig": { "...": "seeded poller config entry" }
  }
}

Warnings配列は、操作が成功すると追加されますが、注意点 (手動による確認が必要な自動生成されたポーリング URL など)。

uip is コネクタ ビルダーのステート クエリ

ポインターで指定されるコネクタのスライスを読み取ります。読み取り専用 — 解析された値をそのまま (オブジェクト、配列、または文字列) 返します。

注:

これを使用して、パッチを適用する前にコネクタの現在の形状 (単一の構成エントリ、リソース、標準リソース フィールド、フック ファイル、またはメタデータ キー) を調べます。1 つのアドレス指定されたスライスではなくコネクタ全体の構造ロールアップの場合は、 を使用しますinspect。書き込みや削除には、以下の state patch を使用します。

引数

名前	Required	目的
<pointer>	○	コネクタへのポインター — 以下の 「ポインターの文法 」をご覧ください。

オプション

長押し	値 (Value)	説明
--connector-dir <path>	パス	コネクタ ディレクトリ。概念と同じ解決順序です。

例

uip is connectors builder state query element.json/configuration/base.url

# Path segments in a resource pointer are URL-encoded
uip is connectors builder state query element.json/resources/GET/%2Fcontacts

uip is connectors builder state query standard-resources/contacts/fields/email

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

{
  "Code": "StateQuery",
  "Data": {
    "pointer": "element.json/configuration/base.url",
    "value": { "key": "base.url", "type": "TEXTFIELD_128" }
  }
}

Valueのキーは、ディスク上に表示されているとおりに保持されます (この CLI の他の出力のように PascalCased ではなく、キャメルケースです) — これは意図的なものであるため、 state query 結果は再形成することなく直接 state patch --value に入力できます。以下の 「クエリ → パッチのラウンド トリップ 」をご覧ください。完全なオブジェクトではなく項目ごとのスタブを返す配列レベルの読み取りでは、エンベロープに "Summarized": true と SummaryHint フィールドが追加されます。要約された結果は、レコード全体ではなく、個別にクエリを実行する名前/キーのリストとして扱われます。

UIP IS コネクタ ビルダーのステート パッチ

ポインターで指定するコネクタのスライスを書き込み (更新/挿入)、または削除します。element.json が真実の情報源です。リンクされた標準リソース パラメーターは、パッチによって依存するものが変更されると自動同期されます。

注:

上位レベルのコマンド (init、 auth、 activity) では公開されない構成エントリ、リソース、パラメーター、標準リソース フィールド、フック、またはメタデータ キーを設定または置換したり、アドレス指定された項目 (--op remove) を削除したりする場合に使用します。最初に読むには、上記の state query を使用します。これは、一括スキャフォールディングや認証配線用ではなく、これら専用の作成コマンドを使用してください。

引数

名前	Required	目的
<pointer>	○	コネクタへのポインター — 以下の 「ポインターの文法 」をご覧ください。

オプション

長押し	値 (Value)	説明
--value <json>	インライン JSON	書き込む値。--value-fileと相互に排他的です。--op removeの場合は省略します。
--value-file <path>	パス	JSON 値を読み取って、インラインではなくファイルから書き込みます。--valueと相互に排他的です。
--op <op>	upsert | remove	操作。既定 upsertです。
--connector-dir <path>	パス	コネクタ ディレクトリ。概念と同じ解決順序です。

例

uip is connectors builder state patch standard-resources/contacts/fields/email \
  --value '{"type":"string","vendorPath":"email"}'

uip is connectors builder state patch 'element.json/resources/GET/%2Fcontacts/parameters/0' --op remove

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

{
  "Code": "StatePatched",
  "Data": {
    "Pointer": "standard-resources/contacts/fields/email",
    "Op": "upsert",
    "Outcome": "Upserted field 'email' in contacts."
  }
}

パッチが成功すると、 Warnings 配列が追加されますが、 AutoSynced 配列には、パッチが副作用として更新されたリンクされたファイルまたはフィールド (たとえば、変更された element.json リソース定義と同期された standard-resource パラメーター) が一覧表示されます。どちらも空の場合は Data から省略されます。

ポインターの文法

state query と state patch はどちらも同じポインター文法でコネクタをアドレス指定します。これは、各コマンドの独自の--help出力にも示されます。

ポインター	住所
element.json/configuration	構成の概要。フィルター処理 で絞り込み?type=
element.json/configuration/{key}	1 つの設定エントリ。
element.json/resources	リソースの概要。?method= / ?type=でフィルター処理します。
element.json/resources/{METHOD}/{path}	1 つのリソース ({path} は URL エンコードされています)。
element.json/authentication	認証ブロック。
element.json/hooks | element.json/parameters	グローバルフック/パラメータ配列。
standard-resources	標準リソース名を一覧表示します。
standard-resources/{name}	標準リソース ファイル全体。
standard-resources/{name}/fields	フィールド名を一覧表示します。
standard-resources/{name}/fields/{field}	1 つのフィールド オブジェクト。
standard-resources/{name}/metadata[/{key}]	メタデータ オブジェクト、または単一のメタデータ キー。
hooks	フック ファイルを一覧表示します。
hooks/{file}	1つのフックJSファイル。
element-metadata.json	element-metadata.json オブジェクトです。
その他のリポジトリ相対パス	未加工ファイルのフォールバック。読み取り専用。JSON はきれいに印刷されています。

クエリ → パッチのラウンド トリップ

state queryの出力は、変更されずにstate patch --value直接フィードバックされるように設計されています。queryでスライスを読み取り、結果の JSON を編集し、編集した JSON に設定された同じポインター--valuepatchします (または、ファイルに書き込んで --value-fileを使用します)。これは、このCLIのJSON出力の他の部分のようにパスカルケースではなく、 Valueのキーが逐語的(キャメルケース、ディスク上の大文字と小文字)保持されている場合にのみ機能します — パッチを適用する前にキーを再ケーシングすると、正しくラウンドトリップされません。

関連

• 概要とテナントのライフサイクル — すべてのビルダー ページ、および download/import/publish/publish-statusで共有される概念。
• Init & connector — スキャフォールディング、コネクタ、および inspect 構造ロールアップ。
• 認証 — コネクタの認証スキームを設定します。
• アクティビティとフック — トリガーがアタッチするアクティビティです。

参照

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