UIP ist Connectors Builder init & Connectors

Syntax und Optionen für das Erstellen, Bearbeiten, Überprüfen und Validieren eines lokalen Integration Service-Connectors – Builder Init, Init Preset Apply, Init Header Delete, Prüfen und Validieren.

Teil der uip is connectors builder -Toolkette für die lokale Erstellung. Diese Seite behandelt die beiden Verben, die die On-Disk -Shell eines Connectors besitzen:

• builder init – Erstellen Sie einen neuen Connector oder bearbeiten Sie Felder auf dem Connector, der aus dem aktuellen Verzeichnis aufgelöst wird. Hat auch init preset apply (ein Basis-/Paginierungskonfigurationspaket bereitstellen) und init header delete (einen globalen Anforderungsheader entfernen).
• builder inspect / builder validate – schreibgeschützte Strukturzusammenfassung und CI-auf Umsetzbare/Nichtbestehensprüfungssatz. Diese befinden sich direkt unter builder, ohne connector -Wrapper im Befehlspfad.

Informationen zu Gerüst für Aktivitäten, Authentifizierung, Trigger oder Dateibearbeitung auf niedriger Ebene finden Sie auf den gleichgeordneten Seiten.

Konzepte

• Bereitstellung erstellen vs. bearbeiten – init entscheidet über seinen Modus, indem ein Connector von --connector-dir (oder dem aktuellen Verzeichnis) aufgelöst wird und nur das aktuelle Verzeichnis selbst scannt – keine Unterverzeichnisse, im Gegensatz zur Fallback-Auflösung anderer Builder-Befehle). Kein Connector wird aufgelöst → erstellen (erfordert --name, erstellt eine neue Struktur und Seed-Standardeinstellungen). Eins wird aufgelöst → bearbeiten (nur die Flags, die Sie übergeben, ändern sich; alles andere auf der Festplatte bleibt so, wie es ist). Wenn mehr als ein Connector-Verzeichnis übereinstimmen würde, schlägt init mit Code: "connectorAmbiguous" anstelle einer Schätzung fehl – übergeben Sie --connector-dir explizit.
• Warum init Unterverzeichnisse nicht durchsucht – jeder andere Builder-Befehl greift auf das Scannen von sofortigen Unterverzeichnissen zurück, wenn kein Connector im aktuellen Verzeichnis aufgelöst wird (siehe Konzepte auf der übergeordneten Seite). init überspringt dieses Fallback absichtlich: Beim Scannen würde das Risiko bestehen, ein gleichgeordnetes Connector-Verzeichnis unter cwd aufzulösen und es im Hintergrund zu bearbeiten oder umzubenennen, anstatt ein neues zu erstellen. Führen Sie init innerhalb des eigenen Verzeichnisses des Connectors aus, oder übergeben Sie --connector-dir, um eines an anderer Stelle zu bearbeiten.
• Was sich init zusammenfügt – Dieser einzelne Befehl ersetzt die früheren separaten Oberflächen connector scaffold, metadata set, global set und Basis/Paginierung config preset , sodass die anderen drei Erstellungsverben (auth, activity, trigger) bleiben schmal. Langfristige element.json /Metadatenfelder, die hier nicht als Flags verfügbar gemacht werden (displayOrder, extended, typeOauth, cloneable, tags, …), durchlaufen stattdessen state patch auf der Seite Trigger und Status .
• Anmeldeanforderung beim Erstellen – Das Erstellen eines Connectors ohne --organization erfordert eine aktive Anmeldung, da der Elementschlüssel (design-{org}-{slug}) die Organisation abstempelt. Dadurch wird der tatsächliche Anmeldestatus überprüft, nicht nur, ob ein Organisationsname zufällig lokal zwischengespeichert wird – eine abgelaufene oder eine Aktualisierung fehlgeschlagene Sitzung besteht die Prüfung nicht, obwohl uip login status selbst weiterhin Erfolg melden würde. Übergeben Sie --organization <slug> explizit für Offline- oder CI-Builds.
• Header-Asymmetrie erstellen vs. löschen – Das Hinzufügen oder Aktualisieren eines globalen Headers wird in init --header VendorName=value (wiederholbar) zusammengefasst. Es wird das separate init header delete <vendor-name> Entfernen entfernt – der One-Header-Vorgang state patch kann nicht ausgeführt werden, da er ein einzelnes element.json parameters[] -Array-Element nicht direkt adressieren kann.

