ThingWorx Composer の WorkflowSubsystem でのサービスの実行
必要条件
ThingWorx Composer でサービスを実行する前に、以下の必要条件を満たしていることを確認してください。
• ThingWorx Flow サーバーが実行されていること。
• ThingWorx に管理者としてログインしていること。
手順
1. ThingWorx Flow ダッシュボードで、「Composer」をクリックして ThingWorx Composer に移動します。
2. ThingWorx Composer の「システム」で、「サブシステム」を選択します。
3. 「WorkflowSubsystem」を選択し、「サービス」タブをクリックします。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>"
}
},
に指定します。
ThingWorx Composer で使用可能な OAuth コンフィギュレーション JSON ファイルテンプレートについては、OAuth の設定とロードを参照してください。
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 などの機密情報は表示されません。
入力 | 出力 | ||
|---|---|---|---|
パラメータ名 | ベースタイプ | 説明 | |
- | - | - | ThingWorx Flow サーバーにロードされているすべての OAuth のコネクタ名と OAuth プロバイダ名を提供する JSON を返します。 |
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.Make sure that you are accessing ThingWorx over the ThingWorx Flow hostname and port once ThingWorx Flow has been installed.Otherwise, ThingWorx Flowand ThingWorx will not be able to communicate with each other. |
[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. |