Konnektoren bereitstellen
Nachdem Sie den Konnektor lokal erstellt und getestet haben, können Sie ihn auf einer lokalen Testinstanz von ThingWorx Flow bereitstellen. Um den Konnektor auf dem ThingWorx Flow Server bereitzustellen, führen Sie die folgenden Schritte aus:
1. Führen Sie den Befehl npm install aus dem Konnektorprojekt aus.
Dadurch werden alle Pakete installiert, die vom Konnektor benötigt werden.
2. Starten Sie eine Eingabeaufforderung, und führen Sie den folgenden Befehl aus:
flow-deploy connector -s <Stammverzeichnis des Konnektorprojekts> -t <ThingWorx Flow Installationsverzeichnis>
Dieser Befehl führt die folgenden Aufgaben aus:
a. Kopiert die Artefakt-Metadaten in die Datenbank-Load-Datei.
b. Stellt die Symbole am Laufzeit-Speicherort bereit.
c. Kopiert den Konnektorcode an den Laufzeit-Speicherort für Konnektoren.
3. Führen Sie den folgenden Befehl aus, um die bereitgestellten Artefaktmetadaten in ThingWorx Flow zu laden:
flow-deploy migrate
4. Navigieren Sie zu > > , um den ThingWorx Flow Dienst neu zu starten.
Sie sollten nun Flüsse unter Verwendung von Verbindungen, Aktionen und Triggern aus Ihrem Konnektor erstellen können.
flow-deploy
Der Befehl flow-deploy verfügt über die folgenden Unterbefehle:
•
flow-deploy connector – Stellt Konnektorartefakte für eine lokale Installation von ThingWorx Flow bereit.
•
flow-deploy oauths <Befehl> – Stellt OAuth-bezogene Aktionen bereit.
 |
