Python でServiceDesk Plus のデータを変換・出力するETL 処理を作る方法

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Python Connector とpetl モジュールを使って、ServiceDesk Plus のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。



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

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

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

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

pip install petl
pip install pandas

Python でServiceDesk Plus のデータをETL 処理するアプリを構築

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;")

OAuth 認証の設定

ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

  1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
  2. アプリケーション構成に合わせてリダイレクト URI を設定します
  3. アプリケーション設定から Client ID と Client Secret を控えておきます

以下の接続プロパティを設定して接続を確立してください：

  • AuthScheme：OAuth に設定します。
  • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
  • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
  • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
  • Domain：ServiceDeskPlus のドメインに設定します。
  • Portal：ServiceDeskPlus のポータルに設定します。

接続文字列の例

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

ServiceDesk Plus をクエリするSQL 文の作成

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

sql = "SELECT ,  FROM AnnouncementComments WHERE AnnouncementId = '12345'"

ServiceDesk Plus データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

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

おわりに

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


フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;")

sql = "SELECT ,  FROM AnnouncementComments WHERE AnnouncementId = '12345'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

はじめる準備はできましたか？

API Driver で ServiceDesk Plus のライブデータに接続

ServiceDesk Plus に接続

この記事の内容

関連記事