コネクタの展開
コネクタをローカルで構築およびテストした後、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 コマンドには次のサブコマンドがあります。
• flow-deploy about - ThingWorx Flow Deploy Utility に関する情報を提供します。
• flow-deploy connector - ThingWorx Flow のローカルインストールにコネクタ成果物を展開します。
• flow-deploy migrate - 展開された成果物メタデータを ThingWorx Flow サーバーにロードします。
• flow-deploy settings <command> - コネクタの設定をアップロードまたはダウンロードします。
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 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 パラメータを使用してこのファイルへのパスを設定します。このファイル内の設定がスキーマと一致する場合、設定は正常にアップロードされています。一致しない場合、必要なスキーマを示すエラーメッセージが表示されます。 |
flow-deploy settings コマンドのすべてのサブコマンドに共通するコマンドパラメータに加え、このコマンドは次のパラメータを受け入れます。
パラメータ | 説明 | データ型 |
---|
--propertyKey,-k | 更新するプロパティの名前。 単一のプロパティの場合、<プロパティ名> のみを指定します。 JSON オブジェクトまたは配列の場合、<プロパティパス> を指定します。 たとえば、JSON オブジェクトの場合は prop1.prop2.prop3 と指定し、配列の場合は prop1[0].prop2[1].prop3 と指定します。 | [文字列] |
次の例について考えてみます。
◦ 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 upload -f <コネクタ設定ファイルへのパス> -k <プロパティ名> または <プロパティパス> -t <ThingWorx ベース URL> -u <ThingWorx 管理者のユーザー名> -p '<ThingWorx 管理者のパスワード>' -c <コネクタ名> -d
このコマンドは、指定されたプロパティの値を設定ファイルから取得し、これを ThingWorx Flow サーバーにアップロードします。
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 <コンテンツタイプ>