部署连接器
在本地构建和测试连接器后，可将其部署到 ThingWorx Flow 的本地部署测试实例中。要将连接器部署到 ThingWorx Flow 服务器，请执行以下步骤：
1. 在连接器项目中，运行 npm install 命令。
该操作将安装连接器所需的所有包。
2. 启动命令提示符，然后执行以下命令：
flow-deploy connector -s <Root_Directory_Of_Connector_Project> -t <ThingWorx_Flow_Install_Directory>
此命令会执行以下任务：
a. 将构件元数据复制到数据库加载文件。
b. 将图标部署至运行时位置。
c. 将连接器代码复制到连接器的运行时位置。
3. 要将部署的构件元数据加载到 ThingWorx Flow，请执行以下命令：
flow-deploy migrate
4. 导航至 > > 以重新启动 ThingWorx Flow 服务。
这样，您应能够在连接器中使用连接、操作和触发器来创作工作流。
flow-deploy
flow-deploy 命令具有以下子命令：
flow-deploy 命令的所有子命令均接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--log,-l
|
设置日志级别。
|
[字符串] [默认："info"]
|
|
--version
|
显示 ThingWorx Flow Deploy Utility 的版本号。
|
[布尔型]
|
|
--help
|
显示可为此命令提供的各种命令、子命令和参数的帮助。
|
[布尔型]
|
flow-deploy about
打印 ThingWorx Flow 部署实用程序的版本信息。flow-deploy about 命令的命令语法和输出如下：
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
用于将自定义连接器包部署到 ThingWorx Flow 安装目录，并更新加载脚本，使其包括有关自定义连接器构件 (例如：连接、操作等) 的元数据。
flow-deploy connector 命令接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--sourceDir,-s
(必需的)
|
自定义连接器项目的根目录。
|
[字符串]
|
|
--targetDir,-t
(必需的)
|
ThingWorx Flow 安装目录，默认为 C:\ThingWorxOrchestration。
|
[字符串]
|
|
--allow_schema_overwrite
|
flow-deploy 工具不允许覆盖在现有操作、连接和触发器的 JSON 元数据文件中找到的输入和输出架构属性。如果允许这样做，则使用旧架构创建的任何工作流都将遭到破坏。但是，在开发期间，可以覆盖输入和输出架构属性。可将此标志设置为使用连接器项目中的新架构覆盖现有架构。
|
-
|
flow-deploy connector 命令的语法如下：
flow-deploy connector --sourceDir <Root_Directory_Of_Connector_Project> --targetDir <ThingWorx_Flow_Install_Directory>
flow-deploy migrate
此命令会将连接器元数据加载到 ThingWorx Flow 服务器中。
flow-deploy migrate 命令接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--sourceDir,-s
(必需的)
|
ThingWorx Flow 安装目录，默认为 C:\ThingWorxOrchestration。
|
[字符串]
|
|
--Database username, -u
(必需的)
|
ThingWorx Flow 数据库的用户名。
|
[字符串]
|
|
--Database password, -p
(必需的)
|
ThingWorx Flow 数据库的密码。
|
-
|
flow-deploy migrate 命令的语法如下：
flow-deploy migrate --sourceDir <ThingWorx_Flow_Install_Directory> -u <Username_for_ThingWorx_Flow_Database> -p <Password_for_ThingWorx_Flow_Database>
flow-deploy oauths
您可通过此命令使用 OAuth 配置。此命令具有两个子命令：
下列参数在 flow-deploy oauths 命令的所有子命令之间通用。
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--username,-u
|
ThingWorx 管理员用户密码
|
[字符串]
|
|
--password,-p
|
ThingWorx 管理员密码
|
[字符串]
|
|
--app-key,-a
|
ThingWorx 应用程序密钥
|
[字符串]
|
|
--twx-url,-t
|
采用 https://<主机名:端口>/Thingworx 格式的 ThingWorx 基本 URL。
|
[字符串]
|
flow-deploy oauths load
此命令可将 OAuth 配置上载到正在运行的 ThingWorx Flow 实例。
有关连接器加载 OAuth 的说明，请参阅
配置连接器 OAuth 设置。
除了 flow-deploy oauths 命令的所有子命令之间通用的参数外，此命令还接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--file, -f
|
OAuth 配置数据文件的名称
|
[字符串]
|
flow-deploy oauths load 命令的语法如下：
flow-deploy oauths load -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' --twx-url <ThingWorx_Base_URL> -f <Path_to_OAuth_Configuration_File>
其中，<ThingWorx_Base_URL> 必须采用 https://<主机名:端口>/Thingworx 格式。
flow-deploy oauths delete
此命令用于从 ThingWorx Flow 中删除现有配置。如果删除 OAuth 配置，则需要在工作流中重新创建连接。
除了 flow-deploy oauths 命令的所有子命令之间通用的参数外，此命令还接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--name, -n
(必需的)
|
连接器的名称。此名称可在 OAuth 配置文件中找到。
|
[字符串]
|
|
--title
(必需的)
|
OAuth 提供工具的标题。此标题可在 OAuth 配置文件中找到。
|
[字符串]
|
flow-deploy oauths delete 命令的语法如下：
flow-deploy oauths delete -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' --twx-url <ThingWorx_Base_URL> -n <Name_of_the_Connector> --title <Title_of_the_OAuth-provider>
其中，<ThingWorx_Base_URL> 必须采用 https://<主机名:端口>/Thingworx 格式。
例如，要删除标题为“Box”的“box”连接器的 OAuth，请运行以下命令：
flow-deploy oauths delete -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' --twx-url <ThingWorx_Base_URL> -n box --title Box
其中，<ThingWorx_Base_URL> 必须采用 https://<主机名:端口>/Thingworx 格式。
flow-deploy settings
您可以为单个连接器配置多个租户。此命令允许您通过自定义特定 ThingWorx Flow 服务器的一些设置来更新连接器的行为。此命令具有以下子命令：
下列参数在 flow-deploy settings 命令的所有子命令之间通用。
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--username,-u
|
ThingWorx 管理员用户密码
|
[字符串]
|
|
--password,-p
|
ThingWorx 管理员密码
|
[字符串]
|
|
--app-key,-a
|
ThingWorx 应用程序密钥
|
[字符串]
|
|
--twx-url,-t
|
采用 https://<主机名:端口>/Thingworx 格式的 ThingWorx 基本 URL。
|
[字符串]
|
|
--connector,-c
|
连接器名称
|
[字符串]
|
|
--file,-f
|
连接器设置文件的路径
|
[字符串]
|
|
--systemid,-s
|
自定义系统 ID
|
[字符串]
|
|
--default, -d
|
默认系统 ID
|
[字符串]
|
flow-deploy settings download
从正在运行的 ThingWorx Flow 实例下载连接器设置。
例如，要为 ThingWorx Flow 服务器上的指定连接器下载配置设置，请执行以下命令：
flow-deploy settings download -f <Path_to_Connector_Settings_File> -t <ThingWorx_Base_URL> -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' -c <Connector_Name> -s <Custom_System_ID>
flow-deploy settings file-download
从正在运行的 ThingWorx Flow 实例下载文件。
除了 flow-deploy settings 命令的所有子命令之间通用的参数外，此命令还接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--fileId
|
要上载的文件的文件 ID。此名称可在连接器设置定义文件中找到。
|
[字符串]
|
flow-deploy settings file-download 命令的语法如下：
flow-deploy settings file-download -f <Path_to_Customization_File> -t < ThingWorx_Base_URL> -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' -c <Connector_Name> -s <Custom_System_ID> –fileID <ID_of_the_File_to_Upload>
flow-deploy settings upload
将连接器设置上载到正在运行的 ThingWorx Flow 实例。
 |
