Déploiement des connecteurs
Une fois que vous avez généré et testé le connecteur localement, vous pouvez le déployer sur une instance de test sur site de ThingWorx Flow. Pour déployer votre connecteur sur le serveur ThingWorx Flow, procédez comme suit :
1. Dans votre projet de connecteur, exécutez la commande npm install.
Cette opération installe tous les packages requis par le connecteur.
2. Démarrez l'invite de commande et exécutez la commande suivante :
flow-deploy connector -s <Répertoire_racine_projet_connecteur> -t <Répertoire_installation_ThingWorx_Flow>
Cette commande effectue les tâches suivantes :
a. Copie des métadonnées d'artefact dans le fichier de chargement de la base de données.
b. Déploiement des icônes à l'emplacement d'exécution.
c. Copie du code de connecteur à l'emplacement d'exécution des connecteurs.
3. Pour charger les métadonnées des artefacts déployés dans ThingWorx Flow, exécutez la commande suivante :
flow-deploy migrate
4. Accédez à > > pour redémarrer le service ThingWorx Flow.
Vous devriez pouvoir créer des flux avec les connexions, actions et déclencheurs de votre connecteur.
flow-deploy
La commande flow-deploy offre les sous-commandes suivantes :
•
flow-deploy connector : déploie les artefacts de connecteur sur une installation locale de ThingWorx Flow.
•
flow-deploy migrate : charge les métadonnées des artefacts déployés sur le serveur ThingWorx Flow.
 |
