SQLAlchemy ORM を使って、Python でJira Service Management のデータに連携する方法

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

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for JiraServiceDesk は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Jira Service Management にデータ連携するPython アプリケーションを構築し、Jira Service Management のデータを可視化できます。 本記事では、SQLAlchemy でJira Service Management に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Jira Service Management をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにJira Service Management のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてJira Service Management の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でJira Service Management のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Jira Service Management のデータに連携するEngne を作成します。

engine = create_engine("jiraservicedesk///?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 Management のデータのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Requests テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Requests(base):
	__tablename__ = "Requests"
	RequestId = Column(String,primary_key=True)
	ReporterName = Column(String)
	...

Jira Service Management のデータをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("jiraservicedesk///?ApiKey=myApiKey&User=MyUser&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Requests).filter_by(CurrentStatus="Open"):
	print("RequestId: ", instance.RequestId)
	print("ReporterName: ", instance.ReporterName)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Requests_table = Requests.metadata.tables["Requests"]
for instance in session.execute(Requests_table.select().where(Requests_table.c.CurrentStatus == "Open")):
	print("RequestId: ", instance.RequestId)
	print("ReporterName: ", instance.ReporterName)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Jira Service Management のデータの挿入（INSERT）

Jira Service Management のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Jira Service Management にすべての追加インスタンスを送ります。

new_rec = Requests(RequestId="placeholder", CurrentStatus="Open")
session.add(new_rec)
session.commit()

Jira Service Management のデータを更新（UPDATE）

Jira Service Management のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Jira Service Management にレコードを追加します。

updated_rec = session.query(Requests).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CurrentStatus = "Open"
session.commit()

Jira Service Management のデータを削除（DELETE）

Jira Service Management のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Requests).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Jira Service Management からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。