执行此命令之前，请创建一个 JSON 配置设置文件，并使用 -f 参数来提供此文件的路径。如果此文件中的设置与架构相匹配，则设置会成功上载；否则，将出现一条错误消息，提示您提供所需架构。
|
请考虑下列示例：
◦ 要将设置上载到具有自定义系统 ID 的给定连接器的 ThingWorx Flow 服务器，请执行以下命令：
flow-deploy settings upload -f <Path_to_Connector_Settings_File> -t <ThingWorx_Base_URL> -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' -c <Connector_Name> -s <Custom_System_ID>
◦ 要将设置上载到具有默认系统 ID 的给定连接器的 ThingWorx Flow 服务器，请执行以下命令：
flow-deploy settings upload -f <Path_to_Connector_Settings_File> -t <ThingWorx_Base_URL> -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' -c <Connector_Name> -d
flow-deploy settings file-upload
将文件上载到正在运行的 ThingWorx Flow 实例。
除了 flow-deploy settings 命令的所有子命令之间通用的参数外，此命令还接受以下参数：
|
参数
|
说明
|
数据类型
|
|---|---|---|
|
--fileId
|
要上载的文件的文件 ID。此名称可在连接器设置定义文件中找到。
|
[字符串]
|
|
--contentType
|
文件的内容类型。
|
[字符串]
|
例如，flow-deploy settings file-upload -f <Path_to_Customization_File> -t <ThingWorx_Base_URL> -u <ThingWorx_Administrator_Username> -p '<ThingWorx_Administrator_Password>' -c <Connector_Name> -s <Custom_System_ID> –fileID <ID_of_the_File_to_Upload> --contentType <Content_Type>