ローコードアプリ開発プラットフォームRetool でDB2 連携アプリを作成

こんにちは！リードエンジニアの杉本です。

Retool はローコードでWebベースの業務アプリケーションを構築できるクラウドサービスです。この記事では、CData Connect Server を経由して Retool からDB2 に連携するアプリを作成する方法を説明します。

CData Connect Server は、DB2 データのクラウド to クラウドの仮想OData インターフェースを提供し、Retool からリアルタイムにDB2 データへ連携することができます。

DB2 の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

1. CData Connect Server にログインして、Databases をクリックします。
2. 利用できるデータソースアイコンから"DB2" を選択します。
3. DB2 に接続するために必要なプロパティを入力します。

   DB2 への接続には以下を入力します：

   • Server: DB2 が稼働しているサーバー。
   • Port: DB2 サーバーのポート。
   • Database: DB2 のデータベース。
   • User: DB にアクセスする権限のあるユーザー名。
   • Password: DB にアクセスする権限のあるユーザーのパスワード。

   対応するDB2 のドライバーをインストールする必要があります。

   • Windows: IBM Data Server Provider for .NET

     Windows では、IBM Data Server Provider をインストールするだけで十分です。インストールがmachine.config への書き込みを行います。

   • Java: IBM Data Server Driver for JDBC

     Java では、IBM Data Server Driver JAR をアプリケーションのwww\WEB-INF\lib\ フォルダに配置する必要があります。

   パスワード方式によるSSH 接続

   パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

   • User: DB2 のユーザ
   • Password: DB2 のパスワード
   • Database: DB2 の接続先データベース
   • Server: DB2 のサーバー
   • Port: DB2 のポート
   • UserSSH: "true"
   • SSHAuthMode: "Password"
   • SSHPort: SSH のポート
   • SSHServer: SSH サーバー
   • SSHUser: SSH ユーザー
   • SSHPassword: SSH パスワード

   接続文字列形式では以下のようになります。

   Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=testUseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

   公開鍵認証方式方式によるSSH 接続

   公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

   • User: DB2 のユーザ
   • Password: DB2 のパスワード
   • Database: DB2 の接続先データベース
   • Server: DB2 のサーバー
   • Port: DB2 のポート
   • UserSSH: "true"
   • SSHAuthMode: "Public_Key"
   • SSHClientCertType: キーストアの種類
   • SSHPort: SSH のポート
   • SSHServer: SSH サーバー
   • SSHUser: SSH ユーザー
   • SSHClientCert: 秘密鍵ファイルのパス

   接続文字列形式では以下のようになります。

   Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;
4. Test Database をクリックします。
5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

Resource の登録

続いてRetool 側の手順を進めていきます。Retool ではまず、構成したAPI にアクセスするためのリソース情報を登録します。

1. Retool にログインし、「Resouces」から「Create new」をクリックします。
2. 接続できるサービスの一覧が表示されるので「REST API」を選択します。
3. REST APIの設定画面では以下の通り必要な情報を入力します。Base URLには事前に作成したAPI のリソースエンドポイントを指定します。Headers には生成したユーザーの認証トークンを「x-cdata-authtoken」ヘッダーとして指定します。
4. リソースを作成後、アプリの作成確認ダイアログが出てくるので、今回はこれで作成してしまいます。（もちろんテンプレートなどを使っても構いません。）
5. 任意の名称を指定してください。

一覧画面の作成

リソースの登録が完了したら一覧画面を作成しましょう。

1. まず、先程登録したAPIのコネクションを使って、データを取得するための「Query」を定義します。すでに登録されているQueryの名前を変更し内部のAPIを定義を調整します。
2. デフォルトで Action Type、つまりAPIリクエストのメソッドが「GET」なので、このままでもデータは取得できます。ただ、初期状態ではすべての項目を取得してしまうので、API Serverがサポートするクエリパラメータを使って、取得項目やフィルター条件等を指定します。
3. URL parmeters を記述したら、設定を保存して実行してみましょう。以下のようにデータが取得できればOKです。
4. あとはこのデータを画面に表示するための「Table」UIコンポーネントを画面に配置します。
5. デフォルトえはJSON形式のサンプルデータが表示されているので、これを変更します。
6. 先程のクエリ名と対象のオブジェクト名を「{{QueryName.data.value}}」といった形で指定するだけでOKです。これだけで簡単に一覧画面が構成できました。
7. 作成した画面はプレビューモードで動作確認できます。

このように、CData Connect Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをRetool で開発できます。他にも多くのデータソースに対応するCData Connect Server の詳細をこちらからご覧ください。