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

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

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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

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

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

ProfileSettings：ProfileSettings でAccountId を設定します。
AuthScheme：OAuth に設定します。
OAuthClientId：アプリ設定で指定したclient ID に設定します。
OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
CallbackURL：アプリ設定で指定したRedirect URI に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

SQL を使用してHarvest と対話

以下のステップに従って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 メソッドを呼び出してHarvest メタデータを取得し、Harvest テーブルのツリーデビューを生成します。
```
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 で Harvest のライブデータに接続

Harvest に接続お問い合わせ