Mendix のローコード開発プラットフォームで Bitbucket のデータを使ったアプリを構築

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver for Bitbucket を使って Bitbucket のデータと Mendix を連携し、アプリを構築。

Siemens 社が開発した Mendix は、Web およびモバイルアプリケーションを迅速に開発、テスト、デプロイするためのローコードプラットフォームです。デジタルトランスフォーメーションの推進とビジネスのアジリティ向上を実現します。CData JDBC Driver for Bitbucket と組み合わせることで、Mendix Studio Pro を使って Bitbucket のデータを活用したさまざまなアプリケーションを作成できます。

CData JDBC ドライバーは、最適化されたデータ処理機能を組み込み、リアルタイムBitbucket のデータと連携する際に、比類のないパフォーマンスを発揮します。複雑な SQL クエリを Bitbucket に発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を直接 Bitbucket にプッシュし、サポートされていない操作（多くの場合、SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアントサイドで処理します。組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して Bitbucket のデータを操作・分析できます。

この記事では、Mendix が提供する JDBC インターフェースと CData JDBC Driver for Bitbucket を組み合わせて、Bitbucket のデータを活用したアプリケーションを Mendix で簡単に作成する方法を紹介します。

Mendix 環境の準備

このセクションでは、先ほど紹介した Mendix Studio Pro を使用して、Bitbucket のデータを使ったアプリを開発する方法を説明します。事前に Mendix Studio Pro をインストールしておいてください。

CData JDBC Driver for Bitbucket のインストール

まず、Mendix と同じマシンに CData JDBC Driver for Bitbucket をインストールします。JDBC ドライバーは以下のパスにインストールされます。

C:\Program Files\CData\CData JDBC Driver for Bitbucket 20xx\lib\cdata.jdbc.bitbucket.jar

アプリケーションの作成

それでは、アプリの作成を始めましょう。まず、Database Connector が利用可能なアプリを作成します。

Mendix Studio Pro を起動し、「Create New App」をクリックします。
「Blank Web App」オプションを選択します。
「Use this starting point」をクリックして続行します。
任意の名前でアプリを作成します。また、後で参照するために「Disk location」の情報をメモしておきましょう。
これで新しいアプリが作成されました。

アプリケーションに Database Connector を追加

次に、作成したアプリに Database Connector モジュールを追加します。

右上の Marketplace ボタンをクリックします。
Marketplace の検索セクションで Database Connector を検索し、選択します。
Download をクリックして、最新の Database Connector をダウンロードします。
Import Module ウィンドウで、Action として Add as a new module を選択します。
アプリ画面に Database Connector が表示されれば、次のステップに進む準備が整いました。

Mendix Studio Pro への JDBC ドライバーの追加

この Database Connector で CData JDBC ドライバーを使用するには、JDBC ドライバーの JAR ファイルをプロジェクトに追加する必要があります。

先ほどメモした Mendix プロジェクトフォルダ内に「userlib」というフォルダがあります。そのフォルダに「cdata.jdbc.bitbucket.jar」と「cdata.jdbc.bitbucket.lic」の2つのファイルを配置します。
これで、Database Connector で CData JDBC ドライバーを使用できるようになりました。

データモデルの作成

それでは、アプリを作成していきましょう。まず、Database Connector からデータを読み込み、一覧画面に表示するためのデータモデルを定義します。データを読み込む前に、データモデルを作成しておきます。

MyFirstModule の「Domain model」に Entity を追加します。
Entity 名とフィールド定義を入力します。
DBeaver などのツールを使用して、CData JDBC ドライバー経由でテーブル定義情報を確認すると、データの設定を簡単に行えます。
Entity を定義します。

JDBC URL 用の定数を作成

次に、Database Connector で使用する JDBC URL の定数を作成します。

MyFirstModule に「Constant」を追加します。
Add Constant ウィンドウで定数に名前を付けます。
Bitbucket に接続するための JDBC URL を生成します。jdbc:bitbucket: で始まり、セミコロンで区切られた一連の接続文字列プロパティを続けます。

ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、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を設定します。
組み込みの接続文字列デザイナー

JDBC URL の構成には、Bitbucket JDBC ドライバーに組み込まれている接続文字列デザイナーが便利です。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
```
java -jar cdata.jdbc.bitbucket.jar
```
接続プロパティに値を入力し、接続文字列をクリップボードにコピーします。

一般的な JDBC URL は以下のとおりです。
```
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information
```
前のステップでコピーした接続文字列を Default value セクションに入力し、OK をクリックします。

Bitbucket のデータを取得するマイクロフローの作成

作成した Entity に基づいて、Database Connector からデータを取得するマイクロフローを作成しましょう。

MyFirstModule から「Add microflow」をクリックします。
任意の名前でマイクロフローを作成します。
まず、先ほど定義した Entity 用のオブジェクトを作成します。マイクロフローに「Create Object」アクションを追加します。
Create Object ウィンドウで、Entity の「Select」ボタンをクリックします。
先ほど定義した Entity を選択します。
任意の Object name を入力し、OK をクリックします。
次に、Database Connector からデータを取得するために、マイクロフローに Execute Query アクションを追加します。
Execute Query ウィンドウで各入力項目を定義します。
「jdbc url」には、先ほど定義した定数を指定します。
SQL には、Bitbucket からデータを取得するクエリを記述します。
今回は Username と Password は不要なので、「empty」に設定し、前のフローで作成したオブジェクトを Result object として割り当てます。List Name セクションには任意の名前を指定します。
最後に、マイクロフローの出力を定義します。
End Event をダブルクリックして開き、Type ドロップダウンから「List」を選択し、先ほど定義した Entity とリンクします。次に、Execute Query の出力結果を Return value として設定します。
これで、Bitbucket からデータを取得するマイクロフローが完成しました。

一覧画面の作成とマイクロフローへのリンク

最後に、マイクロフローから取得した結果を表示する画面を作成しましょう。

Toolbox メニュー内の「Home_web」をダブルクリックして開きます。
Data containers セクションから Data grid テンプレートをドラッグ＆ドロップして一覧画面に配置します。
Data grid を配置したら、ダブルクリックして Edit Data Grid 設定画面を表示します。
Data source タブに移動し、データソースタイプを Microflow とリンクします。
先ほど作成したマイクロフローを選択します。
OK をクリックします。
OK をクリックすると、カラムの自動検出を促すメッセージが表示されます。「Yes」をクリックして続行します。
次に、各 Data grid 用のコントローラーを生成するかどうかを確認するメッセージが表示されます。今回は各ロジックを設定しないので、「No」をクリックします。
以下のようなシンプルな Data grid 画面が作成されます。

動作確認

それでは、正しく動作するか確認しましょう。

「Publish」ボタンをクリックして、作成したアプリを準備します。完了したら、「View App」をクリックしてアプリを開きます。
以下のような Bitbucket のデータの一覧が表示されれば成功です！Bitbucket の API を意識することなく、ローコードで Bitbucket と連携したアプリを作成できました。