在 ThingWorx Composer 的工作流程子系統中執行服務
先決條件
在 ThingWorx Composer 中執行服務之前，請確保符合下列先決條件：
• ThingWorx Flow 伺服器必須正在執行。
• 以管理員身份登入 ThingWorx。
步驟
1. 從圖示 ThingWorx Flow 儀表板中，按一下 Composer 以導覽至 ThingWorx Composer。
2. 在 ThingWorx Composer 的「系統」下，選取「子系統」。
3. 選取「工作流程子系統」，然後按一下「服務」標籤。ThingWorx Flow 中有下列服務：
4. 搜尋服務，並執行以下其中一個任務：
◦ 選取服務以檢視其輸入與輸出資訊。
◦ 按一下 
。提供適當的輸入值，然後按一下「執行」。
。提供適當的輸入值，然後按一下「執行」。服務
LoadOAuthConfiguration
使用此服務可將 OAuth 組態 JSON 檔案載入至 ThingWorx Flow 伺服器。此服務會針對在 JSON 檔案中指定的連接器更新或新增 OAuth 提供者。它不會刪除任何現有的 OAuth。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
oauthConfigurations | JSON | 為連接器提供具有正確 OAuth 組態設定的有效 JSON 檔案。 | 會傳回一則訊息，指出成功完成或執行服務期間發生錯誤。 |
例如：欲載入 JIRA 的 OAuth 配置，請將 oauthConfigurations 的值提供為
"jira": {
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
請參閱配置及載入 OAuth，以取得可在 ThingWorx Composer 中找到的 OAuth 組態 JSON 檔案範本
DeleteOAuthConfiguration
如果 OAuth 提供者未由任何連接器使用，請使用此服務從 ThingWorx Flow 伺服器中刪除 OAuth 組態。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
Connector config name | 字串 | 提供您要刪除其 OAuth 組態設定的有效連接器組態值。 | 會傳回一則訊息，指出成功完成或執行服務期間發生錯誤。 |
OAuth provider | 字串 | 為指定的連接器提供有效的 OAuth 提供者。 | |
欲刪除 JIRA 的相同 OAuth 組態，請將 Connector config name 欄位的值提供為 jira，並將 OAuth provider 欄位提供為 JIRA。
GetOAuthConfiguration
使用此服務可擷取將 OAuth 載入至 ThingWorx Flow 伺服器之連接器的清單。不會顯示諸如用戶端 ID、用戶端密碼與 URL 等敏感資訊。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
– | – | - | 傳回的 JSON 可提供載入至 ThingWorx Flow 伺服器之所有 OAuth 的連接器名稱與 OAuth 提供者名稱。 |
DeleteOAuthAccessToken
使用此服務可刪除指定 OAuth 提供者的 OAuth 存取權杖。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
OAuth provider | 字串 | 為協力廠商服務或公用程式提供有效的 OAuth 提供者。 | 會傳回一則訊息，指出成功完成或執行服務期間發生錯誤。 |
User Name | 字串 | 提供您要針對指定 OAuth 提供者刪除其所產生存取權杖的 ThingWorx 使用者名稱。 此欄位是選用欄位。如果您未指定使用者名稱，服務會針對指定的 OAuth 提供者刪除任何使用者的所有 OAuth 存取權杖。 | |
 | 在服務刪除 OAuth 提供者的 OAuth 存取權杖之後，OAuth (指定的使用者) 連接器會與  圖示一起顯示在 ThingWorx Flow 儀表板上。 |
為使用者刪除 OAuth 存取權杖之後，使用者需要為 OAuth 連接器提供其授權資訊，才能執行工作流程：
◦ 「OAuth (指定的使用者)」- 編輯 OAuth (指定的使用者) 連接器，以提供重新配置連接器的認證。
◦ 「OAuth (工作階段使用者)」- 在其工作流程中使用此 OAuth (工作階段使用者) 連接器的每位使用者，都必須登入並提供核准，並再次授與協力廠商服務或公用程式權限。
RefreshMetadata
ThingWorx Flow 會快取 Windchill OData 資訊以改善效能。如果您已修改 Windchill 的中繼資料規格或已更新 Windchill 伺服器中的可變屬性，請使用此服務來在 ThingWorx Flow 伺服器上更新它們。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
connectorName | 字串 | 提供協力廠商服務的連接器名稱。 | 會傳回一則訊息，指出成功完成或執行服務期間發生錯誤。 |
ValidateFlowSetup
執行此服務以核對 ThingWorx 是否能夠與 ThingWorx Flow 服務進行通訊。
輸入 | 輸出 | ||
|---|---|---|---|
參數名稱 | 基礎類型 | 描述 | |
– | – | – | 會傳回一則訊息，指出成功完成或執行服務期間發生錯誤。 |
當 ThingWorx 與 ThingWorx Flow 服務之間存在連線問題時，會顯示下列錯誤代碼與訊息。
錯誤代碼 | 錯誤訊息 |
|---|---|
[FLOW-CONFIG-01] | ThingWorx Flow is not enabled. Add the OrchestrationSettings section to the platform-settings.json file to enable ThingWorx Flow. |
[FLOW-RABBIT-01] | Failed to connect to RabbitMQ. Check whether the RabbitMQ service is running and is accessible. |
[FLOW-API-01] | Failed to connect to ThingWorx Flow. Check ThingWorx logs for more detail. |
[FLOW-API-02] | Failed to connect to ThingWorx Flow. 請確保在安裝 ThingWorx Flow 后可透過 ThingWorx Flow 主機名稱和埠存取 ThingWorx。否則，ThingWorx Flow 和 ThingWorx 將無法彼此通訊。 |
[FLOW-KEY-01] | OAuth admin key not found in the ThingWorx KeyStore. |
[FLOW-KEY-02] | Exchange admin key not found in the ThingWorx KeyStore. |
[FLOW-KEY-03] | Failed to get ThingWorx Flow keys from the ThingWorx KeyStore. |
[FLOW-KEY-04] | Failed to get ThingWorx Flow keys from the ThingWorx KeyStore. |
[FLOW-EXCHANGE-01] | Failed to connect to ThingWorx Flow exchange service. Check ThingWorx logs for more details. |
[FLOW-EXCHANGE-02] | Failed to connect to ThingWorx Flow exchange service. Check whether ThingWorx Flow exchange service is up and running. |
[FLOW-OAUTH-01] | Failed to connect to ThingWorx Flow OAuth service. Check ThingWorx logs for more details. |
[FLOW-OAUTH-02] | Failed to connect to ThingWorx Flow OAuth service. Check whether ThingWorx Flow OAuth service is up and running. |