Active Query Builder を使用してAha 駆動型アプリを素早く開発

古川えりか
コンテンツスペシャリスト

Active Query Builder SQL インターフェースビルダーと、.NET データアクセスの簡単さを活用し、データ駆動型のWinForms とASP.NET アプリを作成します。

SQL インターフェースを介してAha を公開する標準.NET を記述します。Active Query Builder は、開発者がSQL インターフェースを作成するのに役立ちます。CData ODBC Driver for API は、Aha への標準ベースのアクセスを可能にします。この統合では、ODBC ドライバーとActive Query Builder オブジェクト間のブリッジとして、Microsoft ADO.NET Provider for ODBC を使用してビジュアルSQL コンポーザーを構築します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

Aha をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
多様なアプリケーション、ツールにAha のデータを連携
ノーコードでの手軽な接続設定
標準SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてAha の接続を設定、2.Active Query Builder 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとAha への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

未指定の場合は、初めに ODBC DSN（データソース名）で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成および設定できます。

まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します（例：C:\profiles\aha.apip）。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します（以下を参照）。

Aha! API プロファイル設定

Aha! API はOAuth ベースの認証を使用します。

まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名にあるDomain を設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。

以下の項目を接続文字列に設定すると、接続できるようになります。

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定されたclient_id に設定します。
OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
CallbackURL：アプリ設定で指定したRedirect URI に設定します。
Domain：ProfileSettings でAha ドメインに設定します。

SQL を使用してAha と対話

以下のステップに従ってWinForms ビジュアルクエリビルダーを作成します。

新しいWindows Forms プロジェクトで、QueryBuilder を［Toolbox］からフォームにドラッグします。
ActiveQueryBuilder.ODBCMetadataProvider への参照を追加します。
OdbcConnection を追加し、最初のセクションで作成したDSN に接続文字列を設定します。
```
OdbcConnection connection = new OdbcConnection();
connection.ConnectionString = "DSN=API"
```
ODBCMetadataProvider インスタンスとGeneralSyntaxProvider インスタンスを初期化し、ODBCMetadataProvider オブジェクトのConnection プロパティをOdbcConnection に設定します。
```
GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider();
ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider();
metadataProvider.Connection = connection;
```
QueryBuilder オブジェクトの、対応するMetadataProvider プロパティとSyntaxProvider プロパティを設定します。
```
  queryBuilder1.MetadataProvider = metadataProvider;
  queryBuilder1.SyntaxProvider = syntaxProvider;
```
QueryBuilder クラスのInitiatelizeDatabaseSchemaTree メソッドを呼び出してAha メタデータを取得し、Aha テーブルのツリーデビューを生成します。
```
queryBuilder1.InitializeDatabaseSchemaTree();
```
QueryBuilder を作成したら、それをTextBox に接続するか、使用する場合は、ActiveQueryBuilder SQLTextEditor に接続しますSQLTextEditor をデザイナにドラッグし、ドロップします。

以下のコードをSQLTextEditor のValidating イベントに追加します。

private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) {
  try {

    // Update the query builder with manually edited query text:
    queryBuilder1.SQL = sqlTextEditor1.Text;
  }
  catch (SQLParsingException ex) {
    e.Cancel = true;

    // Set caret to error position
    sqlTextEditor1.SelectionStart = ex.ErrorPos.pos;

    // Report error
    MessageBox.Show(ex.Message, "Parsing error");
  }
}

SQLUpdated イベントに以下を追加します。

private void queryBuilder1_SQLUpdated(object sender, EventArgs e) {
  sqlTextEditor1.Text = queryBuilder1.FormattedSQL;
}

これで、クエリをビジュアルに作成できます。［Columns Pane Area］のテーブルをダブルクリックすると、［entity/relationship］ダイアグラムが［Query Building Area］に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。

はじめる準備はできましたか？

API Driver で Aha のライブデータに接続

Aha に接続お問い合わせ