UIP ist Connectors Builder

Syntax und Optionen für die Integration Service-Connector-Erstellungs- und Lebenszyklusbefehle – herunterladen, importieren, veröffentlichen und die lokale „Connectors Builder“-Toolkette.

Integration Service-Connectors können lokal erstellt und an einen Mandanten gepusht werden. Zwei Befehlsebenen decken dies ab:

• Mandantenlebenszyklus – uip is connectors download, import, publish, publish-status. Direkt unter connectors (nicht unter builder) registriert, da sie mit einem Mandanten kommunizieren und mit entworfenen/erstellten Connectors und nicht mit der lokalen Dateistruktur arbeiten. Auf dieser Seite dokumentiert.
• Lokale Erstellung – uip is connectors builder .... Funktioniert vollständig in einem lokalen Connector-Verzeichnis (kein Mandantenaufruf, mit Ausnahme des optionalen Live-Tests von builder auth) zur Erstellung, Bearbeitung und Validierung der Dateien eines Connectors, bevor sie importiert werden. Aufteilen auf fünf Seiten nach Domäne – siehe Diese Ressource umfasst sechs Seiten .

Keine der Ebenen beeinflusst den schreibgeschützten Katalog, der von uip is connectors (list, get, metadata, swagger, event-operations, audit-logs, export) abgedeckt wird – auf dieser Seite geht es bereits um das Erkennen von Connectors im Katalog; Hier geht es um das Erstellen eines neuen oder einer neuen Version von Ihnen.

Diese Ressource umfasst sechs Seiten

• Diese Seite – Konzepte und die Verben für den Mandantenlebenszyklus: download, import, publish, publish-status.
• Init und Connector – builder init (Gerüst für einen neuen Connector), builder connector inspect/validate.
• Auth – builder auth set/get/system create/list, das Authentifizierungsschema des Connectors.
• Aktivität – builder activity CRUD plus ihre Untergruppen field, method und param – die größte Domäne, die definiert, was die Aktivitäten des Connectors tatsächlich tun.
• Aktivitäts-Hooks – builder activity hook – JavaScript-Transformationen vor/nach der Anforderung, aufgeteilt auf eine eigene Seite für die benötigte Laufzeitkontextreferenz.
• Trigger und Status – builder trigger create, builder state query/patch – ereignisgesteuerte Trigger und Bearbeitungen von Elementdateien auf niedriger Ebene.

Konzepte

• Connector-Verzeichnis – ein lokaler Ordner mit app/element/element.json (und gleichgeordneten Dateien für Aktivitäten, Authentifizierung, Trigger). Fast jeder Befehl akzeptiert --connector-dir <path>, um explizit auf einen zu verweisen. Wenn diese Option weggelassen wird, startet die Auflösung vom aktuellen Verzeichnis nach oben und sucht nach dieser Datei; Wenn keines gefunden wird, werden unmittelbare Unterverzeichnisse nach einem einzelnen Connector durchsucht; Wenn sie immer noch nicht gefunden wird, greift sie auf den Connector zurück, der von der letzten builder init -Ausführung an diesem Speicherort (.uip-connector.json) aufgezeichnet wurde. Wenn die Lösung mehr als einen Kandidaten findet, schlägt der Befehl mit Code: "connectorAmbiguous" fehl und listet die Kandidaten auf – übergeben Sie --connector-dir explizit, um dies eindeutig zu machen.
• Design- vs. veröffentlichter Connector – Ein Connector in aktiver lokaler Entwicklung ist ein Design- Connector (Schlüssel mit Präfix design-..., privat für seinen Autor). publish stufen es zu einem mandantenweiten CUSTOM- Connector hoch, der für jeden sichtbar ist. download/import/publish/publish-status arbeiten alle mit diesem mandantenseitigen Design-/veröffentlichten Status; Die folgenden builder -Verben arbeiten ausschließlich mit lokalen Dateien.
• Erkennung – Jede builder -Befehlsgruppe liefert eine uipath-connector-builder -Fähigkeit (siehe uip skills) aus, die automatisch für KI-Codierungs-Agents verfügbar ist, sowie einen --help -Block für die meisten Befehle mit expliziten „VERWALTUNG“/ „N Verwenden FÜR“ Anleitung – Lesen Sie die eigene --help -Ausgabe eines Befehls, bevor Sie seinen Scope nur aus dem Namen annehmen.
• Typischer Ablauf (gemäß dem eigenen builder --help -Text der CLI): builder init → builder auth set → builder activity create → optional builder activity hook create → optional builder trigger create → builder connector validate → uip is connectors import → uip is connectors publish.

Zusammenfassung

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 ist eine normale, sichtbare Option für die vier Lebenszyklusverben.

UIP ist Connectors-Download

Laden Sie die bearbeitbare Quellstruktur eines Design-Connectors nach Schlüssel herunter und entpacken Sie sie lokal zur Bearbeitung.

Hinweis:

Verwenden Sie dies, um einen Design-Connector für die lokale Bearbeitung abzurufen oder eine Arbeitskopie eines Connectors zu laden, den Sie zuvor importiert/veröffentlicht haben. Um stattdessen den Datensatz eines Connectors zu lesen, verwenden Sie connectors get. Um nach dem Namen zu suchen, verwenden Sie connectors list --filter. Um die Paket-ZIP eines veröffentlichten Elements zu exportieren, verwenden Sie connectors export – einen anderen Vorgang als diesen.