Il est recommandé d'utiliser les
services OAuth dans le WorkflowSubsystem dans ThingWorx Composer pour charger ou supprimer des OAuths.
|
•
flow-deploy settings <commande> : charge ou télécharge les paramètres du connecteur.
Toutes les sous-commandes de la commande flow-deploy acceptent les paramètres suivants :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--log,-l
|
Définit le niveau de consignation.
|
[Chaîne] [par défaut : "info"]
|
|
--version
|
Affiche le numéro de version de ThingWorx Flow Deploy Utility.
|
[Booléen]
|
|
--help
|
Affiche l'aide des commandes, sous-commandes et paramètres pouvant être utilisés avec la commande.
|
[Booléen]
|
flow-deploy about
Imprime les informations de version de ThingWorx Flow Deploy Utility. La syntaxe et la sortie de la commande flow-deploy about est la suivante :
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
Déploie le package de connecteur personnalisé dans le répertoire d'installation de ThingWorx Flow, puis met à jour les scripts de chargement de façon à inclure des métadonnées concernant les artefacts du connecteur personnalisé, comme des connexions, des actions, etc.
La commande flow-deploy connector accepte les paramètres suivants :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--sourceDir,-s
(Obligatoire)
|
Répertoire racine du projet de connecteur personnalisé.
|
[Chaîne]
|
|
--targetDir,-t
(Obligatoire)
|
Répertoire d'installation de ThingWorx Flow, C:\ThingWorxOrchestration par défaut.
|
[Chaîne]
|
|
--allow_schema_overwrite
|
L'outil flow-deploy n'autorise pas l'écrasement des propriétés des schémas d'entrée et de sortie des fichiers de métadonnées JSON d'une action, d'une connexion et d'un déclencheur existants. Si cela était autorisé, tous les flux créés à l'aide de l'ancien schéma seraient interrompus. Toutefois, au cours du développement, vous pouvez remplacer les propriétés des schémas d'entrée et de sortie. Définissez cet indicateur pour remplacer le schéma existant par le nouveau schéma du projet de connecteur.
|
-
|
La syntaxe de la commande flow-deploy connector est la suivante :
flow-deploy connector --sourceDir <Répertoire_racine_projet_connecteur> --targetDir <Répertoire_installation_ThingWorx_Flow>
flow-deploy migrate
Cette commande charge les métadonnées du connecteur sur le serveur ThingWorx Flow.
La commande flow-deploy migrate accepte les paramètres suivants :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--sourceDir,-s
(Obligatoire)
|
Répertoire d'installation de ThingWorx Flow, C:\ThingWorxOrchestration par défaut.
|
[Chaîne]
|
|
--Database username, -u
(Obligatoire)
|
Nom d'utilisateur de la base de données ThingWorx Flow.
|
[Chaîne]
|
|
--Database password, -p
(Obligatoire)
|
Mot de passe de la base de données ThingWorx Flow.
|
-
|
La syntaxe de la commande flow-deploy migrate est la suivante :
flow-deploy migrate --sourceDir <Répertoire_installation_ThingWorx_Flow> -u <Nom_utilisateur_base_données_ThingWorx_Flow> -p <Mot de passe_base_données_ThingWorx_Flow>
flow-deploy oauths
Cette commande vous permet de travailler avec des configurations OAuth. Elle comporte deux sous-commandes :
•
flow-deploy oauths load : charge les configurations OAuth dans une instance en cours d'exécution de ThingWorx Flow.
•
flow-deploy oauths delete : supprime la configuration OAuth d'une instance en cours d'exécution de ThingWorx Flow.
|
|
Il est recommandé d'utiliser les
services OAuth dans le WorkflowSubsystem dans ThingWorx Composer pour charger ou supprimer des OAuths.
|
Les paramètres suivants sont communs à toutes les sous-commandes de la commande flow-deploy oauths :
|
Paramètre
|
Description
|
Types de données
|
|---|---|---|
|
--username,-u
|
Nom d'utilisateur de l'administrateur ThingWorx
|
[Chaîne]
|
|
--password,-p
|
Mot de passe administrateur ThingWorx
|
[Chaîne]
|
|
--app-key,-a
|
Clé d'application ThingWorx
|
[Chaîne]
|
|
--twx-url,-t
|
URL de base ThingWorx au format https://<nomHôte:port>/Thingworx.
|
[Chaîne]
|
flow-deploy oauths load
Cette commande charge les configurations OAuth sur une instance en cours d'exécution de ThingWorx Flow.
Pour obtenir des instructions concernant le chargement OAuth pour les connecteurs, consultez la rubrique
Configuration des paramètres OAuth des connecteurs.
Outre les paramètres communs de toutes les sous-commandes de la commande flow-deploy oauths, cette commande accepte le paramètre suivant :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--file, -f
|
Nom du fichier de données de configuration OAuth
|
[Chaîne]
|
La syntaxe de la commande flow-deploy oauths load est la suivante :
flow-deploy oauths load -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' --twx-url <URL_de_base_ThingWorx> -f <Chemin_vers_fichier_configuration_OAuth>
où <URL_de_base_ThingWorx> doit respecter le format https://<nonHôte:port>/Thingworx.
flow-deploy oauths delete
Cette commande sert à supprimer une configuration existante de ThingWorx Flow. Si vous supprimez les configurations OAuth, vous devrez recréer la connexion dans les flux.
Outre les paramètres communs de toutes les sous-commandes de la commande flow-deploy oauths, cette commande accepte le paramètre suivant :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--name, -n
(Obligatoire)
|
Nom du connecteur. Ce nom est disponible dans le fichier de configuration OAuth.
|
[Chaîne]
|
|
--title
(Obligatoire)
|
Titre du fournisseur OAuth-provider. Ce titre est disponible dans le fichier de configuration OAuth.
|
[Chaîne]
|
La syntaxe de la commande flow-deploy oauths delete est la suivante :
flow-deploy oauths delete -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' --twx-url <URL_de_base_ThingWorx> -n <Nom_connecteur> --title <Titre_fournisseur_OAuth>
où <URL_de_base_ThingWorx> doit respecter le format https://<nonHôte:port>/Thingworx.
Par exemple, pour supprimer OAuth pour le connecteur "Box" dont le titre est "Box, exécutez la commande suivante :
flow-deploy oauths delete -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' --twx-url <URL_de_base_ThingWorx> -n box --title Box
où <URL_de_base_ThingWorx> doit respecter le format https://<nonHôte:port>/Thingworx.
flow-deploy settings
Vous pouvez configurer plusieurs locataires pour un même connecteur. Cette commande vous permet de mettre à jour le comportement d'un connecteur en autorisant la personnalisation de certains de ses paramètres pour un serveur ThingWorx Flow particulier. Cette commande offre les sous-commandes suivantes :
•
flow-deploy settings download : télécharge les paramètres d'un connecteur à partir d'une instance en cours d'exécution de ThingWorx Flow.
•
flow-deploy settings file-download : télécharge un fichier à partir d'une instance en cours d'exécution de ThingWorx Flow.
•
flow-deploy settings upload : charge les paramètres d'un connecteur sur une instance en cours d'exécution de ThingWorx Flow.
•
flow-deploy settings file-upload : charge un fichier sur une instance en cours d'exécution de ThingWorx Flow.
Les paramètres suivants sont communs à toutes les sous-commandes de la commande flow-deploy settings :
|
Paramètre
|
Description
|
Types de données
|
|---|---|---|
|
--username,-u
|
Nom d'utilisateur de l'administrateur ThingWorx
|
[Chaîne]
|
|
--password,-p
|
Mot de passe administrateur ThingWorx
|
[Chaîne]
|
|
--app-key,-a
|
Clé d'application ThingWorx
|
[Chaîne]
|
|
--twx-url,-t
|
URL de base ThingWorx au format https://<nomHôte:port>/Thingworx.
|
[Chaîne]
|
|
--connector,-c
|
Nom du connecteur
|
[Chaîne]
|
|
--file,-f
|
Chemin du fichier des paramètres du connecteur
|
[Chaîne]
|
|
--systemid,-s
|
ID système personnalisé
|
[Chaîne]
|
|
--default, -d
|
ID système par défaut
|
[Chaîne]
|
flow-deploy settings download
Télécharge les paramètres d'un connecteur à partir d'une instance en cours d'exécution de ThingWorx Flow.
Par exemple, pour télécharger les paramètres de configuration d'un connecteur spécifié sur le serveur ThingWorx Flow, exécutez la commande suivante :
flow-deploy settings download -f <Chemin_fichier_paramètres_connecteur> -t <URL_de_base_ThingWorx> -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' -c <Nom_connecteur> -s <ID_système_personnalisé>
flow-deploy settings file-download
Télécharge un fichier depuis une instance en cours d'exécution de ThingWorx Flow.
Outre les paramètres communs de toutes les sous-commandes de la commande flow-deploy settings, cette commande accepte le paramètre suivant :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--fileId
|
ID du fichier que vous souhaitez charger. Ce nom est disponible dans le fichier de définition des paramètres du connecteur.
|
[Chaîne]
|
La syntaxe de la commande flow-deploy settings file-download est la suivante :
flow-deploy settings file-download -f <Chemin_fichier_personnalisation> -t <URL_de_base_ThingWorx> -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' -c <Nom_connecteur> -s <ID_système_personnalisé> –fileID <ID_fichier_charger>
flow-deploy settings upload
Charge les paramètres d'un connecteur sur une instance en cours d'exécution de ThingWorx Flow.
|
|
Avant d'exécuter cette commande, créez un fichier JSON de paramètres de configuration et utilisez le paramètre -f pour indiquer le chemin d'accès à ce fichier. Si les paramètres de ce fichier correspondent au schéma, ils sont chargés avec succès ; dans le cas contraire, vous obtenez un message d'erreur indiquant le schéma requis.
|
Prenons les exemples suivants :
◦ Pour charger des paramètres sur le serveur ThingWorx Flow pour un connecteur donné avec un ID système personnalisé, exécutez la commande suivante :
flow-deploy settings upload -f <Chemin_fichier_paramètres_connecteur> -t <URL_de_base_ThingWorx> -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' -c <Nom_connecteur> -s <ID_système_personnalisé>
◦ Pour charger des paramètres sur le serveur ThingWorx Flow pour un connecteur donné avec un ID système par défaut, exécutez la commande suivante :
flow-deploy settings upload -f <Chemin_fichier_paramètres_connecteur> -t <URL_de_base_ThingWorx> -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' -c <Nom_connecteur> -d
flow-deploy settings file-upload
Charge un fichier sur une instance en cours d'exécution de ThingWorx Flow.
Outre les paramètres communs de toutes les sous-commandes de la commande flow-deploy settings, cette commande accepte les paramètres suivants :
|
Paramètre
|
Description
|
Type de données
|
|---|---|---|
|
--fileId
|
ID du fichier que vous souhaitez charger. Ce nom est disponible dans le fichier de définition des paramètres du connecteur.
|
[Chaîne]
|
|
--contentType
|
Type de contenu du fichier.
|
[Chaîne]
|
Par exemple, flow-deploy settings file-upload -f <Chemin_fichier_personnalisation> -t <URL_de_base_ThingWorx> -u <Nom_utilisateur_administrateur_ThingWorx> -p '<Mot_de_passe_administrateur_ThingWorx>' -c <Nom_connecteur> -s <ID_système_personnalisé> –fileID <ID_fichier_charger> --contentType <Type_contenu>