DbVisualizer でClio のデータに連携しクエリを作成

加藤龍彦
デジタルマーケティング

DbVisualizer のビジュアルデータ分析ツールやデータ接続ウィザードにClio のデータを連携する方法を紹介します。

CData JDBC Driver for API は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでClio のデータへの接続を提供します。この記事では、DbVisualizer からClio のデータに接続する方法、およびtable エディタを使ってClio をロード、する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

Clio をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
DBeaver を含む多様なアプリケーション、ツールにClio のデータを連携
ノーコードでの手軽な接続設定
標準 SQL での柔軟なデータ読み込み・書き込み

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

Clio のデータの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからClio のデータに接続します。

DbVisualizer で「Tools」->「Driver Manager」をクリックします。
「」ボタンをクリックして新しくドライバーを作成します。
テンプレートは「Custom」を選択します。
Driver Settings タブで：
- Name をわかりやすい名前に設定します（例：CData Clio Driver）。
- URL Format をjdbc:api: に設定します。
- Driver artifacts and jar files (jars are loaded in order from top) セクションで：
  1. 「」ボタンをクリックして、「Add Files」に進みます。
  2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Clio XXXX\）の「lib」フォルダに移動します。
  3. JAR ファイル（cdata.jdbc.API.jar）を選択して「Open」をクリックします。
Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.api.APIDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。
「Connection」セクションで以下のオプションを設定します。
- Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
- Driver Type：先ほど作成したドライバーを選択します。
- Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:api: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。
  
  まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。
  
  Clio API プロファイル設定
  
  Clio はOAuth ベースの認証を使用します。
  
  まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。
  
  以下の接続プロパティを設定すると、接続できるようになります。
  - AuthScheme：OAuth に設定します。
  - InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
  - OAuthClientId：アプリ設定で指定されたclient_id に設定します。
  - OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
  - CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
  - Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。
  組み込みの接続文字列デザイナー
  
  JDBC URL の作成の補助として、Clio JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
```
java -jar cdata.jdbc.api.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。
  
  一般的な接続文字列は次のとおりです。
```
jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
```
- NOTE：Clio は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
「Connection」タブで「Connect」をクリックします。