UIP ist Connectors Builder Trigger & Status

Syntax und Optionen für die Verknüpfung von Abruf-/Webhook-Triggern und für den strukturierten Lese-/Schreibzugriff auf die Dateien eines Connectors auf niedriger Ebene mit dem Connector-Builder des Integration Service – Trigger erstellen, Statusabfrage und Statuspatch.

Teil der uip is connectors builder -Toolkette für die lokale Erstellung. Diese Seite enthält zwei nicht verwandte, aber kleine Befehlsgruppen, die aufgrund ihrer Größe eine gemeinsame Seite teilen:

• builder trigger create – Verknüpfen Sie eine vorhandene Aktivität als Ereignisquelle (Polling oder Webhook), sodass Studio einen Prozess auslösen kann, wenn ein Lieferantendatensatz erstellt, aktualisiert oder gelöscht wird.
• builder state query/patch – eine generische, zeigeradressierte Lese-/Schreiboberfläche über die Dateien eines Connectors auf der Festplatte. Dies ist die Escape-Taste für alles, was die Befehle der höheren Ebene (init, auth, activity) nicht als dediziertes Flag verfügbar machen.

Informationen zur Connector-Verzeichnisauflösung, zur Unterscheidung zwischen Design und Veröffentlichten und zum gesamten Erstellungsablauf finden Sie unter Konzepte auf der übergeordneten Seite. Informationen zu den Aktivitäten, an die ein Trigger angehängt ist, finden Sie unter Aktivität und Hooks.

Zusammenfassung

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 ist Connectors Builder Trigger erstellen“.

Verknüpfen Sie eine vorhandene Aktivität/Ressource als Triggerquelle: Legen Sie das Ereigniskonfigurationspaket (--event-kind) an und konfigurieren Sie dann die Abrufmetadaten (CREATED/UPDATED/DELETED) – die Standardressourcenmetadaten, den Abrufkonfigurationseintrag und das hasEvents -Flag des Connectors.

trigger hat ein einzelnes Verb. Es gibt kein trigger list/get/delete – entfernen oder überprüfen Sie stattdessen einen Trigger über state patch/state query anhand des element.json -Eintrags der Ressource.

Hinweis:

Damit können Sie eine vorhandene GET-Aktivität in eine Abruf-Trigger-Quelle umwandeln. Die Aktivität muss bereits vorhanden sein – dieser Befehl schlägt mit Code: "resourceNotFound" fehl, wenn noch keine Standardressourcendatei für --resource-name vorhanden ist; Führen Sie zuerst activity create aus.

Optionen

Long	Wert	Beschreibung
--resource-name <name>	string	Erforderlich. Vorhandene Aktivität/Standardressource, die als Trigger verknüpft werden soll.
--updated-date-field <field>	string	Erforderlich. Lieferantenfeld mit dem Datum der letzten Änderung, z. B. LastModifiedDate.
--event-kind <kind>	polling | webhook | all	Ereigniskonfigurationspaket für Seed. Der Standardwert ist polling. Clientseitig validiert – Ein nicht erkannter Wert schlägt schnell mit Code: "invalidEventKind" fehl, anstatt im Hintergrund zurückzugreifen.
--override <kv>	key=value, wiederholbar	Überschreibung pro Eintrag defaultValue für die Seed-Ereignisvoreinstellung.
--created-date-field <field>	string	Feld „Erstellungsdatum des Anbieters“. Die Standardeinstellung ist --updated-date-field.
--id-field <field>	string	Primärschlüsselfeld. Die Standardeinstellung ist Id.
--date-format <mask>	string	Datumsformatmaske für aktualisierte Zeitstempel.
--created-date-format <mask>	string	Datumsformatmaske für erstellte Zeitstempel. Die Standardeinstellung ist --date-format.
--event-types <csv>	durch Kommas getrennt sind	Zu aktivierende Ereignistypen. Die Standardeinstellung ist CREATED,UPDATED,DELETED.
--polling-url <url>	url	Explizite Abruf-URL. Automatisch aus dem GET-Pfad der Aktivität generiert, wenn er weggelassen wird.
--date-timezone <tz>	string	Zeitzone für Datumsvergleiche. Die Standardeinstellung ist GMT.
--polling-resource-label <label>	string	Beschriftung, die in elementMetadata.pollingResources verwendet wird.
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

--event-kind Ordner, der früher ein separater config preset --kind event -Schritt war: Er liefert das Ereigniskonfigurationspaket (der Abrufkonfigurationseintrag benötigt), bevor die Abrufmetadaten in einem Aufruf verknüpft werden.

Beispiel

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

Datenform (--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" }
  }
}

Ein Warnings -Array wird hinzugefügt, wenn der Vorgang mit Vorbehalten erfolgreich ist (z. B. eine automatisch generierte Abruf-URL, die möglicherweise manuell überprüft werden muss).

UIP ist Connectors Builder-Statusabfrage

Lesen Sie den Abschnitt eines Connectors, der von einem Mauszeiger angesprochen wird. Schreibgeschützt – Gibt den geparsten Wert unverändert (ein Objekt, ein Array oder eine Zeichenfolge).

Hinweis:

Verwenden Sie diese Option, um die aktuelle Form eines Connectors zu überprüfen, bevor Sie ihn Patching – einen einzelnen Konfigurationseintrag, eine Ressource, ein Standardressourcenfeld, eine Hook-Datei oder einen Metadatenschlüssel. Verwenden Sie für ein strukturiertes Rollup für den gesamten Connector anstelle eines adressierten Abschnitts inspect. Verwenden Sie zum Schreiben oder Entfernen unten state patch.

