部署連接器
在本機建立及測試連接器之後，可以將其部署至 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。此名稱可在 OAuth 組態檔案中找到。
|
[字串]
|
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。此名稱可在 OAuth 組態檔案中找到。
|
[字串]
|
|
--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>