ServiceDesk Plus のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのServiceDesk Plus のデータを抽出・変換するETLパイプラインの構築方法を解説。

CData Connect AI の Python SDK と petl フレームワークを使うと、ServiceDesk Plus のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、ServiceDesk Plus のデータを抽出・変換して CSV などに出力する ServiceDesk Plus 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってServiceDesk Plus のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

ServiceDesk Plus データの定期抽出パイプライン構築

SQL クエリで取得した ServiceDesk Plus のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで ServiceDesk Plus 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

ServiceDesk Plus への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを ServiceDesk Plus に自動で書き戻す処理を組み込めます。

Connect AI で ServiceDesk Plus に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「ServiceDesk Plus」を選択します
    3. データソースの選択
  3. ServiceDesk Plus に接続するために必要な認証プロパティを入力します。

    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;

    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で ServiceDesk Plus のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

ServiceDesk Plus をクエリする SQL ステートメントを作成する方法は？

SQL を使って、ServiceDesk Plus をクエリするステートメントを作成します。この記事では、AnnouncementComments エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：API1）になります。

sql = (
    "SELECT ,  "
    "FROM [API1].[API].[AnnouncementComments] "
    "WHERE AnnouncementId = '12345'"
)

ServiceDesk Plus のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってServiceDesk Plus のデータを抽出・変換・ロードします。この例では、ServiceDesk Plus のデータを抽出し、 カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, '')

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

ServiceDesk Plus は Connect AI では読み取り専用のソースのため、このパイプラインではServiceDesk Plus のデータの抽出と変換はできますが、行の書き戻しはできません。抽出が完了したら接続を閉じましょう。

conn.close()

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにServiceDesk Plus のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのServiceDesk Plus のデータをパイプライン処理できるようになりました。ServiceDesk Plus（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT ,  "
    "FROM [API1].[API].[AnnouncementComments] "
    "WHERE AnnouncementId = '12345'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, '')

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

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

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事