创建连接
某些系统可能不支持 OAuth 机制。它们可能使用其他机制进行身份验证,例如使用用户名和密码进行基本身份验证,或者可能支持基于密钥的机制。所有不支持 OAuth 的系统均需定义连接。
要创建新连接,请执行下列操作:
1. 在命令提示符处执行以下命令:
a. cd <user project root directory>
b. flow add connection <name>
连接采用格式 <service-name>-<connection-name>
CLI 会自动添加服务名称。将在本地目录下创建名为 connector name-connection name 的新文件夹,其中包含 connection.json 文件和 index.js 文件。
下列选项适用于此命令。
选项
说明
数据类型
--version
显示版本号。
[布尔型]
--help
显示帮助。
[布尔型]
--parentDir,-d
项目的父项目录。
[默认:"."]
--logLevel,-1
设置日志级别。
[默认:"info"]
--artifactVersion,-v
要创建的构件版本。
[默认:"v1"]
2. 确认连接到系统时所需收集的信息。
* 
信息的形式可以是 URL、用户名、密码或应用程序密钥,也可以是连接到系统时所需的任何其他信息。
以上信息需要在 connection.json 文件中以 JSON 架构的形式表示。ThingWorx Flow 使用此信息在 ThingWorx Flow 工作流编辑器中显示表单。
index.js 文件可以转换表单中存储的信息,以便可供“操作”和“触发器”使用。表单返回的这些信息会进行加密并存储在 ThingWorx Flow 数据库中。
格式化的架构 connection.json 文件和输入表单显示如下:
下表介绍了 JSON 架构中使用的属性。
属性
在 JSON 文件中输入属性
type
顶层类型应始终为 object 类型。
title
用作 ThingWorx Flow 主页上身份验证窗口的标题。
format
用于在 ThingWorx Flow 工作区中显示表单的布局。
properties
包含从用户处获取并用于验证目标系统的属性。
其中可以包含任意数量的子属性。所有子属性都需要有标题、类型和说明。类型可以是 JSON 架构所支持的任何类型。
例如,我们可以发现,在连接到系统时需要电子邮件、subscription_id、account_url 和 API 令牌。
合约
JavaScript 文件,例如 index.js,必须导出包含两种方法的 JavaScript 对象:
connect - 将输入转换为适用于“操作”、“触发器”和“查找”耗用的表单。
validate - 用于验证连接。通常,您可以使用诸如 npm request 库等一些 API 连接到目标系统。
有关可在“连接”中使用的 API 的 SDK 信息,请参阅 ThingWorx Flow 连接器 SDK 部分。
有关格式化输入和输出架构的信息,请参阅 创建操作主题下方的注解。
以下视频演示如何使用 ThingWorx Flow CLI 创建连接。
有关创建连接的详细信息,请参阅 ThingWorx Flow 连接器 SDK 教程