各製品の資料を入手。
詳細はこちら →
製品をチェック
Jira Service Management Driver の30日間無償トライアルをダウンロード
30日間の無償トライアルへ
ETL ツールのEmbulk を使ってJira Service Management のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、Jira Service Management のデータを簡単にDB に同期する方法をご紹介します。
最終更新日：2023-10-13
この記事で実現できるJira Service Management 連携のシナリオ
こんにちは！リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for JiraServiceDesk を使って、Jira Service Management のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でJira Service Management のデータをロード
- CData JDBC Driver for JiraServiceDesk をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for JiraServiceDesk 2019J\lib\cdata.jdbc.jiraservicedesk.jar 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbcインストール用のコマンドはこちら：
embulk gem install embulk-input-jdbc今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlコマンドはこちら。
embulk gem install embulk-output-mysql- config ファイルを作成し、Jira Service Management -> MySQL のジョブを作成します。jiraservicedesk-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
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」セクションを参照してください。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for JiraServiceDesk 2025J\lib\cdata.jdbc.jiraservicedesk.jar
driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=REFRESH
table: "Requests"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Requests"
mode: insert
embulk run jiraservicedesk-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for JiraServiceDesk 2019J\lib\cdata.jdbc.jiraservicedesk.jar
driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=REFRESH
query: "SELECT RequestId, ReporterName FROM Requests WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Requests"
mode: insert
おわりに
CData JDBC Driver for JiraServiceDesk をEmbulk で使うことで、Jira Service Management と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。
関連コンテンツ
