SQLAlchemy ORM を使って、Python でServiceNow データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でServiceNow データをモデル化

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

engine = create_engine("servicenow///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&Username=MyUsername&Password=MyPassword&Instance=MyInstance&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

ServiceNow はOAuth 2.0 認証標準を利用しています。OAuth を使って認証するには、ServiceNow にOAuth アプリを登録してOAuthClientId を取得しなければなりません。OAuth 値の他に、Instance、User、およびPassword の指定が必要です。

OAuth 認証を介した接続について詳しくは、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

ServiceNow データのマッピングクラスの宣言

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

base = declarative_base()
class incident(base):
	__tablename__ = "incident"
	sys_id = Column(String,primary_key=True)
	priority = Column(String)
	...

ServiceNow データをクエリ

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

query メソッドを使う

engine = create_engine("servicenow///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&Username=MyUsername&Password=MyPassword&Instance=MyInstance&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(incident).filter_by(category="request"):
	print("sys_id: ", instance.sys_id)
	print("priority: ", instance.priority)
	print("---------")

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

execute メソッドを使う

incident_table = incident.metadata.tables["incident"]
for instance in session.execute(incident_table.select().where(incident_table.c.category == "request")):
	print("sys_id: ", instance.sys_id)
	print("priority: ", instance.priority)
	print("---------")

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

ServiceNow データの挿入（INSERT）

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

new_rec = incident(sys_id="placeholder", category="request")
session.add(new_rec)
session.commit()

ServiceNow データを更新（UPDATE）

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

updated_rec = session.query(incident).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.category = "request"
session.commit()

ServiceNow データを削除（DELETE）

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

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

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

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

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