Argumente

Name	Erforderlich	Zweck
<pointer>	ja	Zeigen Sie auf den Connector – siehe Zeigen Sie das Folgendes an:

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

Beispiele

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

Datenform (--output json)

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

Die Schlüssel von Value werden genau so beibehalten, wie sie auf der Festplatte angezeigt werden (CamelCase, nicht PascalCase wie die restliche Ausgabe dieser CLI) – dies ist beabsichtigt, sodass ein state query -Ergebnis direkt in state patch --value ohne Umgestaltung eingegeben werden kann. Siehe Abfrage → Patch-Roundversion unten. Ein Lesevorgang auf Array-Ebene, der Proxys pro Element anstelle vollständiger Objekte zurückgibt, fügt dem Umschlag "Summarized": true und ein SummaryHint -Feld hinzu – behandeln Sie ein zusammengefasstes Ergebnis als Liste von Namen/Schlüsseln, die einzeln abgefragt werden sollen, nicht als die vollständigen Datensätze.

uip ist der Connector Builder State Patch

Schreiben (Upsert) oder Entfernen des Abschnitts eines Konnektors, der durch einen Anzeigezeiger angesprochen wird. element.json ist die Source of Truth; Verknüpfte Standardressourcenparameter werden automatisch synchronisiert, wenn ein Patch etwas ändert, von dem sie abhängen.

Hinweis:

Verwenden Sie dies, um einen Konfigurationseintrag, eine Ressource, einen Parameter, ein Standardressourcenfeld, einen Hook oder einen Metadatenschlüssel festzulegen oder zu ersetzen, den keiner der Befehle der höheren Ebene (init, auth, activity) als dediziertes Flag verfügbar macht – oder zum Entfernen eines einzelnen adressierten Elements (--op remove). Um zuerst zu lesen, verwenden Sie state query oben. Dies ist nicht für Massengerüst oder Authentifizierungsverknüpfungen vorgesehen – verwenden Sie die speziellen Erstellungsbefehle dafür.

Argumente

Name	Erforderlich	Zweck
<pointer>	ja	Zeigen Sie auf den Connector – siehe Zeigen Sie das Folgendes an:

Optionen

Long	Wert	Beschreibung
--value <json>	Inline-JSON	Zu schreibender Wert. Sich gegenseitig mit --value-file ausschließen. Für --op remove weglassen.
--value-file <path>	Pfad	Lesen Sie den JSON-Wert, um aus einer Datei statt inline zu schreiben. Sich gegenseitig mit --value ausschließen.
--op <op>	upsert | remove	Betrieb. Der Standardwert ist upsert.
--connector-dir <path>	Pfad	Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie „Konzepte“.

Beispiele

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

Datenform (--output json)

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

Ein Warnings -Array wird hinzugefügt, wenn der Patch mit Vorbehalten erfolgreich ist, und ein AutoSynced -Array listet alle verknüpften Dateien oder Felder auf, die der Patch als Nebenergebnis aktualisiert hat (z. B. ein Standardressourcen-Parameter, der mit einem geänderten element.json -Parameter synchronisiert wird). } Ressourcendefinition). Beide werden in Data weggelassen, wenn sie leer sind.

Cursor-Graphing

Sowohl state query als auch state patch adressieren einen Konnektor über dieselbe Zeigen sie auf, die auch in der eigenen --help -Ausgabe jedes Befehls gezeigt wird:

Anzeige	Adressen
element.json/configuration	Konfigurationszusammenfassung. Filtern Sie mit ?type=.
element.json/configuration/{key}	Ein Konfigurationseintrag.
element.json/resources	Ressourcenzusammenfassung. Filtern Sie mit ?method= / ?type=.
element.json/resources/{METHOD}/{path}	Eine Ressource ({path} ist URL-codiert).
element.json/authentication	Der Authentifizierungsblock.
element.json/hooks | element.json/parameters	Globale Hooks/Parameter-Arrays.
standard-resources	Listen Sie Standardressourcennamen auf.
standard-resources/{name}	Eine ganze Standardressourcendatei.
standard-resources/{name}/fields	Listenfeldnamen.
standard-resources/{name}/fields/{field}	Ein Feldobjekt.
standard-resources/{name}/metadata[/{key}]	Metadatenobjekt oder ein einzelner Metadatenschlüssel.
hooks	Hook-Dateien auflisten.
hooks/{file}	Eine Hook-JS-Datei.
element-metadata.json	Das element-metadata.json-Objekt.
ein anderer Repository-relativer Pfad	Fallback für unformatierte Datei. Schreibgeschützt; JSON ist gut gedruckt.

Abfrage → Patch-Roboterpass

Die Ausgabe von state query ist so konzipiert, dass sie direkt an state patch --value zurückgegeben wird: Lesen Sie ein Segment mit query, bearbeiten Sie das resultierende JSON und patch dann den gleichen Mauszeiger, wobei --value auf das bearbeitete JSON festgelegt ist (oder schreiben Sie es in eine Datei und verwenden Sie --value-file). Valueaus

Zugehörig

• Übersicht und Mandantenlebenszyklus – Konzepte, die für alle Builder-Seiten freigegeben werden, plus download/import/publish/publish-status.
• Init und Connector – Erstellen Sie ein Gerüst für einen Connector und das strukturierte inspect -Rollup.
• Auth – konfigurieren Sie das Authentifizierungsschema des Connectors.
• Aktivität und Hooks – Die Aktivitäten, an die ein Trigger angehängt wird.

Siehe auch

• Übersicht über das Integration Service-Tool
• Globale Optionen
• Exitcodes