Verbindungen erstellen
Einige Systeme unterstützen OAuth-Mechanismus möglicherweise nicht. Sie verwenden möglicherweise andere Authentifizierungsmechanismen, wie die Basisauthentifizierung mit einem Benutzernamen und Passwort, oder sie unterstützen möglicherweise einen schlüsselbasierten Mechanismus. Verbindungen müssen für alle Systeme definiert werden, die OAuth nicht unterstützen.
Gehen Sie wie folgt vor, um eine neue Verbindung zu erstellen:
1. Führen Sie in der Eingabeaufforderung die folgenden Befehle aus:
a. cd <user project root directory>
b. flow add connection <name>
Das Format der Verbindung sieht wie folgt aus: <service-name>-<connection-name>
Der Dienstname wird von der Befehlszeilenschnittstelle automatisch hinzugefügt. Ein neuer Ordner im Format "Konnektorname-Verbindungsname" wird in Ihrem lokalen Verzeichnis erstellt, das die Dateien connection.json und index.js enthält.
Die folgenden Optionen sind für den Befehl verfügbar.
|
Optionen
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--version
|
Zeigt die Versionsnummer an.
|
[Boolean]
|
|
--help
|
Zeigt die Hilfe an.
|
[Boolean]
|
|
--parentDir,-d
|
Das Elternverzeichnis für das Projekt.
|
[Standardwert: "."]
|
|
--logLevel,-1
|
Legt die Protokollebene fest.
|
[Standardwert: "info"]
|
|
--artifactVersion,-v
|
Version des zu erstellenden Artefakts.
|
[Standardwert: "v1"]
|
2. Ermitteln Sie die Informationen, die für die Verbindung mit dem System gesammelt werden müssen.
 |
Die Informationen können die Form einer URL, eines Benutzernamens, eines Passworts oder eines App-Schlüssels haben (oder beliebige andere Informationen, die zum Herstellen einer Verbindung zum System erforderlich sind).
|
Die oben aufgeführten Informationen müssen als JSON-Schema in der Datei connection.json ausgedrückt werden. ThingWorx Flow verwendet diese Informationen, um das Formular im ThingWorx Flow Workflow-Editor anzuzeigen.
Eine Datei index.js konvertiert die in einem Formular gespeicherten Informationen, die von Aktionen und Triggern verwendet werden können. Diese vom Formular zurückgegebenen Informationen werden verschlüsselt und in der ThingWorx Flow Datenbank gespeichert.
Die formatierte Schemadatei connection.json und das Eingabeformular sehen folgendermaßen aus:
In der folgenden Tabelle sind die im JSON-Schema verwendeten Eigenschaften beschrieben.
Eigenschaften | Geben Sie die Eigenschaft in die JSON-Datei ein. |
|---|---|
Typ | Der Typ der oberster Ebene sollte immer der Typ "object" sein. |
title | Wird als Titel des Authentifizierungsfensters auf der ThingWorx Flow Startseite verwendet. |
Format | Layout, das zur Anzeige des Formulars im ThingWorx Flow Zeichenbereich verwendet wird. |
Eigenschaften | Enthält Attribute, die von den Benutzern zur Authentifizierung des Zielsystems erfasst werden. Dies kann eine beliebige Anzahl von untergeordneten Attributen umfassen. Alle untergeordneten Attribute müssen einen Titel, einen Typ und eine Beschreibung haben. Der Typ kann jeder beliebige Typ sein, der vom JSON-Schema unterstützt wird. Sie sehen zum Beispiel, dass die Eigenschaften "email", "subscription_id", "account_url" und "token" (für ein API-Token) erforderlich sind, um eine Verbindung zum System herzustellen. |
Vertrag
Die JavaScript-Datei, beispielsweise index.js, muss ein JavaScript-Objekt exportieren, das zwei Methoden enthält:
• connect: Konvertiert die Eingabe in ein für die Nutzung durch Aktionen, Trigger und Lookups geeignetes Format.
• validate: Wird verwendet, um eine Verbindung zu validieren. In der Regel können Sie die Verbindung zum Zielsystem mithilfe einer API wie der npm request-Bibliothek herstellen.
Informationen zu einem SDK für APIs, die in Verbindungen verwendet werden können, finden Sie im Abschnitt SDK der ThingWorx Flow Konnektoren.
Informationen zum Formatieren des Eingabe- und Ausgabeschemas finden Sie im Hinweis im Thema Aktionen erstellen.
Das folgende Video zeigt das Erstellen einer neuen Verbindung mit der ThingWorx Flow Befehlszeilenschnittstelle.
Weitere Informationen zum Erstellen von Verbindungen finden Sie im Tutorial zum SDK der ThingWorx Flow Konnektoren.