Création de connexions
Certains systèmes peuvent ne pas prendre en charge le mécanisme OAuth. Ils peuvent utiliser d'autres mécanismes d'authentification, tels qu'une authentification de base avec un nom d'utilisateur et un mot de passe, ou prendre en charge un mécanisme à base de clé. Des connexions doivent être définies pour tous les systèmes qui ne prennent pas en charge le mécanisme OAuth.
Pour créer une nouvelle connexion, procédez comme suit :
1. A l'invite de commande, exécutez les commandes suivantes :
a. cd <user project root directory>
b. flow add connection <name>
Votre connexion sera au format <service-name>-<connection-name>.
Le nom du service est automatiquement ajouté par la CLI. Un nouveau dossier nommé nom connecteur-nom connexion est créé dans votre répertoire local, contenant le fichier connection.json ainsi que le fichier index.js.
Les options suivantes sont disponibles pour la commande :
|
Options
|
Description
|
Type de données
|
|---|---|---|
|
--version
|
Affiche le numéro de version.
|
[booléen]
|
|
--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"]
|
|
--artifactVersion,-v
|
Version de l'artefact à créer.
|
[par défaut : "v1"]
|
2. Déterminez les informations à collecter pour la connexion au système.
 |
Il peut s'agir d'une URL, d'un nom d'utilisateur, d'un mot de passe ou d'une clé d'application (ou de toute autre information requise pour la connexion au système).
|
Les informations ci-dessus doivent être exprimées sous forme de schéma JSON dans le fichier connection.json. ThingWorx Flow utilise ces informations pour afficher le formulaire dans l'éditeur de processus ThingWorx Flow.
Un fichier index.js convertit les informations stockées en un formulaire utilisable par les actions et déclencheurs. Ces informations renvoyées par le formulaire sont cryptées et stockées dans la base de données ThingWorx Flow.
Voici à quoi ressemblent le schéma formaté (fichier connection.json) et le formulaire d'entrée :
Le tableau ci-dessous décrit les propriétés utilisées dans le schéma JSON.
Propriétés | Définissez la propriété du fichier JSON. |
|---|---|
type | Le type de niveau supérieur doit toujours être défini sur "object". |
title | Utilisé comme intitulé de la fenêtre d'authentification sur la page d'accueil ThingWorx Flow. |
format | Disposition utilisée pour l'affichage du formulaire sur le canevas ThingWorx Flow. |
properties | Attributs acquis auprès des utilisateurs pour authentifier le système cible. Peut contenir un nombre quelconque d'attributs enfants. Tous les attributs enfants doivent posséder un titre, un type et une description. Tout type pris en charge par le schéma JSON peut être utilisé. Dans notre exemple, les attributs acquis pour la connexion au système sont les suivants : email, subscription_id, account_url et API token. |
Contrat
Le fichier JavaScript index.js doit exporter un objet JavaScript contenant deux méthodes :
• connect : convertit l'entrée en un formulaire utilisable par les actions, déclencheurs et lookups.
• validate : utilisée pour valider la connexion. Typiquement, vous vous connectez au système cible à l'aide d'une API, telle que la bibliothèque npm request.
Pour plus d'informations sur les API utilisables dans les connexions, consultez la section
SDK des connecteurs ThingWorx Flow.
Pour plus d'informations sur le formatage des schémas d'entrée et de sortie, consultez la note figurant à la rubrique
Création d'actions.
La vidéo suivante montre la création d'un connecteur à l'aide de la CLI de ThingWorx Flow.