Creación de conexiones
Puede que algunos sistemas no soporten el mecanismo de OAuth. Pueden utilizar otros mecanismos para la autenticación, como la autenticación básica con un nombre de usuario y contraseña, o pueden soportar un mecanismo basado en clave. Es necesario definir conexiones para todos los sistemas que no soporten OAuth.
Para crear una nueva conexión, realice lo siguiente:
1. En el símbolo del sistema, ejecute los siguientes comandos:
a. cd <user project root directory>
b. flow add connection <name>
La conexión tendrá el formato <service-name>-<connection-name>
La CLI añade automáticamente el nombre de servicio. Se crea una nueva carpeta, nombre de conector-nombre de conexión, en el directorio local que consta del fichero connection.json y el fichero index.js.
Las siguientes opciones están disponibles para el comando.
|
Opciones
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--version
|
Permite mostrar el número de versión.
|
[booleano]
|
|
--help
|
Permite mostrar la ayuda.
|
[booleano]
|
|
--parentDir,-d
|
El directorio padre del proyecto.
|
[por defecto: "."]
|
|
--logLevel,-1
|
Permite definir el nivel de registro.
|
[por defecto: "info"]
|
|
--artifactVersion,-v
|
Versión del elemento que se va a crear.
|
[por defecto: "v1"]
|
2. Determine la información que se debe recopilar para la conexión al sistema.
 |
La información puede ser en forma de URL, nombre de usuario, contraseña, clave de aplicación o cualquier otra información necesaria para conectarse al sistema.
|
La información anterior se debe expresar como un esquema JSON en el fichero connection.json. ThingWorx Flow utiliza esta información para mostrar el formulario en el editor de flujos de trabajo de ThingWorx Flow.
Un fichero index.js convierte la información almacenada en un formulario que las acciones y los activadores pueden utilizar. Esta información que devuelve el formulario se cifra y almacena en la base de datos de ThingWorx Flow.
El fichero connection.json del esquema con formato y el formulario de entrada aparece de la siguiente manera:
En la siguiente tabla se describen las propiedades que se utilizan en el esquema JSON.
Propiedades | Especifique la propiedad en el fichero JSON. |
|---|---|
type | El tipo de nivel superior siempre debe ser de tipo object. |
title | Se utiliza como título de la ventana de autenticación en la página de inicio de ThingWorx Flow. |
format | El esquema que se utiliza para mostrar el formulario en el lienzo de ThingWorx Flow. |
properties | Se incluyen los atributos que se adquieren de los usuarios para autenticar el sistema de destino. Puede contener cualquier número de atributos hijo. Todos los atributos hijo deben tener un título, tipo y descripción. El tipo puede ser de cualquier tipo soportado por el esquema JSON. Por ejemplo, se puede ver que se necesita un correo electrónico, un ID de suscripción, un URL de cuenta y un token de API para conectarse al sistema. |
Contrato
El fichero JavaScript, como index.js, debe exportar un objeto JavaScript que contenga dos métodos:
• connect: permite convertir la entrada en un formulario adecuado que las acciones, los activadores y las búsquedas puedan consumir.
• validate: se utiliza para validar una conexión. Normalmente, se puede conectar al sistema de destino mediante alguna API, como la biblioteca request de npm.
Para obtener información sobre un SDK de las API que se pueden utilizar en conexiones, consulte la sección SDK de conectores de ThingWorx Flow.
Para obtener información sobre el formato del esquema de entrada y salida, consulte la nota en el tema Creación de acciones.
En el siguiente vídeo se muestra la creación de una conexión con la CLI de ThingWorx Flow.
Para obtener más información sobre la creación de conexiones, consulte el Tutorial del SDK de conectores de ThingWorx Flow.