Implementación de conectores
Después de crear y probar el conector localmente, se puede implementar en una instancia de prueba local de ThingWorx Flow. Para implementar el conector en el servidor ThingWorx Flow, realice los siguientes pasos:
1. En el proyecto del conector, ejecute el comando npm install.
De este modo, se instalan todos los paquetes necesarios para el conector.
2. Inicie el símbolo del sistema y ejecute el siguiente comando:
flow-deploy connector -s <Directorio_raíz_del_proyecto_del_conector> -t <Directorio_de_instalación_de_ThingWorx_Flow>
Este comando realiza las siguientes tareas:
a. Permite copiar los metadatos del elemento en el fichero de carga de base de datos.
b. Permite implementar iconos en la ubicación de tiempo de ejecución.
c. Permite copiar el código de conector en la ubicación de tiempo de ejecución para los conectores.
3. Para cargar los metadatos del elemento implementado en ThingWorx Flow, ejecute el siguiente comando:
flow-deploy migrate
4. Navegue hasta > > para reiniciar el servicio ThingWorx Flow.
El usuario debe poder crear flujos con conexiones, acciones y activadores desde el conector.
flow-deploy
El comando flow-deploy tiene los siguientes subcomandos:
•
flow-deploy connector: permite implementar elementos de conector en una instalación local de ThingWorx Flow.
•
flow-deploy migrate: permite cargar metadatos de elementos implementados en el servidor ThingWorx Flow.
•
flow-deploy oauths <command>: se proporcionan acciones relacionadas de OAuth.
 |
