Proyecto de conector
Un proyecto de conector corresponde a un conector de un sistema que agrupa lógicamente determinada funcionalidad de integración. En un único proyecto se incluyen varias versiones de los elementos asociados al grupo de funcionalidades. Hay elementos para la personalización y localización, además de los elementos de prueba del proyecto.
La información de conector se almacena y controla en un proyecto de una estructura.
Para crear un nuevo proyecto, ejecute el siguiente comando desde el símbolo del sistema:
flow init <user project root directory>
Se crea un nuevo proyecto de conector en el directorio especificado. Si no se proporciona un nombre de directorio, la CLI crea un proyecto en el directorio actual.
Las opciones del comando init se muestran en la siguiente tabla:
|
Opciones
|
Descripción
|
Tipo de datos
|
|---|---|---|
|
--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"]
|
El comando init crea una carpeta en la que se incluyen los siguientes componentes:
• Carpeta lib
• Carpeta test
• Fichero package.json
• Fichero index.js
Las propiedades del fichero package.json se describen en la tabla:
|
package.json
|
|---|
 |
|
Propiedad
|
Descripción
|
|---|---|
|
name
|
Consta de cualquier carácter que sea válido en nombres de fichero. Preferiblemente, el nombre debe ser el nombre del servicio con el que el conector interactúa. El sufijo debe ser –connector para indicar que se trata de un conector de ThingWorx Flow. El nombre debe tener el siguiente formato:
<ptc-servicename-connector>
servicename no puede contener caracteres especiales, a excepción de un guion de subrayado (_).
Por ejemplo, el nombre del conector de ThingWorx Flow debe ser ptc-thingworx-connector en el nombre del paquete.
|
|
description
|
Proporcione una descripción adecuada para el paquete, tal como aparece en los resultados de la búsqueda.
|
|
scripts
|
Se trata de un diccionario en el que se incluyen comandos de script que se ejecutan en distintos momentos del ciclo de vida del conector.
• Para ejecutar los scripts de prueba, ejecute el siguiente comando:
npm test
• Para ejecutar scripts personalizados, ejecute el siguiente comando:
npm run <script name>
Para obtener más información sobre los scripts, consulte el sitio Web
npm scripts.
|
|
dependencies
|
Otros paquetes NPM que el conector utiliza en su código cuando se inician los elementos en tiempo de ejecución.
ptc-flow-sdk es una dependencia obligatoria.
No se debe quitar la dependencia de ptc-flow-sdk porque ThingWorx Flow no podría cargar el conector.
|
|
devDependencies
|
Se utiliza durante la fase de desarrollo. Es posible asignar paquetes NPM adicionales que solo se utilicen en las pruebas del conector en devDependencies.
|