Projet de connecteur
Un projet de connecteur définit un connecteur d'un système qui regroupe logiquement un certain nombre de fonctionnalités d'intégration. Plusieurs versions des artefacts associés au groupe de fonctionnalités existent dans le même projet. Des artefacts pour la personnalisation ainsi que pour la localisation coexistent dans le projet avec les artefacts de test.
Les informations du connecteur sont stockées et gérées dans le projet au sein d'une structure.
Pour créer un nouveau projet, exécutez la commande suivante depuis votre invite de commande :
flow init <user project root directory>
Cette commande crée un nouveau projet de connecteur dans le répertoire spécifié. Si aucun nom de répertoire n'est fourni, la CLI crée le projet dans le répertoire actif.
Les options pour la commande init s'affichent dans le tableau ci-dessous :
|
Options
|
Description
|
Type de données
|
|---|---|---|
|
--help
|
Affiche l'aide.
|
[booléen]
|
|
--parentDir, -d
|
Répertoire parent du projet.
|
[par défaut : "."]
|
|
--logLevel, -1
|
Définit le niveau de consignation.
|
[par défaut : "info"]
|
La commande init crée un dossier qui contient les éléments suivants :
• Dossier lib
• Dossier test
• Fichier package.json
• Fichier index.js
Les propriétés du fichier package.json sont décrites dans le tableau :
|
package.json
|
|---|
 |
|
Propriété
|
Description
|
|---|---|
|
name
|
Nom composé de tout caractère valide dans les noms de fichiers. Il est préférable que ce nom corresponde à celui du service avec lequel le connecteur interagira. Adjoignez-lui le suffixe –connector pour indiquer qu'il s'agit d'un connecteur ThingWorx Flow. Le nom présentera le format suivant :
<ptc-nomservice-connector>
A l'exception du trait de soulignement (_), servicename ne peut contenir aucun caractère spécial.
Par exemple, le connecteur ThingWorx Flow doit être nommé ptc-thingworx-connector dans le nom du package.
|
|
description
|
Donnez une description appropriée du package, qui apparaîtra dans les résultats de recherche.
|
|
scripts
|
Dictionnaire contenant des commandes de scripts exécutées à différents moments du cycle de vie du connecteur.
• Pour exécuter les scripts de test, exécutez la commande suivante :
npm test
• Pour exécuter un script personnalisé, exécutez la commande suivante :
npm run <script name>
|
|
dependencies
|
Autres packages NPM que le connecteur utilise dans son code lorsque les artefacts sont appelés à l'exécution.
ptc-flow-sdk est une dépendance obligatoire.
Ne supprimez pas la dépendance ptc-flow-sdk, sans laquelle ThingWorx Flow pourra être dans l'impossibilité de charger le connecteur.
|
|
devDependencies
|
Utilisée pendant la phase de développement. Vous pouvez mapper des packages npm supplémentaires uniquement destinés au test du connecteur dans les devDependencies.
|