各製品の資料を入手。
詳細はこちら →
製品をチェック
Python でJira Service Management のデータを変換・出力するETL 処理を作る方法
CData Python Connector とpetl モジュールを使って、Jira Service Management のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。
最終更新日：2023-09-23
この記事で実現できるJira Service Management 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for JiraServiceDesk とpetl フレームワークを使って、Jira Service Management のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。
CData Python Connector は効率的なデータ処理によりJira Service Management のデータ にPython から接続し、高いパフォーマンスを発揮します。Jira Service Management にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接Jira Service Management 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。
必要なモジュールのインストール
pip で必要なモジュールおよびフレームワークをインストールします：
pip install petl pip install pandas
Python でJira Service Management のデータをETL 処理するアプリを構築
モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。
CData Connector を含むモジュールをインポートします。
import petl as etl import pandas as pd import cdata.jiraservicedesk as mod
接続文字列で接続を確立します。connect 関数を使って、CData Jira Service Management Connector からJira Service Management への接続を行います
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
Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。
Jira Service Management をクエリするSQL 文の作成
Jira Service Management にはSQL でデータアクセスが可能です。Requests エンティティからのデータを読み出します。
sql = "SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'"
Jira Service Management データ のETL 処理
DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Jira Service Management のデータ を取得して、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 Management のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。
おわりに
Jira Service Management Python Connector の30日の無償トライアル をぜひダウンロードして、Jira Service Management のデータ への接続を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')
関連コンテンツ
