コネクタの展開
コネクタをローカルで構築およびテストした後、ThingWorx Flow のオンプレミスのテストインスタンスに展開できます。ThingWorx Flow サーバーにコネクタを展開するには、次の手順を実行します。
1. コネクタプロジェクトから npm install コマンドを実行します。
これにより、コネクタで必要とされるすべてのパッケージがインストールされます。
2. コマンドプロンプトを開始し、以下のコマンドを実行します。
flow-deploy connector -s <コネクタプロジェクトのルートディレクトリ> -t <ThingWorx Flow のインストールディレクトリ>
このコマンドは、次のタスクを実行します。
a. 成果物メタデータをデータベースロードファイルにコピーします。
b. ランタイムの場所にアイコンを展開します。
c. コネクタコードをコネクタのランタイムの場所にコピーします。
3. 展開された成果物メタデータを ThingWorx Flow にロードするには、以下のコマンドを実行します。
flow-deploy migrate
4. > > に移動して ThingWorx Flow サービスを再開始します。
コネクタから接続、操作、トリガーを使用してフローを作成できるようになります。
flow-deploy
flow-deploy コマンドには次のサブコマンドがあります。
 |
OAuths をロードまたは削除するには、ThingWorx Composer の WorkflowSubsystem で OAuth サービスを使用することをお勧めします (
ThingWorx Composer の WorkflowSubsystem でのサービスの実行を参照)。
|
flow-deploy のすべてのサブコマンドは、次のパラメータを受け入れます。
|
パラメータ
|
説明
|
データ型
|
|---|---|---|
|
--log,-l
|
ログレベルを設定します。
|
[文字列] [デフォルト: "info"]
|
|
--version
|
ThingWorx Flow Deploy Utility のバージョン番号を表示します。
|
[ブール]
|
|
--help
|
各種のコマンド、サブコマンド、コマンドに渡すパラメータのヘルプを表示します。
|
[ブール]
|
flow-deploy about
ThingWorx Flow Deploy Utility のバージョン情報を出力します。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 <コネクタプロジェクトのルートディレクトリ> --targetDir <ThingWorx Flow のインストールディレクトリ>
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 のインストールディレクトリ> -u <ThingWorx Flow データベースのユーザー名> -p <ThingWorx Flow データベースのパスワード>
flow-deploy oauths
このコマンドにより、OAuth コンフィギュレーションを設定できるようになります。このコマンドには 2 つのサブコマンドがあります。
|
|
OAuths をロードまたは削除するには、ThingWorx Composer の WorkflowSubsystem で OAuth サービスを使用することをお勧めします (
ThingWorx Composer の WorkflowSubsystem でのサービスの実行を参照)。
|
次のパラメータは、flow-deploy oauths コマンドのすべてのサブコマンドで共通です。
|
パラメータ
|
説明
|
データ型
|
|---|---|---|
|
--username,-u
|
ThingWorx 管理者のユーザー名
|
[文字列]
|
|
--password,-p
|
ThingWorx 管理者のパスワード
|
[文字列]
|
|
--app-key,-a
|
ThingWorx のアプリケーションキー
|
[文字列]
|
|
--twx-url,-t
|
https://<ホスト名:ポート>/Thingworx フォーマットの ThingWorx ベース URL。
|
[文字列]
|
flow-deploy oauths load
このコマンドは、ThingWorx Flow の実行中のインスタンスに OAuth コンフィギュレーションをアップロードします。
コネクタへの OAuth のロード手順については、
コネクタの OAuth の設定を参照してください。
flow-deploy oauths コマンドのすべてのサブコマンドに共通するコマンドパラメータに加え、このコマンドは次のパラメータを受け入れます。
|
パラメータ
|
説明
|
データ型
|
|---|---|---|
|
--file, -f
|
OAuth コンフィギュレーションデータファイルの名前。
|
[文字列]
|
flow-deploy oauths load コマンドの構文は以下のとおりです。
flow-deploy oauths load -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' --twx-url <ThingWorx ベース URL> -f <OAuth コンフィギュレーションファイルのパス>
ここで、<ThingWorx ベース 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 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' --twx-url <ThingWorx ベース URL> -n <コネクタ名> --title <OAuth プロバイダのタイトル>
ここで、<ThingWorx ベース URL> は https://<ホスト名:ポート>/Thingworx フォーマットでなければなりません。
たとえば、'Box' というタイトルが付いた 'box' コネクタの OAuth を削除するには、次のコマンドを入力します。
flow-deploy oauths delete -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' --twx-url <ThingWorx ベース URL> -n box --title Box
ここで、<ThingWorx ベース 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 <コネクタ設定ファイルへのパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -s <カスタムのシステム ID>
flow-deploy settings file-download
ThingWorx Flow の実行中のインスタンスからファイルをダウンロードします。
flow-deploy settings コマンドのすべてのサブコマンドに共通するコマンドパラメータに加え、このコマンドは次のパラメータを受け入れます。
|
パラメータ
|
説明
|
データ型
|
|---|---|---|
|
--fileId
|
アップロードするファイルのファイル ID。この名前は、コネクタ設定定義ファイル内にあります。
|
[文字列]
|
flow-deploy settings file-download コマンドの構文は以下のとおりです。
flow-deploy settings file-download -f <カスタマイズファイルへのパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -s <カスタムのシステム ID> –fileID <アップロードするファイルの ID>
flow-deploy settings upload
ThingWorx Flow の実行中のインスタンスにコネクタ設定をアップロードします。
|
|
このコマンドを実行する前に、コンフィギュレーション設定の JSON ファイルを作成し、-f パラメータを使用してこのファイルへのパスを設定します。このファイル内の設定がスキーマと一致する場合、設定は正常にアップロードされています。一致しない場合、必要なスキーマを示すエラーメッセージが表示されます。
|
次の例について考えてみます。
◦ ThingWorx Flow サーバーにカスタムシステム ID を持つ特定のコネクタの設定をアップロードするには、以下のコマンドを実行します。
flow-deploy settings upload -f <コネクタ設定ファイルへのパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -s <カスタムのシステム ID>
◦ ThingWorx Flow サーバーにデフォルトのシステム ID を持つ特定のコネクタの設定をアップロードするには、以下のコマンドを実行します。
flow-deploy settings upload -f <コネクタ設定ファイルへのパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -d
flow-deploy settings file-upload
ThingWorx Flow の実行中のインスタンスにファイルをアップロードします。
flow-deploy settings コマンドのすべてのサブコマンドに共通するコマンドパラメータに加え、このコマンドは次のパラメータを受け入れます。
|
パラメータ
|
説明
|
データ型
|
|---|---|---|
|
--fileId
|
アップロードするファイルのファイル ID。この名前は、コネクタ設定定義ファイル内にあります。
|
[文字列]
|
|
--contentType
|
ファイルのコンテンツタイプ。
|
[文字列]
|
例: flow-deploy settings file-upload -f <カスタマイズファイルのパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -s <カスタムのシステム ID> –fileID <アップロードするファイルの ID> --contentType <コンテンツタイプ>