接続の作成
一部のシステムでは OAuth メカニズムがサポートされていないことがあります。このようなシステムでは、ユーザー名とパスワードによる基本認証などのその他の認証メカニズムが利用されたり、キーベースのメカニズムがサポートされていたりする場合があります。OAuth をサポートしていないすべてのシステムで接続を定義する必要があります。
新規接続を作成するには、次の手順に従います。
1. コマンドプロンプトから、次のコマンドを実行します。
a. cd <user project root directory>
b. flow add connection <name>
接続のフォーマットは <service-name>-<connection-name> になります。
サービス名は CLI によって自動的に追加されます。<コネクタ名>-<接続名> という名前の新規フォルダがローカルディレクトリに作成され、connection.json ファイルと index.js ファイルが格納されます。
このコマンドでは次のオプションを使用できます。
|
オプション
|
説明
|
データ型
|
|---|---|---|
|
--version
|
バージョン番号を表示します。
|
[ブール]
|
|
--help
|
ヘルプを表示します。
|
[ブール]
|
|
--parentDir,-d
|
プロジェクトの親ディレクトリ。
|
[デフォルト: "."]
|
|
--logLevel,-1
|
ログレベルを設定します。
|
[デフォルト: "info"]
|
|
--artifactVersion,-v
|
作成する成果物のバージョン。
|
[デフォルト: "v1"]
|
2. システムに接続するために収集する必要がある情報を特定します。
 |
この情報は、URL、ユーザー名、パスワード、アプリケーションキー、またはシステムに接続するために必要なその他の情報の形式で指定できます。
|
上記の情報は connection.json ファイルで JSON スキーマとして表す必要があります。この情報を使用して ThingWorx Flow ワークフローエディタにフォームが表示されます。
index.js ファイルは、操作とトリガーで使用可能なフォームに保存されている情報を変換します。フォームから返された情報は暗号化されて ThingWorx Flow データベースに保存されます。
フォーマットされたスキーマ connection.json ファイルと入力フォームは以下のようになります。
以下の表で、JSON スキーマで使用されるプロパティについて説明します。
プロパティ | JSON ファイルで各プロパティを入力します |
|---|---|
type | トップレベルのタイプ。必ず object タイプである必要があります。 |
title | ThingWorx Flow ホームページでの認証ウィンドウのタイトルとして使用されます。 |
format | ThingWorx Flow キャンバスにフォームを表示するときに使用されるレイアウト。 |
properties | ターゲットシステムを認証するためにユーザーから取得した属性が含まれています。 これには子属性をいくつでも含めることができます。すべての子属性は title、type、description を必要とします。タイプには、JSON スキーマでサポートされる任意のタイプを指定できます。 たとえば、このシステムに接続するためには email、subscription_id、account_url、および API トークンが必要であることがわかります。 |
契約
index.js などの JavaScript ファイルは、次の 2 つのメソッドが格納されている JavaScript オブジェクトをエクスポートする必要があります。
• connect - 操作、トリガー、検索による消費に適した形式に入力を変換します。
• validate - 接続の検証に使用されます。通常は、npm request ライブラリなどの API を使用してターゲットシステムに接続できます。
接続で使用可能な API 用の SDK については、
ThingWorx Flow コネクタ SDKのセクションを参照してください。
以下のビデオでは、ThingWorx Flow CLI を使用して接続を作成する方法が示されています。