Zusammenfassung

uip is connectors builder init [--name <name>] [--connector-dir <path>] [options...]
uip is connectors builder init preset apply --kind <base|pagination> [--override <key=value>]... [--connector-dir <path>] [--force]
uip is connectors builder init header delete <vendor-name> [--connector-dir <path>]
uip is connectors builder inspect [--connector-dir <path>]
uip is connectors builder validate [--connector-dir <path>]

UIP ist Connectors Builder Init

Erstellen oder konfigurieren Sie die Shell eines Connectors auf dem Datenträger.

Hinweis:

Verwenden Sie dies, um einen brandneuen Connector (--name) zu legen oder Felder auf Connector-Ebene – Name, Beschreibung, Kategorien, Basis-URL, Header, Lebenszyklus, Stufe – auf einen bereits vorhandenen festzulegen. Um Ressourcen/Aktivitäten hinzuzufügen, verwenden Sie activity create auf der Seite „Aktivität und Hooks“ . Um eine Authentifizierung über den Inline- --auth Sugar hinaus zu konfigurieren, verwenden Sie auth set auf der Seite Authentifizierung . Um ein element.json -Long Tail zu bearbeiten, das dieser Befehl nicht als Flag verfügbar macht, verwenden Sie state patch.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Anzeigename, z. B. 'Acme Widgets'). Beim Erstellen erforderlich; Der Elementschlüssel und der Standardordner werden davon abgeleitet.
--connector-dir <path>	Pfad	Connector-Verzeichnis. Ein für init spezifisches Auflösungsverhalten finden Sie unter Konzepte oben.
--organization <name>	Slug	Organisations-Slug für den Elementschlüssel (design-{org}-{name}). Nur Erstellungsmodus; wird standardmäßig Ihre angemeldete Organisation verwendet.
--description <text>	string	Einzeilige Connector-Beschreibung.
--categories <csv>	csv	Durch Kommas getrennte Kategorieliste. Beim Abgleich wird die Groß-/Kleinschreibung nicht berücksichtigt Genehmigte Werte werden auf ihre genehmigte Rechtschreibung (z. B. crm → CRM). Eine nicht erkannte Kategorie schlägt hier schnell fehl als später bei validate.
--activity-color <hex>	HEX	HexFarbe für die Benutzeroberfläche der Studio-Aktivität.
--base-url <url>	url	Standardbasis-URL – Legt den Konfigurationseintrag base.url fest. Eine URL mit Vorlage (https://{environment}/api) erstellt automatisch den benötigten Konfigurationseintrag für die unterstützende Interpolation.
--accept-type <value>	string	Accept Header-Wert.
--content-type <value>	string	Content-Type Header-Wert.
--header <kv>	VendorName=value	Header der globalen Anforderung. Wiederholbar.
--lifecycle-stage <stage>	string	Lebenszyklusphase, z. B. GA, BETA).
--tier <tier>	string	Connector-Ebene.
--auth <type>	string	Konfigurieren Sie die Authentifizierung inline (nur Erstellungsmodus): ein beliebiger auth set --auth-type -Wert (oauth2, customApiKey, none, jwtOauth, firstPartyService, …). Dabei sind oauth2, --authorization-url, --token-url und --scope erforderlich. Typspezifische Flags, die über die folgenden hinausgehen, benötigen auth set.
--authorization-url <url>	url	OAuth2-Anmelde-/Zustimmungs-URL. Erforderlich für --auth oauth2.
--token-url <url>	url	OAuth2-Tokenendpunkt. Erforderlich für --auth oauth2.
--token-refresh-url <url>	url	OAuth2-Aktualisierungsendpunkt. Die Standardeinstellung ist --token-url.
--token-revoke-url <url>	url	Endpunkt für OAuth2-Tokenwiderruf.
--scope <scope>	string	OAuth2-Scope-Zeichenfolge durch Leerzeichen getrennt. Erforderlich für --auth oauth2.
--api-key-param-name <name>	string	customApiKey – Name des Anbieter-Headers oder Abfrageparameters.
--api-key-location <where>	header | query	customApiKey – Wohin der Schlüssel gesendet wird. Der Standardwert ist header.
--api-key-prefix <prefix>	string	customApiKey – Literalpräfix.
--key-config-name <key>	string	customApiKey – interner Konfigurationsschlüssel. Der Standardwert ist custom.api.key.
--key-config-display-name <name>	string	customApiKey – UI-Beschriftung. Der Standardwert ist API Key.
--force	Markieren	Wenden Sie Unterschiede auf vorhandene Einträge an, anstatt Fehler zu verursachen.

Beispiele

# Create a new connector (auth configured later)
uip is connectors builder init --name 'Acme Widgets'

# Create + OAuth2 + base URL in one call
uip is connectors builder init --name 'Acme Widgets' --base-url https://api.acme.com \
  --auth oauth2 --authorization-url https://acme.com/oauth/authorize \
  --token-url https://acme.com/oauth/token --scope 'read write'

# Edit an existing connector — only the passed flags change
uip is connectors builder init --description 'Acme Widgets connector' --categories crm,sales

Datenform (--output json)

{
  "Code": "ConnectorInitialized",
  "Data": {
    "Mode": "created",
    "ElementKey": "design-myorg-acmewidgets",
    "RepoName": "acme-widgets",
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets",
    "FilesCreated": ["app/element/element.json", "..."],
    "OrganizationName": "myorg",
    "OrganizationNameSource": "login",
    "HeadersSeeded": [],
    "BaseUrlSet": false,
    "MetadataChanges": [],
    "AuthConfigured": null
  }
}

Mode ist "created" oder "edited". Der Bearbeitungsmodus gibt eine schmalere Data -Form zurück: Mode, ConnectorRoot, HeadersChanged, MetadataChanges, BaseUrlSet – es gibt keine FilesCreated, OrganizationName oder AuthConfigured, da diese nur für gelten ein neues Gerüst.

UIP ist Connectors Builder Init-Voreinstellung

Wenden Sie ein kanonisches Paket von Konfigurationseinträgen an: base (Basis-URL plus Auswahl-/Nulls-/Instanzschlüssel) oder pagination (die vier Paginierungsschlüssel).

Hinweis:

Verwenden Sie diese Option, um die Basis- oder Paginierungskonfigurationsschlüssel in einem Aufruf zu seeden. Das Ereignis-/Abrufpaket ist eine separate Voreinstellung, die über trigger create --event-kind und nicht über diesen Befehl erreicht wird. Um einen benutzerdefinierten Konfigurationseintrag anstelle eines Pakets hinzuzufügen, verwenden Sie state patch element.json/configuration/<key>.

Optionen

Long	Wert	Beschreibung
--kind <kind>	base | pagination	Erforderlich. Anzuwendende Voreinstellung.
--override <kv>	key=value	Überschreibung pro Eintrag defaultValue. Wiederholbar.
--connector-dir <path>	Pfad	Connector-Verzeichnis.
--force	Markieren	Wenden Sie Unterschiede auf vorhandene Einträge an, anstatt Fehler zu verursachen.

Beispiel

uip is connectors builder init preset apply --kind pagination

Datenform (--output json)

{
  "Code": "ConfigPresetApplied",
  "Data": {
    "Kind": "pagination",
    "Added": ["pagination.max"],
    "Updated": [],
    "Unchanged": [],
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets"
  }
}

UIP ist Connectors Builder Init Header Löschen

Entfernen Sie einen globalen Anforderungsheader nach Anbieternamen.

Hinweis:

Verwenden Sie diese Option, um einen globalen Header zu entfernen, der nicht mehr gesendet werden soll. Um eines hinzuzufügen oder zu aktualisieren, verwenden Sie init --header VendorName=value – es gibt kein init header create; dieser Vorgang befindet sich auf init selbst.

Argumente

Name	Erforderlich	Zweck
<vendor-name>	ja	Zu entfernender Anbieterheadername.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis.

Beispiel

uip is connectors builder init header delete X-Tenant

Datenform (--output json)

{
  "Code": "GlobalHeaderRemoved",
  "Data": { "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets", "VendorName": "X-Tenant" }
}

UIP ist Connectors Builder inspizieren

Erstellen Sie eine schreibgeschützte strukturierte Übersicht über einen Connector: Authentifizierungstypen, Konfiguration, Ressourcen (mit Standard-Ressourcendateien und Hooks), globale Hooks, Ereignisse und Metadaten.

Hinweis:

Verwenden Sie dies, um eine schnelle Übersicht über einen vorhandenen Connector zu erhalten, bevor Sie ihn bearbeiten, oder um zu bestätigen, welche Ressourcen, Hooks und Authentifizierungstypen vorhanden sind. Verwenden Sie für Pass-/Fehlschlagprüfungen anstelle einer Strukturzusammenfassung validate.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis.

Beispiel

uip is connectors builder inspect --connector-dir ./my-acme-connector

Datenform (--output json)

{
  "Code": "ConnectorInspected",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Description": "Acme Widgets connector",
    "AuthTypes": ["oauth2"],
    "ConfigCount": 5,
    "ConfigKeys": ["base.url", "..."],
    "ResourceCount": 12,
    "ResourceSummary": {
      "/auth_validation": { "Methods": ["GET"], "Type": "standard", "StandardResourceFile": "auth_validation.json", "Hooks": [] }
    },
    "GlobalHooks": [],
    "HasEvents": false,
    "EventTypes": [],
    "Categories": ["CRM"],
    "LifecycleStage": "GA",
    "Metadata": { "...": "verbatim element-metadata.json content" }
  }
}

ResourceSummary wird durch den tatsächlichen Pfad der Ressource auf dem Datenträger (z. B. /auth_validation) und Metadata ist der Verbatim-Inhalt von element-metadata.json. Beide sind von der üblichen PascalCase-Schlüsselnormalisierung der CLI ausgenommen – die Rohschlüssel werden genau so beibehalten, wie sie auf der Festplatte angezeigt werden, sodass ein Selektor, der aus dieser Ausgabe erstellt wird (z. B. /auth_validation, {sys_id}) entspricht dem echten Dateipfad, anstatt einer gemischten /authValidation / {sysId} -Variante.

UIP ist Connectors Builder validieren

Führen Sie den vollständigen Prüfsatz über einen Connector aus und geben Sie einen strukturierten Bericht aus. Wird nicht mit Null beendet, wenn der Connector ungültig ist, sodass CI darauf zugreifen kann.

Hinweis:

Verwenden Sie dies, um einen Connector in CI vor dem Import oder der Freigabe zu öffnen und Fehler, Warnungen und Vorschläge über element.json, Standardressourcendateien, Hooks und Metadaten hinweg zu finden. Um die Struktur eines Connectors zu durchsuchen, anstatt Prüfungen durchzuführen, verwenden Sie inspect.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis.

Beispiele

uip is connectors builder validate

uip is connectors builder validate --connector-dir ./my-acme-connector

Datenform (--output json)

{
  "Code": "ConnectorValidation",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Valid": true,
    "Errors": [],
    "Warnings": [],
    "Info": ["Configuration entries: 5"],
    "Summary": "PASS: 0 error(s), 0 warning(s)"
  }
}

Der Bericht wird sowohl bei „Bestand“ als auch „Fehlgeschlagen“ ausgegeben – ein fehlgeschlagener Bericht gibt immer noch Result: "Success" mit Valid: false in Data zurück (der Befehl selbst hat keinen Fehler gemacht), aber der Prozess wird mit einem Exitcode ungleich Null beendet, sodass CI dies tun kann das Ergebnis öffnen, ohne den Text zu analysieren.

Zugehörig

• uip ist Connectors Builder – Konzepte und die Verben des Mandantenlebenszyklus (download/import/publish/publish-status).
• Auth – konfigurieren Sie das Authentifizierungsschema des Connectors.
• Aktivität und Hooks – Definieren, was die Aktivitäten des Connectors tun.
• Trigger und Status – Ereignistrigger und Bearbeitungen von Elementdateien auf niedriger Ebene.

Siehe auch

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