Python でJira Service Desk データを変換・出力するETL 処理を作る方法

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

Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for JiraServiceDesk とpetl フレームワークを使って、Jira Service Desk データにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

CData Python Connector は効率的なデータ処理によりJira Service Desk データ にPython から接続し、高いパフォーマンスを発揮します。Jira Service Desk にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接Jira Service Desk 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。

必要なモジュールのインストール

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でJira Service Desk データをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.jiraservicedesk as mod

接続文字列で接続を確立します。connect 関数を使って、CData Jira Service Desk Connector からJira Service Desk への接続を行います

cnxn = mod.connect("ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

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

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

Jira Service Desk をクエリするSQL 文の作成

Jira Service Desk にはSQL でデータアクセスが可能です。Requests エンティティからのデータを読み出します。

sql = "SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'"

Jira Service Desk データ のETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Jira Service Desk データ を取得して、ReporterName カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'ReporterName')

etl.tocsv(table2,'requests_data.csv')

CData Python Connector for JiraServiceDesk を使えば、データベースを扱う場合と同感覚で、Jira Service Desk データ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

Jira Service Desk Python Connector の30日の無償トライアル をぜひダウンロードして、Jira Service Desk データ への接続をPython アプリやスクリプトから簡単に作成しましょう。

フルソースコード

import petl as etl
import pandas as pd
import cdata.jiraservicedesk as mod

cnxn = mod.connect("ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'ReporterName')

etl.tocsv(table2,'requests_data.csv')