uip est le déclencheur et le déclencheur du générateur de connecteurs; État

Syntaxe et options pour connecter les déclencheurs d'interrogation/webhook et pour l'accès structuré en lecture/écriture aux fichiers d'un connecteur avec le générateur de connecteurs Integration Service — création de déclencheur, requête d'état et correctif d'état.

Une partie de la chaîne d'outils de création locale uip is connectors builder . Cette page couvre deux groupes de commandes non liés, mais de petite taille, qui partagent une page en raison de leur taille:

• builder trigger create — connecter une activité existante en tant que source d'événements (interrogation ou webhook), afin que Studio puisse déclencher un processus lorsqu'un enregistrement de fournisseur est créé, mis à jour ou supprimé.
• builder state query/patch — une surface de lecture/écriture générique adaptée à un pointeur sur les fichiers disque d'un connecteur. Il s'agit de la barre d'échappement pour tout ce que les commandes de niveau supérieur (init, auth, activity) n'affichent pas en tant qu'indicateur dédié.

Pour la résolution du répertoire du connecteur, la distinction entre la conception et la publication et le flux de création global, voir Concepts sur la page parente. Pour les activités auxquelles un déclencheur s'attache, consultez Activité et hooks.

Synthèse

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 est la création d'un déclencheur du générateur de connecteurs

Établissez une activité/ressource existante en tant que source de déclencheur: référencez le bundle de configuration d'événement (--event-kind), puis configurez les métadonnées d'interrogation (CREATED/UPDATED/DELETED) — les métadonnées de ressource standard, l'entrée de configuration de l'interrogateur et l'indicateur hasEvents du connecteur.

trigger a un seul verbe. Il n’y a pas trigger list/get/delete — supprimez ou inspectez un déclencheur via state patch/state query par rapport à l’entrée element.json de la ressource à la place.

Remarque :

Utilisez cette option pour transformer une activité GET existante en source de déclencheur d'interrogation. L'activité doit déjà exister — cette commande échoue avec Code: "resourceNotFound" si aucun fichier de ressources standard n'existe encore pour --resource-name; exécutez d'abord activity create .

Options

Long	Valeur (Value)	Description
--resource-name <name>	string	Requis. Activité/ressource standard existante à connecter en tant que déclencheur.
--updated-date-field <field>	string	Requis. Champ Fournisseur qui porte la date de dernière modification, par exemple LastModifiedDate.
--event-kind <kind>	polling | webhook | all	Bundle de configuration d'événements à référencer. Par défaut polling. Validé côté client — une valeur non reconnue échoue rapidement avec Code: "invalidEventKind" plutôt que de revenir en arrière en mode silencieux.
--override <kv>	key=value, répétable	Remplacement par entrée defaultValue pour le préréglage d'événement amorcé.
--created-date-field <field>	string	Champ de date de création du fournisseur. La valeur par défaut est --updated-date-field.
--id-field <field>	string	Champ de clé principal. La valeur par défaut est Id.
--date-format <mask>	string	Masque au format date pour les horodatages mis à jour.
--created-date-format <mask>	string	Masque au format de la date pour les horodatages créés. La valeur par défaut est --date-format.
--event-types <csv>	Séparé par des virgules	Types d'événement à activer. La valeur par défaut est CREATED,UPDATED,DELETED.
--polling-url <url>	url	URL d'interrogation explicite. Généré automatiquement à partir du chemin d'accès GET de l'activité lorsqu'il est omis.
--date-timezone <tz>	string	Fuseau horaire pour les comparaisons de dates. La valeur par défaut est GMT.
--polling-resource-label <label>	string	Libellé utilisé dans elementMetadata.pollingResources.
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

--event-kind dossier ce qui était auparavant une config preset --kind event étape distincte: il initialise le bundle de configuration d'événement (l'entrée de configuration de l'interrogateur a besoin d'interrogation) avant de connecter les métadonnées d'interrogation, en un seul appel.

Exemple

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

Format des données (--sortie 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" }
  }
}

Un tableau Warnings est ajouté lorsque l'opération réussit avec des mises en garde (par exemple, une URL d'interrogation générée automatiquement qui peut nécessiter un examen manuel).

uip est une requête d'état du générateur de connecteurs

Lire la tranche d'un connecteur ciblé par un pointeur. Lecture seule — Renvoie la valeur analysée telle quelle (un objet, un tableau ou une chaîne).

Remarque :

Utilisez cette option pour inspecter la forme actuelle d'un connecteur avant de le corriger: une entrée de configuration unique, une ressource, un champ de ressource standard, un fichier de hook ou une clé de métadonnées. Pour un déploiement structurel de connecteurs entiers au lieu d'une tranche adressée, utilisez inspect. Pour écrire ou supprimer, utilisez state patch ci-dessous.

Arguments

Nom	Requis	Objectif
<pointer>	oui	Pointeur dans le connecteur - voir Diagramme du pointeur ci-dessous.

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