Es wird empfohlen, dass Sie die
OAuth-Dienste im WorkflowSubsystem in ThingWorx Composer verwenden, um OAuths zu laden oder zu löschen.
|
•
flow-deploy settings <Befehl> – Lädt Konnektoreinstellungen hoch oder herunter.
Alle Unterbefehle des Befehls flow-deploy akzeptieren die folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--log,-l
|
Legt die Protokollebene fest.
|
[String] [Standardwert: "info"]
|
|
--version
|
Zeigt die Versionsnummer des ThingWorx Flow Deploy Utility an.
|
[Boolean]
|
|
--help
|
Zeigt Hilfe für verschiedene Befehle, Unterbefehle und Parameter an, die für den Befehl bereitgestellt werden können.
|
[Boolean]
|
flow-deploy about
Druckt Versionsinformationen des ThingWorx Flow Deploy Utility. Die Befehlssyntax und Ausgabe für den Befehl flow-deploy about lauten wie folgt:
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
Stellt das benutzerdefinierte Konnektorpaket im ThingWorx Flow Installationsverzeichnis bereit und aktualisiert dann die Ladeskripts so, dass sie Metadaten über die benutzerdefinierten Konnektorartefakte wie Verbindungen, Aktionen usw. enthalten.
Der Befehl flow-deploy connector akzeptiert die folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--sourceDir,-s
(Erforderlich)
|
Stammverzeichnis des benutzerdefinierten Konnektorprojekts.
|
[String]
|
|
--targetDir,-t
(Erforderlich)
|
ThingWorx Flow Installationsverzeichnis, standardmäßig C:\ThingWorxOrchestration.
|
[String]
|
|
--allow_schema_overwrite
|
Das Tool flow-deploy lässt das Überschreiben der Eingabe- und Ausgabeschemaeigenschaften, die in den Metadaten-JSON-Dateien vorhandener Aktionen, Verbindungen und Trigger gefunden werden, nicht zu. Wenn dies zulässig wäre, wären alle mit dem alten Schema erstellten Flüsse fehlerhaft. Während der Entwicklung können Sie die Eingabe- und Ausgabeschemaeigenschaften jedoch überschreiben. Legen Sie dieses Flag so fest, dass das vorhandene Schema mit dem neuen Schema aus dem Konnektorprojekt überschrieben wird.
|
-
|
Die Syntax des Befehls flow-deploy connector lautet folgendermaßen:
flow-deploy connector --sourceDir <Stammverzeichnis des Konnektorprojekts> --targetDir <ThingWorx Flow Installationsverzeichnis>
flow-deploy migrate
Dieser Befehl lädt Konnektormetadaten auf den ThingWorx Flow Server.
Der Befehl flow-deploy migrate akzeptiert die folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--sourceDir,-s
(Erforderlich)
|
ThingWorx Flow Installationsverzeichnis, standardmäßig C:\ThingWorxOrchestration.
|
[String]
|
|
--Database username, -u
(Erforderlich)
|
Benutzername für die ThingWorx Flow Datenbank.
|
[String]
|
|
--Database password, -p
(Erforderlich)
|
Passwort für die ThingWorx Flow Datenbank.
|
-
|
Die Syntax des Befehls flow-deploy migrate lautet folgendermaßen:
flow-deploy migrate --sourceDir <ThingWorx Flow Installationsverzeichnis> -u <Benutzername für ThingWorx Flow Datenbank> -p <Passwort für ThingWorx Flow Datenbank>
flow-deploy oauths
Mit diesem Befehl können Sie mit OAuth-Konfigurationen arbeiten. Dieser Befehl hat zwei Unterbefehle:
•
flow-deploy oauths load – Lädt OAuth-Konfigurationen auf eine ausgeführte Instanz von ThingWorx Flow hoch.
•
flow-deploy oauths delete – Löscht OAuth-Konfiguration von einer ausgeführten Instanz von ThingWorx Flow.
|
|
Es wird empfohlen, dass Sie die
OAuth-Dienste im WorkflowSubsystem in ThingWorx Composer verwenden, um OAuths zu laden oder zu löschen.
|
Die folgenden Parameter sind für alle Unterbefehle des Befehls flow-deploy oauths allgemein:
|
Parameter
|
Beschreibung
|
Datentypen
|
|---|---|---|
|
--username,-u
|
Benutzername des ThingWorx Administrators
|
[String]
|
|
--password,-p
|
Passwort des ThingWorx Administrators
|
[String]
|
|
--app-key,-a
|
ThingWorx Anwendungsschlüssel
|
[String]
|
|
--twx-url,-t
|
ThingWorx Basis-URL im Format https://<Hostname:Port>/Thingworx.
|
[String]
|
flow-deploy oauths load
Dieser Befehl lädt OAuth-Konfigurationen in eine ausgeführte Instanz von ThingWorx Flow hoch.
Anweisungen zum Laden von OAuth für Konnektoren finden Sie unter
Konnektor-OAuth-Einstellungen konfigurieren.
Zusätzlich zu den allgemeinen Parametern für alle Unterbefehle des Befehls flow-deploy oauths akzeptiert dieser Befehl den folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--file, -f
|
Name der OAuth-Konfigurationsdatendatei
|
[String]
|
Die Syntax des Befehls flow-deploy oauths load lautet folgendermaßen:
flow-deploy oauths load -u <Benutzername_des_ThingWorx Administrators> -p '<Passwort_des_ThingWorx Administrators>' --twx-url <ThingWorx_Basis-URL> -f <Pfad_zur_OAuth-Konfigurationsdatei>
wobei <ThingWorx Basis-URL> das Format https://<Hostname:Port>/Thingworx haben muss.
flow-deploy oauths delete
Dieser Befehl wird verwendet, um eine vorhandene Konfiguration aus ThingWorx Flow zu löschen. Wenn Sie OAuth-Konfigurationen löschen, müssen Sie die Verbindung in den Flüssen neu erstellen.
Zusätzlich zu den allgemeinen Parametern für alle Unterbefehle des Befehls flow-deploy oauths akzeptiert dieser Befehl den folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--name, -n
(Erforderlich)
|
Name des Konnektors. Dieser Name ist in der OAuth-Konfigurationsdatei verfügbar.
|
[String]
|
|
--title
(Erforderlich)
|
Titel des OAuth-Anbieters. Dieser Titel ist in der OAuth-Konfigurationsdatei verfügbar.
|
[String]
|
Die Syntax des Befehls flow-deploy oauths delete lautet folgendermaßen:
flow-deploy oauths delete -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' --twx-url <ThingWorx Basis-URL> -n <Name des Konnektors> --title <Titel des OAuth-Anbieters>
wobei <ThingWorx Basis-URL> das Format https://<Hostname:Port>/Thingworx haben muss.
Um beispielsweise OAuth für den Konnektor "Box" mit dem Titel "Box" zu löschen, führen Sie den folgenden Befehl aus:
flow-deploy oauths delete -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' --twx-url <ThingWorx Basis-URL> -n box --title Box
wobei <ThingWorx Basis-URL> das Format https://<Hostname:Port>/Thingworx haben muss.
flow-deploy settings
Sie können mehrere Mandanten für einen einzelnen Konnektor konfigurieren. Mit diesem Befehl können Sie das Verhalten eines Konnektors aktualisieren, indem Sie erlauben, dass einige der Einstellungen für einen bestimmten ThingWorx Flow Server angepasst werden können. Dieser Befehl enthält die folgenden Unterbefehle:
•
flow-deploy settings download – Lädt Konnektoreinstellungen aus einer ausgeführten Instanz von ThingWorx Flow herunter.
•
flow-deploy settings file-download – Lädt eine Datei aus einer ausgeführten Instanz von ThingWorx Flow herunter.
•
flow-deploy settings upload – Lädt Konnektoreinstellungen in eine ausgeführte Instanz von ThingWorx Flow hoch.
•
flow-deploy settings file-upload – Lädt eine Datei in eine ausgeführte Instanz von ThingWorx Flow hoch.
Die folgenden Parameter sind für alle Unterbefehle des Befehls flow-deploy settings allgemein:
|
Parameter
|
Beschreibung
|
Datentypen
|
|---|---|---|
|
--username,-u
|
Benutzername des ThingWorx Administrators
|
[String]
|
|
--password,-p
|
Passwort des ThingWorx Administrators
|
[String]
|
|
--app-key,-a
|
ThingWorx Anwendungsschlüssel
|
[String]
|
|
--twx-url,-t
|
ThingWorx Basis-URL im Format https://<Hostname:Port>/Thingworx.
|
[String]
|
|
--connector,-c
|
Konnektorname
|
[String]
|
|
--file,-f
|
Pfad zur Datei mit den Konnektoreinstellungen
|
[String]
|
|
--systemid,-s
|
Benutzerdefinierte System-ID
|
[String]
|
|
--default, -d
|
Standard-System-ID
|
[String]
|
flow-deploy settings download
Lädt Konnektoreinstellungen aus einer ausgeführten Instanz von ThingWorx Flow herunter.
Um beispielsweise die Konfigurationseinstellungen für einen angegebenen Konnektor auf dem ThingWorx Flow Server herunterzuladen, führen Sie den folgenden Befehl aus:
flow-deploy settings download -f <Pfad zur Datei mit den Konnektoreinstellungen> -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -c <Name des Konnektors> -s <Benutzerdefinierte System-ID>
flow-deploy settings file-download
Lädt eine Datei aus einer ausgeführten Instanz von ThingWorx Flow herunter.
Zusätzlich zu den allgemeinen Parametern für alle Unterbefehle des Befehls flow-deploy settings akzeptiert dieser Befehl den folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--fileId
|
Datei-ID der Datei, die Sie hochladen möchten. Dieser Name ist in der Definitionsdatei für die Konnektoreinstellungen verfügbar.
|
[String]
|
Die Syntax des Befehls flow-deploy settings file-download lautet folgendermaßen:
flow-deploy settings file-download -f <Pfad zu Anpassungsdatei> -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -c <Konnektorname> -s <Benutzerdefinierte System-ID> –fileID <ID der Datei für Upload>
flow-deploy settings upload
Lädt die Konnektoreinstellungen in eine ausgeführte Instanz von ThingWorx Flow hoch.
|
|
Bevor Sie diesen Befehl ausführen, erstellen Sie eine JSON-Datei mit Konfigurationseinstellungen, und verwenden Sie den Parameter -f, um den Pfad zu dieser Datei anzugeben. Wenn die Einstellungen in dieser Datei mit dem Schema übereinstimmen, werden die Einstellungen erfolgreich hochgeladen. Andernfalls erhalten Sie eine Fehlermeldung, die das erforderliche Schema bereitstellt.
|
Betrachten Sie die folgenden Beispiele:
◦ Um Einstellungen für einen angegebenen Konnektor mit einer benutzerdefinierten System-ID auf den ThingWorx Flow Server hochzuladen, führen Sie den folgenden Befehl aus:
flow-deploy settings upload -f <Pfad zur Datei mit den Konnektoreinstellungen> -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -c <Name des Konnektors> -s <Benutzerdefinierte System-ID>
◦ Um Einstellungen für einen angegebenen Konnektor mit der Standardsystem-ID auf den ThingWorx Flow Server hochzuladen, führen Sie den folgenden Befehl aus:
flow-deploy settings upload -f <Pfad zur Datei mit den Konnektoreinstellungen> -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -c <Name des Konnektors> -d
flow-deploy settings file-upload
Lädt die Datei in eine ausgeführte Instanz von ThingWorx Flow hoch.
Zusätzlich zu den allgemeinen Parametern für alle Unterbefehle des Befehls flow-deploy settings akzeptiert dieser Befehl die folgenden Parameter:
|
Parameter
|
Beschreibung
|
Datentyp
|
|---|---|---|
|
--fileId
|
Datei-ID der Datei, die Sie hochladen möchten. Dieser Name ist in der Definitionsdatei für die Konnektoreinstellungen verfügbar.
|
[String]
|
|
--contentType
|
Inhaltstyp der Datei
|
[String]
|
Beispiel: flow-deploy settings file-upload -f <Pfad zu Anpassungsdatei> -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -c <Konnektorname> -s <Benutzerdefinierte System-ID> –fileID <ID der Datei für Upload> --contentType <Inhaltstyp>