ThingWorx Flow > ThingWorx Flow SDK > 连接器项目
连接器项目
连接器项目与系统连接器相对应,这种连接器在逻辑上将某些集成功能分组在一起。单一项目中包含与功能组关联的构件的多个版本。除了项目中的测试构件之外,还有用于自定义和本地化的构件。
连接器信息在结构的项目中进行存储和处理。
要创建新项目,请从命令提示符处执行以下命令:
flow init <user project root directory>
在指定的目录中创建新连接器项目。如果未提供目录名称,CLI 便会在当前目录下创建项目。
有关 init 命令的选项如下表所示:
选项
说明
数据类型
--help
显示帮助。
[布尔型]
--parentDir, -d
项目的父项目录。
[默认:"."]
--logLevel, -1
设置日志级别。
[默认:"info"]
init 命令可用于创建包含以下组件的文件夹:
lib 文件夹
test 文件夹
package.json 文件
index.js 文件
package.json 文件的属性如下表所述:
package.json
属性
说明
名称
由任何在文件名中有效的字符组成。名称应最好为连接器与之交互的服务的名称。后缀应为 –connector,以指示它是 ThingWorx Flow 连接器。名称应采用以下格式:
<ptc-servicename-connector>
servicename 不能包含下划线 (_) 以外的特殊字符。
例如,ThingWorx Flow 连接器的名称必须是包名称中的 ptc-thingworx-connector。
description
如搜索结果中所列,为包提供相应的说明。
脚本
它可以说是一本字典,其中包含在连接器生命周期的不同时间运行的脚本命令。
要运行测试脚本,请执行以下命令:
npm test
要运行自定义脚本,请执行以下命令:
npm run <script name>
有关脚本的详细信息,请参阅 npm 脚本网站
相关性
当在运行时启动构件时,连接器在其代码中所使用的其他 NPM 包。
ptc-flow-sdk 为必需的依赖项。
不要删除 ptc-flow-sdk 依赖项,因为 ThingWorx Flow 可能无法加载连接器。
有关相关性的详细信息,请参阅 npm 网站上的相关性部分。
devDependencies
用于开发阶段。您可以映射仅用于测试 devDependencies 中的连接器的附加 npm 包。
有关详细信息,请参阅 npmjs 网站上的 devDependencies 部分。