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

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

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

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

Servoy Developer からBitbucket に接続する

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

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

      • 次のようにURL を設定します。例：jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH

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

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

        java -jar cdata.jdbc.bitbucket.jar

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

        ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。

        Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。

        • Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
        • Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。

        Bitbucketでの認証

        BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。

        特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。

        カスタムOAuthアプリケーションの作成

        Bitbucketアカウントから、以下のステップを実行します。

        1. 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
        2. アプリと機能セクションで、OAuthコンシューマーを選択します。
        3. コンシューマーを追加をクリックします。
        4. カスタムアプリケーションの名前と説明を入力します。
        5. コールバックURLを設定します。
           • デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
           • Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
        6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
        7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
        8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
        9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
        
      • コピーしたDriver クラスを選択します。例：cdata.jdbc.bitbucket.BitbucketDriver
   

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

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

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

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」プロパティをBitbucket 「table」のカラム（例：Issues テーブルのTitle）に設定します。

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

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

検索機能を追加するには、「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 Bitbucket の30日の無償評価版をダウンロードし、Servoy でBitbucket に接続されたアプリケーションの構築を開始します。ご不明な点があれば、サポートチームにお問い合わせください。