SQLAlchemy ORM を使用して Python で ServiceDesk Plus のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData API Driver for Python と SQLAlchemy ツールキットを使用して、ServiceDesk Plus に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して ServiceDesk Plus のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの ServiceDesk Plus のデータ を操作する際に比類のないパフォーマンスを提供します。ServiceDesk Plus に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 ServiceDesk Plus にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

ServiceDesk Plus のデータ への接続

ServiceDesk Plus のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

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;

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて ServiceDesk Plus にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での ServiceDesk Plus のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、ServiceDesk Plus のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、AnnouncementComments テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class AnnouncementComments(base):
	__tablename__ = "AnnouncementComments"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

ServiceDesk Plus のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("api:///?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")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AnnouncementComments).filter_by(AnnouncementId="12345"):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

AnnouncementComments_table = AnnouncementComments.metadata.tables["AnnouncementComments"]
for instance in session.execute(AnnouncementComments_table.select().where(AnnouncementComments_table.c.AnnouncementId == "12345")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData API Driver for Python の30日間の無料トライアルをダウンロードして、ServiceDesk Plus のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。