Se recomienda utilizar los
servicios de OAuth en WorkflowSubsystem en ThingWorx Composer para cargar o borrar elementos OAuth.
|
•
flow-deploy settings <command>: permite cargar o descargar la configuración del conector.
Todos los subcomandos del comando flow-deploy aceptan los siguientes parámetros:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--log,-l
|
Permite definir el nivel de registro.
|
[Cadena] [por defecto: "info"]
|
|
--version
|
Permite mostrar el número de versión de ThingWorx Flow Deploy Utility.
|
[Booleano]
|
|
--help
|
Permite mostrar ayuda para distintos comandos, subcomandos y parámetros que se pueden proporcionar al comando.
|
[Booleano]
|
flow-deploy about
Permite imprimir la información sobre la versión de ThingWorx Flow Deploy Utility. La sintaxis y la salida del comando flow-deploy about son las siguientes:
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
Permite implementar el paquete del conector personalizado en el directorio de instalación de ThingWorx Flow y actualizar scripts de carga para incluir metadatos sobre los elementos personalizados del conector, tales como las conexiones, las acciones, etc.
El comando flow-deploy connector acepta los siguientes parámetros:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--sourceDir,-s
(Obligatorio)
|
Directorio raíz del proyecto de conector personalizado.
|
[Cadena]
|
|
--targetDir,-t
(Obligatorio)
|
La ruta por defecto del directorio de instalación de ThingWorx Flow es C:\ThingWorxOrchestration.
|
[Cadena]
|
|
--allow_schema_overwrite
|
La herramienta flow-deploy no permite sobrescribir las propiedades del esquema de entrada y salida que se encuentran en los ficheros metadatos JSON de una acción, una conexión y un activador existentes. Si se permitiera, se romperían los flujos creados con el esquema anterior. Sin embargo, durante el desarrollo, se pueden sobrescribir las propiedades del esquema de entrada y salida. Defina este señalizador para sobrescribir el esquema existente con el nuevo esquema del proyecto del conector.
|
-
|
La sintaxis del comando flow-deploy connector es la siguiente:
flow-deploy connector --sourceDir <Directorio_raíz_del_proyecto_del_conector> --targetDir <Directorio_de_instalación_de_ThingWorx_Flow>
flow-deploy migrate
Este comando permite cargar los metadatos del conector en el servidor ThingWorx Flow.
El comando flow-deploy migrate acepta los siguientes parámetros:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--sourceDir,-s
(Obligatorio)
|
La ruta por defecto del directorio de instalación de ThingWorx Flow es C:\ThingWorxOrchestration.
|
[Cadena]
|
|
--Database username, -u
(Obligatorio)
|
Nombre de usuario de la base de datos de ThingWorx Flow.
|
[Cadena]
|
|
--Database password, -p
(Obligatorio)
|
Contraseña de la base de datos de ThingWorx Flow.
|
-
|
La sintaxis del comando flow-deploy migrate es la siguiente:
flow-deploy migrate --sourceDir <Directorio_de_instalación_de_ThingWorx> -u <Nombre_de_usuario_de_base_de_datos_de_ThingWorx_Flow> -p <Contraseña_de_usuario_de_base_de_datos_de_ThingWorx_Flow>
flow-deploy oauths
Este comando permite trabajar con configuraciones de OAuth. Este comando tiene dos subcomandos:
•
flow-deploy oauths load: permite cargar configuraciones de OAuth en una instancia en ejecución de ThingWorx Flow.
•
flow-deploy oauths delete: permite borrar la configuración de OAuth de una instancia en ejecución de ThingWorx Flow.
|
|
Se recomienda utilizar los
servicios de OAuth en WorkflowSubsystem en ThingWorx Composer para cargar o borrar elementos OAuth.
|
Los siguientes parámetros son comunes en todos los subcomandos del comando flow-deploy oauths:
|
Parámetro
|
Descripción
|
Tipos de datos
|
|---|---|---|
|
--username,-u
|
Nombre de usuario del administrador de ThingWorx
|
[Cadena]
|
|
--password,-p
|
Contraseña del administrador de ThingWorx
|
[Cadena]
|
|
--app-key,-a
|
Clave de aplicación de ThingWorx
|
[Cadena]
|
|
--twx-url,-t
|
URL base de ThingWorx con el formato https://<nombreHost:puerto>/Thingworx.
|
[Cadena]
|
flow-deploy oauths load
Este comando permite cargar configuraciones de OAuth en una instancia en ejecución de ThingWorx Flow.
Para obtener instrucciones sobre la carga de OAuth para conectores, consulte
Configuración de los valores de OAuth de conector.
Además de los parámetros comunes en todos los subcomandos del comando flow-deploy oauths, este comando acepta el siguiente parámetro:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--file, -f
|
Nombre del fichero de datos de configuración de OAuth
|
[Cadena]
|
La sintaxis del comando flow-deploy oauths load es la siguiente:
flow-deploy oauths load -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' --twx-url <URL_base_de_ThingWorx> -f <Ruta_del_fichero_de_configuración_de_OAuth>
donde <URL_base_de_ThingWorx> debe estar en el formato https://<nombreHost:puerto>/Thingworx.
flow-deploy oauths delete
Este comando se utiliza para borrar una configuración existente de ThingWorx Flow. Si se borran configuraciones de OAuth, es necesario volver a crear la conexión en los flujos.
Además de los parámetros comunes en todos los subcomandos del comando flow-deploy oauths, este comando acepta el siguiente parámetro:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--name, -n
(Obligatorio)
|
Nombre del conector. Este nombre está disponible en el fichero de configuración de OAuth.
|
[Cadena]
|
|
--title
(Obligatorio)
|
Título del proveedor de OAuth. Este título está disponible en el fichero de configuración de OAuth.
|
[Cadena]
|
La sintaxis del comando flow-deploy oauths delete es la siguiente:
flow-deploy oauths delete -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' --twx-url <URL_base_de_ThingWorx> -n <Nombre_del_conector> --title <Título_del_proveedor_de_OAuth>
donde <URL_base_de_ThingWorx> debe estar en el formato https://<nombreHost:puerto>/Thingworx.
Por ejemplo, para borrar el conector "box" de OAuth con título "Box", ejecute el siguiente comando:
flow-deploy oauths delete -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' --twx-url <URL_base_de_ThingWorx> -n box --title Box
donde <URL_base_de_ThingWorx> debe estar en el formato https://<nombreHost:puerto>/Thingworx.
flow-deploy settings
Se pueden configurar varios clientes para un único conector. Este comando permite actualizar el funcionamiento de un conector, ya que permite la personalización de algunas de sus opciones de configuración para un servidor ThingWorx Flow determinado. Este comando tiene los siguientes subcomandos:
•
flow-deploy settings download: permite descargar la configuración de conector de una instancia en ejecución de ThingWorx Flow.
•
flow-deploy settings file-download: permite descargar un fichero de una instancia en ejecución de ThingWorx Flow.
•
flow-deploy settings upload: permite cargar la configuración de conector en una instancia en ejecución de ThingWorx Flow.
•
flow-deploy settings file-upload: permite cargar un fichero en una instancia en ejecución de ThingWorx Flow.
Los siguientes parámetros son comunes en todos los subcomandos del comando flow-deploy settings:
|
Parámetro
|
Descripción
|
Tipos de datos
|
|---|---|---|
|
--username,-u
|
Nombre de usuario del administrador de ThingWorx
|
[Cadena]
|
|
--password,-p
|
Contraseña del administrador de ThingWorx
|
[Cadena]
|
|
--app-key,-a
|
Clave de aplicación de ThingWorx
|
[Cadena]
|
|
--twx-url,-t
|
URL base de ThingWorx con el formato https://<nombreHost:puerto>/Thingworx.
|
[Cadena]
|
|
--connector,-c
|
Nombre de conector
|
[Cadena]
|
|
--file,-f
|
Ruta al fichero de configuración del conector
|
[Cadena]
|
|
--systemid,-s
|
ID del sistema personalizado
|
[Cadena]
|
|
--default, -d
|
ID del sistema por defecto
|
[Cadena]
|
flow-deploy settings download
Permite descargar la configuración de conector de una instancia en ejecución de ThingWorx Flow.
Por ejemplo, para descargar las opciones de configuración de un conector especificado en el servidor ThingWorx Flow, ejecute el siguiente comando:
flow-deploy settings download -f <Ruta_al_fichero_de_configuración_del_conector> -t <URL_de_ThingWorx_Base> -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' -c <Nombre_de_conector> -s <ID_de_sistema_personalizado>
flow-deploy settings file-download
Permite descargar un fichero de una instancia en ejecución de ThingWorx Flow.
Además de los parámetros comunes en todos los subcomandos del comando flow-deploy settings, este comando acepta el siguiente parámetro:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--fileId
|
ID de fichero del fichero que desea cargar. Este nombre está disponible en el fichero de definición de la configuración del conector.
|
[Cadena]
|
La sintaxis del comando flow-deploy settings file-download es la siguiente:
flow-deploy settings file-download -f <Ruta_al_fichero_de_personalización> -t <URL_de_ThingWorx_Base> -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' -c <Nombre_de_conector> -s <ID_de_sistema_personalizado> –fileID <ID_del_fichero_para_cargar>
flow-deploy settings upload
Permite cargar la configuración de conector en una instancia en ejecución de ThingWorx Flow.
|
|
Antes de ejecutar este comando, cree un fichero JSON de opciones de configuración y utilice el parámetro -f para proporcionar la ruta a este fichero. Si la configuración de este fichero coincide con el esquema, significa que se ha cargado correctamente. De lo contrario, aparece un mensaje de error en el que se proporciona el esquema necesario.
|
Se deben tener en cuenta los siguientes ejemplos:
◦ Para cargar la configuración en el servidor ThingWorx Flow para un conector determinado con un ID del sistema personalizado, ejecute el siguiente comando:
flow-deploy settings upload -f <Ruta_al_fichero_de_configuración_del_conector> -t <URL_de_ThingWorx_Base> -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' -c <Nombre_de_conector> -s <ID_de_sistema_personalizado>
◦ Para cargar la configuración en el servidor ThingWorx Flow para un conector determinado con el ID del sistema por defecto, ejecute el siguiente comando:
flow-deploy settings upload -f <Ruta_al_fichero_de_configuración_del_conector> -t <URL_de_ThingWorx_Base> -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' -c <Nombre_de_conector> -d
flow-deploy settings file-upload
Permite cargar el fichero en una instancia en ejecución de ThingWorx Flow.
Además de los parámetros comunes en todos los subcomandos del comando flow-deploy settings, este comando acepta los siguientes parámetros:
|
Parámetro
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--fileId
|
ID de fichero del fichero que desea cargar. Este nombre está disponible en el fichero de definición de la configuración del conector.
|
[Cadena]
|
|
--contentType
|
Tipo de contenido del fichero.
|
[Cadena]
|
Por ejemplo, flow-deploy settings file-upload -f <Ruta_al_fichero_de_personalización> -t <URL_de_ThingWorx_Base> -u <Nombre_de_usuario_administrador_de_ThingWorx> -p '<Contraseña_de_administrador_de_ThingWorx>' -c <Nombre_de_conector> -s <ID_de_sistema_personalizado> –fileID <ID_del_fichero_para_cargar> --contentType <Tipo_de_contenido>