Argumente

Name	Erforderlich	Zweck
<connector-key>	ja	Genauer Design-Connector-Schlüssel, z. B. design-myorg-acmewidgets.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Zielverzeichnis für die entpackte Quelle. Standardmäßig das aktuelle Verzeichnis.
--tenant <name>	name	Überschreiben Sie den Mandanten für die API-Aufrufe.

Beispiel

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

Datenform (--output json)

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

UIP ist Connectors-Import

Verpacken Sie den lokalen Connector in eine ZIP-Datei und erstellen oder aktualisieren Sie ihn auf dem Mandanten nach Schlüssel – er wird beim ersten Mal erstellt und bei jeder Ausführung danach aktualisiert.

Hinweis:

Verwenden Sie dies, um lokale Connector-Änderungen an einem Mandanten zu veröffentlichen oder um zum ersten Mal einen Mandanten-Connector aus einem lokalen Verzeichnis zu erstellen. Um stattdessen Mandanten-Connectors herunterzuladen oder zu suchen, verwenden Sie connectors download / connectors list.

Argumente

Keine.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis oder ein beliebiges übergeordnetes Element von app/element/element.json. Standardmäßig das aktuelle Verzeichnis.
--tenant <name>	name	Überschreiben Sie den Mandanten für die API-Aufrufe.

Beispiel

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

Datenform (--output json)

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

Operation ist "Created" beim ersten Importieren eines bestimmten Connectorschlüssels, "Updated" bei jedem nachfolgenden Import.

UIP ist Connectors veröffentlicht

Steigern Sie einen Design-Connector zu einem mandantenweiten CUSTOM-Connector. Standardmäßig Fire-and-Forget – gibt PublishId zur Abfrage mit publish-status zurück; Übergeben Sie stattdessen --wait für eine interne Abfrage.

Hinweis:

Verwenden Sie dies, nachdem connectors import erfolgreich war, um den Connector für jeden Benutzer im Mandanten sichtbar zu machen – oder um eine neue Version eines bereits veröffentlichten Connectors erneut zu veröffentlichen (back element-metadata.json:latestVersion zuerst). Dadurch werden keine lokalen Dateiänderungen an einen Mandanten verschoben – das ist connectors import. publish funktioniert nur mit dem, was bereits importiert wurde.

Argumente

Keine.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Pfad zum Connector-Verzeichnis. Dieselbe Auflösungsreihenfolge wie bei den oben genannten Konzepten .
--version <semver>	Server	Überschreiben Sie die Version von element-metadata.json:latestVersion. Selten erforderlich.
--connector-id <id>	Integer	Umgehen Sie die Get-by-Key-Suche mit einer expliziten numerischen ID. Selten erforderlich.
--wait	Markieren	Status bis SUCCESS/FAILURE/timeout abfragen, anstatt sofort zurückzukehren.
--timeout-seconds <seconds>	Integer	Timeout für Abrufe, wenn --wait festgelegt ist. Standardmäßig: 600 (10 Minuten).
--tenant <name>	name	Verwenden Sie die Authentifizierung dieses Mandanten anstelle der angemeldeten Standardauthentifizierung.

Sowohl --connector-id als auch --timeout-seconds werden clientseitig als positive Integer vor jedem Netzwerkaufruf validiert.

Beispiele

# 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

Datenform (--output json)

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

Mit --wait wird die gleiche Code: "ConnectorPublishStarted" verwendet, aber Data spiegelt den endgültigen Abrufstatus (Status: "SUCCESS" oder "FAILURE", Completed: true) anstelle des ursprünglichen IN_PROGRESS -Snapshots wider.

UIP ist Connectors-Veröffentlichungsstatus

Rufen Sie den Status eines Veröffentlichungsauftrags von publish-id ab. Gibt den Status wörtlich des Servers zurück.

Argumente

Name	Erforderlich	Zweck
<publish-id>	ja	Veröffentlichungsauftrags-ID, die von connectors publish zurückgegeben wird.

Optionen

Long	Wert	Beschreibung
--tenant <name>	name	Verwenden Sie die Authentifizierung dieses Mandanten anstelle der angemeldeten Standardauthentifizierung.

Beispiel

uip is connectors publish-status 99

Datenform (--output json)

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

Status ist einer von IN_PROGRESS, SUCCESS oder FAILURE und wird verbatim vom Server übergeben. Bei einer fehlgeschlagenen Veröffentlichung wird ein Message -Feld mit dem Fehlerdetail hinzugefügt.

Zugehörig

• Init und Connector – Gerüst für den lokalen Connector, auf dem download/import/publish arbeiten.
• Auth – konfigurieren Sie das Authentifizierungsschema des Connectors.
• Aktivität – Definieren, was die Aktivitäten des Connectors bewirken.
• Aktivitäts-Hooks – JavaScript-Transformationen vor/nach der Anforderung.
• Trigger und Status – Ereignistrigger und Dateibearbeitungen auf niedriger Ebene.
• uip is connectors – der schreibgeschützte Katalog, in den diese Befehle nach der Veröffentlichung eingefügt werden.

Siehe auch

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