Exemples

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

Format des données (--sortie json)

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

Les clés de Value sont conservées exactement telles qu'elles apparaissent sur le disque (c sommes, et non PascalCase comme le reste de la sortie de cette CLI) - c'est délibéré, de sorte qu'un résultat state query peut être transmis directement dans state patch --value sans aucune reformation. Voir Requête → aller-retour ci-dessous. Une lecture au niveau du tableau qui renvoie des attributs par élément au lieu d'objets complets ajoute "Summarized": true et un champ SummaryHint à l'enveloppe — traiter un résultat résumé comme une liste de noms/clés à interroger individuellement, et non les enregistrements complets.

uip est le correctif de l’état du générateur de connecteurs

Écrivez (upsert) ou supprime la tranche d'un connecteur ciblé par un pointeur. element.json est la source de la vérité; les paramètres de ressources standard liés à la synchronisation automatique lorsqu'un correctif modifie quelque chose dont ils dépendent.

Remarque :

Utilisez cette option pour définir ou remplacer une entrée de configuration, une ressource, un paramètre, un champ de ressource standard, un hook ou une clé de métadonnées qu'aucune des commandes de niveau supérieur (init, auth, activity) n'expose en tant qu'indicateur dédié — ou pour supprimer un seul élément ciblé (--op remove). Pour lire d'abord, utilisez state query ci-dessus. Il ne s’agit pas d’un élaboration en bloc ou d’une connexion d’authentification; utilisez pour ceux-ci les commandes de création dédiées.

Arguments

Nom	Requis	Objectif
<pointer>	oui	Pointeur dans le connecteur - voir Diagramme du pointeur ci-dessous.

Options

Long	Valeur (Value)	Description
--value <json>	JSON en ligne	Valeur à écrire. Capture mutuellement exclusive avec --value-file. Omettre pour --op remove.
--value-file <path>	Chemin d'accès	Lisez la valeur JSON pour écrire à partir d'un fichier plutôt que d'écrire en ligne. Capture mutuellement exclusive avec --value.
--op <op>	upsert | remove	Opération. Par défaut upsert.
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Même ordre de résolution que Concepts.

Exemples

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

Format des données (--sortie json)

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

Un tableau Warnings est ajouté lorsque le correctif réussit avec des mises en garde, et un tableau AutoSynced répertorie tous les fichiers ou champs liés au correctif mis à jour comme effet latéral (par exemple, un paramètre de ressource standard conservé en synchronisation avec un paramètre element.json) modifié } définition de la ressource). Les deux sont omis de Data lorsqu'ils sont vides.

Diagramme du pointeur

Les deux commandes state query et state patch adressent un connecteur via la même grammaire de pointeur, également affichée dans la sortie --help de chaque commande:

Pointeur	Adresses
element.json/configuration	Résumé de la configuration. Filtrez avec ?type=.
element.json/configuration/{key}	Une entrée de configuration.
element.json/resources	Résumé de la ressource. Filtrez avec ?method= / ?type=.
element.json/resources/{METHOD}/{path}	Une ressource ({path} est encodé en pourcentage).
element.json/authentication	Le bloc d'authentification.
element.json/hooks | element.json/parameters	Tableaux de hooks/paramètres globaux.
standard-resources	Répertorier les noms de ressources standard.
standard-resources/{name}	Un fichier de ressources standard complet.
standard-resources/{name}/fields	Liste des noms de champ.
standard-resources/{name}/fields/{field}	Un objet de champ.
standard-resources/{name}/metadata[/{key}]	Objet de métadonnées ou clé de métadonnées unique.
hooks	Répertorie les fichiers de hook.
hooks/{file}	Un fichier JS de hook.
element-metadata.json	L’objet element-metadata.json.
tout autre chemin relatif au référentiel	Fichier brut de secours. En lecture seule; JSON est plutôt imprimé.

Requête → aller-retour - correctif

La sortie de state query est conçue pour être renvoyée directement dans state patch --value sans modification: lisez une tranche avec query, modifiez le JSON obtenu, puis patch le même pointeur avec --value défini sur le JSON modifié (ou écrivez-le dans un fichier et utilisez --value-file). Cela ne fonctionne que parce que les clés de Value sont conservées textuellement (c depuisalCase, casse sur disque) plutôt que PascalCase comme le reste de la sortie JSON de cette CLI - la reformation de la casse des clés avant le correctif ne permettra pas d’aller-retour correctement.

Associé

• Vue d'ensemble et cycle de vie du locataire - concepts partagés entre toutes les pages du générateur, plus download/import/publish/publish-status.
• Initialiser et connecteur — élaboration d'un connecteur, et le déploiement structurel inspect .
• Authentification : configurez le schéma d’authentification du connecteur.
• Activité et hooks — les activités auxquelles un déclencheur s'attache.

Voir également

• Présentation de l’outil Integration Service
• Options globales
• Codes de sortie