ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →Jira Service Desk Connector の30日間無償トライアルをダウンロード
30日間の無償トライアルへ製品の詳細
Jira Service Desk Python Connector 相談したいJira Service Desk データ連携用Python コネクタライブラリ。Jira Service Desk データをpandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。
CData
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for JiraServiceDesk は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Jira Service Desk にデータ連携するPython アプリケーションを構築し、Jira Service Desk データを可視化できます。 本記事では、SQLAlchemy でJira Service Desk に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors は、以下のような特徴を持った製品です。
CData Python Connectors では、1.データソースとしてJira Service Desk の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
pip でSQLAlchemy ツールキットをインストールします:
pip install sqlalchemy
モジュールのインポートを忘れずに行います:
import sqlalchemy
次は、接続文字列で接続を確立します。create_engine 関数を使って、Jira Service Desk データに連携するEngne を作成します。
engine = create_engine("jiraservicedesk///?ApiKey=myApiKey&User=MyUser&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。
デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。
ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。
Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。
データに接続するには以下を設定します。
ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。
この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Requests テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。
base = declarative_base() class Requests(base): __tablename__ = "Requests" RequestId = Column(String,primary_key=True) ReporterName = Column(String) ...
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションの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 に対して有効です。
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 Desk データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Jira Service Desk にすべての追加インスタンスを送ります。
new_rec = Requests(RequestId="placeholder", CurrentStatus="Open") session.add(new_rec) session.commit()
Jira Service Desk データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Jira Service Desk にレコードを追加します。
updated_rec = session.query(Requests).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.CurrentStatus = "Open" session.commit()
Jira Service Desk データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Requests).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。