ThingWorx Flow > ThingWorx Flow SDK > Konnektorprojekt
Konnektorprojekt
Ein Konnektorprojekt entspricht einem Konnektor eines Systems, der bestimmte Integrationsfunktionen logisch gruppiert. Mehrere Versionen der Artefakte, die der Funktionengruppe zugeordnet sind, sind in einem einzigen Projekt enthalten. Neben den Testartefakten im Projekt gibt es Artefakte für Anpassung und Lokalisierung.
Konnektorinformationen werden in einem Projekt in einer Struktur gespeichert und verarbeitet.
Um ein neues Projekt zu erstellen, führen Sie folgenden Befehl in Ihrer Eingabeaufforderung aus:
flow init <user project root directory>
Hiermit wird ein neues Konnektorprojekt im angegebenen Verzeichnis erstellt. Wenn kein Verzeichnisname angegeben wird, erstellt die Befehlszeilenschnittstelle ein Projekt unter dem aktuellen Verzeichnis.
Die Optionen für den Befehl init werden in der folgenden Tabelle aufgeführt:
Optionen
Beschreibung
Datentyp
--help
Zeigt die Hilfe an.
[Boolean]
--parentDir, -d
Das Elternverzeichnis für das Projekt.
[Standardwert: "."]
--logLevel, -1
Legt die Protokollebene fest.
[Standardwert: "info"]
Der Befehl init erstellt einen Ordner, der die folgenden Komponenten enthält:
Ordner lib
Ordner test
Ordner package.json
Ordner index.js
Die Eigenschaften der Datei package.json werden in der Tabelle beschrieben:
package.json
Eigenschaft
Beschreibung
name
Besteht aus beliebigen Zeichen, die in Dateinamen gültig sind. Der Name sollte vorzugsweise der Name des Diensts sein, mit dem der Konnektor interagiert. Als Suffix sollte "-connector" verwendet werden, um anzugeben, dass es sich um einen ThingWorx Flow Konnektor handelt. Der Name sollte das folgende Format haben:
<ptc-servicename-connector>
Der Parameter servicename darf keine Sonderzeichen außer einem Unterstrich (_) enthalten.
Beispielsweise muss der Name des ThingWorx Flow Konnektors im Paketnamen "ptc-thingworx-connector" lauten.
description
Geben Sie eine passende Beschreibung für das Paket ein, wie in den Suchergebnissen aufgeführt.
scripts
Dies ist ein Wörterbuch mit Skriptbefehlen, die zu verschiedenen Zeitpunkten im Lebenszyklus des Konnektors ausgeführt werden.
Führen Sie den folgenden Befehl zum Ausführen von Testskripts aus:
npm test
Führen Sie den folgenden Befehl zum Ausführen von benutzerdefinierten Skripts aus:
npm run <script name>
Weitere Informationen zu Skripts finden Sie auf der Website npm-scripts.
dependencies
Andere NPM-Pakete, die der Konnektor in seinem Code verwendet, wenn die Artefakte zur Laufzeit gestartet werden.
"ptc-flow-sdk" ist eine erforderliche Abhängigkeit.
Entfernen Sie die Abhängigkeit "ptc-flow-sdk" nicht, da ThingWorx Flow den Konnektor ansonsten möglicherweise nicht laden kann.
Weitere Informationen zu Abhängigkeiten finden Sie im Abschnitt zu Abhängigkeiten auf der npm-Website.
devDependencies
Wird während der Entwicklungsphase verwendet. Sie können in den devDependencies zusätzliche npm-Pakete zuordnen, die nur beim Testen des Konnektors verwendet werden.
Weitere Informationen finden Sie im Abschnitt "devDependencies" auf der Website npmjs.
War dies hilfreich?