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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData JDBC ドライバとは？

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

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

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

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

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

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

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

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

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:jiraservicedesk: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Jira Service Management 接続プロパティの取得・設定方法

     任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

     • URL（例：https://yoursitename.atlassian.net）

     カスタムフィールドへのアクセス

     デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

     Jira Service Management への認証

     ベーシック認証

     ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

     • AuthScheme：Basic に設定。
     • User：認証ユーザーのユーザー名に設定。
     • Password：認証ユーザーのパスワードに設定。

     API トークン

     Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

     データに接続するには以下を設定します。

     • AuthScheme：APIToken に設定。
     • User：認証ユーザーのユーザー名に設定。
     • APIToken：作成したAPI トークンに設定。

     ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

     OAuth 2.0

     Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

     この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

     JDBC URL の作成の補助として、Jira Service Management JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.jiraservicedesk.jar

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

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH
3. 「Connection」タブで「Connect」をクリックします。

Jira Service Management JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに