uip est un générateur de connecteurs

Syntaxe et options pour les commandes de création de connecteur et de cycle de vie du connecteur Integration Service — téléchargement, importation, publication et chaîne d'outils du générateur de connecteurs local.

Les connecteurs Integration Service peuvent être créés localement et transmis à un locataire. Deux couches de commande couvrent cela:

• Cycle de vie du locataire — uip is connectors download, import, publish, publish-status Enregistré directement sous connectors (pas sous builder), car il s'adresse à un locataire et fonctionne avec des connecteurs de conception/création plutôt que de l'arborescence de fichiers locaux. Documenté sur cette page.
• Création locale — uip is connectors builder .... Fonctionne entièrement sur un répertoire de connecteur local (aucun appel de locataire, à l'exception du test en direct facultatif de builder auth) pour élaborer, modifier et valider les fichiers d'un connecteur avant de les importer. Répartir sur cinq pages par domaine — voir Cette ressource s'étend sur six pages ci-dessous.

Aucune des deux couches ne touche le catalogue en lecture seule couvert par uip is connectors (list, get, metadata, swagger, event-operations, audit-logs, export) — cette page concerne déjà la découverte de connecteurs dans le catalogue; celle-ci consiste à créer une nouvelle version de celle qui vous appartient.

Cette ressource s’étend sur six pages

• Cette page — les concepts et les verbes du cycle de vie des locataires: download, import, publish, publish-status.
• Init & connector - builder init (élaboration d'un nouveau connecteur), builder connector inspect/validate.
• Authentification — builder auth set/get/system create/list, le schéma d'authentification du connecteur.
• Activité — builder activity CRUD plus ses sous-groupes field, method et param — le plus grand domaine, définissant ce que font réellement les activités du connecteur.
• Points d'activité hooks — builder activity hook — Transformations pré/post-requête JavaScript, réparties sur sa propre page pour la référence du contexte du runtime dont il a besoin.
• Déclencheur et état — builder trigger create, builder state query/patch — déclencheurs pilotés par des événements et modifications de fichiers d'éléments de bas niveau.

Concepts

• Répertoire du connecteur — un dossier local contenant app/element/element.json (et fichiers frères pour les activités, l'authentification, les déclencheurs). presque chaque commande accepte --connector-dir <path> pour en indiquer une explicitement une. Lorsqu'elle est omise, la résolution démarre à partir du répertoire actuel à la recherche de ce fichier; si aucun n’est trouvé, il analyse les sous-répertoires immédiats pour un seul connecteur; si elle est toujours introuvable, elle revient au connecteur enregistré par la dernière exécution builder init à cet emplacement (.uip-connector.json). Si la résolution trouve plus d'un candidat, la commande échoue avec Code: "connectorAmbiguous" et répertorie les candidats - transmettez --connector-dir explicitement pour désambiguer.
• Conception vs. connecteur publié — un connecteur sous développement local actif est un connecteur de conception (clé préfixée design-..., privée à son auteur). publish le promouvoir à un connecteur PERSONNALISÉ à l'échelle du locataire visible par tous. download/import/publish/publish-status fonctionnent tous sur cet état de conception/publié côté locataire; les verbes builder ci-dessous fonctionnent uniquement sur des fichiers locaux.
• Découverte : chaque builder groupe de commandes envoie une compétence uipath-connector-builder (voir uip skills) qui est automatiquement apparaissant dans les agents de codage de l'IA, plus un bloc --help sur la plupart des commandes avec le message explicite « UTILISER Quand» / « N Points Utilisés» directives — lisez la sortie --help d'une commande avant de supposer son étendue à partir du nom seul.
• Flux typique ( selon le propre texte builder --help de la CLI): builder init → builder auth set → builder activity create → en option builder activity hook create → en option builder trigger create → builder connector validate → uip is connectors import → uip is connectors publish.

Synthèse

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 est une option normale et visible sur les quatre verbes du cycle de vie.

téléchargement des connecteurs uip est

Téléchargez l'arborescence source modifiable d'un connecteur de conception par clé et décompressez-la localement pour modification.

Remarque :

Utilisez cette option pour extraire un connecteur de conception afin de le modifier localement, ou pour initialiser une copie de travail d'un connecteur que vous avez précédemment importé/publié. Pour lire l'enregistrement d'un connecteur à la place, utilisez connectors get. Pour rechercher par nom, utilisez connectors list --filter. Pour exporter le fichier zip du package d'un élément publié, utilisez connectors export — une opération différente de celle-ci.

Arguments

Nom	Requis	Objectif
<connector-key>	oui	Clé de connecteur de conception exacte, par exemple design-myorg-acmewidgets.

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire cible de la source décompressée. La valeur par défaut est le répertoire actuel.
--tenant <name>	name	Remplacer le locataire pour les appels d'API.

Exemple

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

Format des données (--sortie json)

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

uip est l'importation des connecteurs

Packagez le connecteur local dans un zip et créez-le ou mettez-le à jour sur le locataire par clé — créé la première fois, mis à jour à chaque exécution par la suite.

Remarque :

Utilisez cette option pour publier les modifications du connecteur local sur un locataire ou pour créer un connecteur de locataire à partir d'un répertoire local pour la première fois. Pour télécharger ou rechercher plutôt des connecteurs de locataire, utilisez connectors download / connectors list.

Arguments

Aucun

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire du connecteur ou tout parent de app/element/element.json. La valeur par défaut est le répertoire actuel.
--tenant <name>	name	Remplacer le locataire pour les appels d'API.

Exemple

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

Format des données (--sortie json)

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

Operation est "Created" la première fois qu'une clé de connecteur donnée est importée, "Updated" lors de chaque importation suivante.

uip est publication des connecteurs

Promouvoir un connecteur de conception en connecteur PERSONNALISÉ à l’échelle du locataire. Déclenchement et oubli par défaut — renvoie une PublishId à interroger avec publish-status; transmettez --wait pour interroger en interne à la place.

Remarque :

Utilisez cette option après la réussite de connectors import pour rendre le connecteur visible par tous les utilisateurs du locataire - ou pour republier une nouvelle version d'un connecteur déjà publié (recommencez element-metadata.json:latestVersion). Cela ne transfère pas les modifications de fichier local à un locataire — c'est-à-dire connectors import. publish fonctionne uniquement sur ce qui a déjà été importé.

Arguments

Aucun

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Chemin d’accès au répertoire des connecteurs. Même ordre de résolution que pour les concepts ci-dessus.
--version <semver>	Serveur	Remplacer la version de element-metadata.json:latestVersion. Rarement nécessaire.
--connector-id <id>	Integer	Contournez la recherche par clé avec un ID numérique explicite. Rarement nécessaire.
--wait	Drapeau	Interroger le statut jusqu’au SUCCESS/FAILURE/time au lieu de revenir immédiatement.
--timeout-seconds <seconds>	Integer	Délai d’interrogation lorsque --wait est défini. Par défaut 600 (10 minutes).
--tenant <name>	name	Utilisez l’authentification de ce locataire au lieu de la connexion par défaut.

--connector-id et --timeout-seconds sont tous deux validés côté client en tant qu'entiers positifs avant tout appel réseau.

Exemples

# 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

Format des données (--sortie json)

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

Avec --wait, le même Code: "ConnectorPublishStarted" est utilisé, mais Data reflète l'état interrogé final (Status: "SUCCESS" ou "FAILURE", Completed: true) au lieu de l'instantané IN_PROGRESS initial.

uip est connecteurs publish-status

Interrogez le statut d’une tâche de publication par publish-id. Renvoie l'élément textuel du statut du serveur.

Arguments

Nom	Requis	Objectif
<publish-id>	oui	ID de tâche de publication renvoyé par connectors publish.

Options

Long	Valeur (Value)	Description
--tenant <name>	name	Utilisez l’authentification de ce locataire au lieu de la connexion par défaut.

Exemple

uip is connectors publish-status 99

Format des données (--sortie json)

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

Status est l'un des éléments IN_PROGRESS, SUCCESS ou FAILURE, transmis textuellement depuis le serveur. Une publication ayant échoué ajoute un champ Message avec les détails de l'échec.

Associé

• Initialiser et connecteur - élaboration du connecteur local download/import/publish fonctionner sur.
• Authentification : configurez le schéma d’authentification du connecteur.
• Activité : définissez les activités du connecteur.
• Points d'activité hooks - Transformations JavaScript pré/post-requête.
• Déclencheur et état — déclencheurs d'événements et modifications de fichiers de bas niveau.
• uip is connectors — le catalogue en lecture seule que ces commandes alimentent une fois publié.

Voir également

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