Servoy でConfluence に接続されたWeb アプリを構築

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Servoy は、迅速なアプリケーション開発とデプロイのためのプラットフォームです。CData JDBC Driver for Confluence と組み合わせることで、ユーザーはConfluence に接続してリアルタイムConfluence データを使用できるアプリケーションを構築できます。この記事では、Servoy からConfluence に接続し、Confluence データを表示、検索するための簡単なWeb アプリケーションを構築する方法を説明します。

ビルトインの最適化されたデータ処理により、CData JDBC Driver は、リアルタイムConfluence データとやり取りする際に圧倒的なパフォーマンスを提供します。Confluence に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をConfluence に直接プッシュし、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みのSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータソース型を使用してConfluence データを操作できます。

Servoy Developer からConfluence に接続する

Confluence に接続するアプリケーションを構築するには、まず、Servoy Developer からCData JDBC Driver for Confluence を使用してデータプロバイダを作成する必要があります。

1. JDBC Driver をインストールします。
2. JDBC Driver JAR ファイル（cdata.jdbc.confluence.jar）を、Servoy のインストールディレクトリの/application_server/drivers/ ディレクトリにコピーします。
3. Servoy Developer を開きます。
4. Solution Explorer で「Resources」の下の「Database Server」を右クリックし、「Connect to existing database」->「empty」を選択します。
   1. サーバーに名前を付けます。
   2. クリックすると、サーバーの詳細設定が表示されます。

      • 次のようにURL を設定します。例：jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

        組み込みの接続文字列デザイナー

        JDBC URL の構築については、Confluence JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

        java -jar cdata.jdbc.confluence.jar

        接続プロパティを入力し、接続文字列をクリップボードにコピーします。

        API Token を取得する方法

        API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

        Confluence Cloud Account への接続

        Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

        • User: Confluence サーバーに認証するユーザー名。
        • APIToken: 認証するユーザーに紐付けられたAPI Token。
        • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

        Confluence Server Instance への接続

        Server instance への接続には以下を設定します:

        • User: Confluence Instance に接続するユーザー名。
        • Password: Confluence Instance に接続するユーザーのパスワード。
        • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net
      • コピーしたDriver クラスを選択します。例：cdata.jdbc.confluence.ConfluenceDriver

Confluenceに接続するWeb アプリを構築する

Servoy Developer リソースでConfluence への接続を設定すると、リアルタイムConfluence へのアクセス権を持つアプリケーションを構築することができます。

新しいソリューションを作成する

1. Server Explorer で、「All solutions」を右クリックし、「Create new solution」を選択します。
2. ソリューションに名前を付けます。
3. 「search」モジュールを含むチェックボックスを選択します。
4. 「Finish」をクリックします。

新しいフォームを作成する

「Forms」を右クリックし、「Create new form」を選択します。

1. フォームに名前を付けます。
2. データソースを選択します。
3. タイプ（Simple など）を設定し、「Finish」をクリックします。

フォームにData Grid を追加する

1. Servoy NG-Grids からData Grid コンポーネントをフォームにドラッグします。

2. カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをConfluence 「table」のカラム（例：Pages テーブルのKey）に設定します。

   必要に応じてカラムを追加します。

アプリケーションに検索を追加する

検索機能を追加するには、「svySearch」拡張機能が必要です。（新しいソリューションを作成する際にデフォルトで含まれます。）ソリューションの作成時に拡張機能を追加しなかった場合、または、既存のソリューションを変更する場合は、ソリューション内のModules を右クリックして「Add Module」を選択することで検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。

1. Text Field コンポーネントをForm にドラッグします。
2. Form を右クリックし、「Open in Script Editor」を選択します。
3. 検索値を保持する新しい変数（JavaScript）を作成します。

   var searchText = '';
   

4. Text Field プロパティでForm に戻ります。
   1. 「dataprovider」プロパティを作成したForm 変数に設定します。
   2. ダブルクリックしてonAction イベントのメソッドを追加します。
   3. クリックして「Form」でメソッドを作成し、名前を付けて（例：onEnter）、「Create private」をクリックします。
   4. 「OK & Show」をクリックします。
5. 以下のJavaScript をJavaScript ファイルに追加することで、Servoy フレームワークを使用してText Field のテキストを使ったバインドデータの検索を実装します。

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

アプリを保存して起動する

フォームとJavaScript ファイルを保存し、「Run」->「Launch NGClient」とクリックしてWeb アプリケーションを起動します。

CData JDBC Driver for Confluence の30日の無償評価版をダウンロードし、Servoy でConfluence に接続されたアプリケーションの構築を開始します。ご不明な点があれば、サポートチームにお問い合わせください。