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

Jerod Johnson
Director, Technology Evangelism

CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのServiceNow のデータを抽出・変換・ロードするETLパイプラインの構築方法を解説。読み取りから書き込みまで対応します。

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

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

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

Python + petl でできること

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

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

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

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

ServiceNow への書き戻し処理の自動化

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

ServiceNow データ連携について

CData は、ServiceNow のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：

CData はデータには REST API を、スキーマには SOAP API を使用するため、最適化されたパフォーマンスを実現できます。
Schedules、Timelines、Questions、Syslogs などの ServiceNow オブジェクトの読み取り、書き込み、更新、削除ができます。
SQL ストアドプロシージャを使用して、カートへのアイテム追加、注文の送信、添付ファイルのダウンロードなどのアクションを実行できます。
Basic（ユーザー名とパスワード）、OKTA、ADFS、OneLogin、PingFederate 認証スキームを含め、ServiceNow に安全に認証できます。

多くのユーザーは、Tableau、Power BI、Excel などのお気に入りの分析ツールからライブ ServiceNow データにアクセスし、CData ソリューションを使用して ServiceNow データをデータベースやデータウェアハウスに統合しています。

はじめに

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

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

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

「Add Connection」パネルから「ServiceNow」を選択します

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

OAuth 認証を介した接続について詳しくは、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
「Save & Test」をクリックします
「Permissions」タブに移動し、ユーザーベースの権限を更新します。

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

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

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

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

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

pip install cdata-connect-ai
pip install petl

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

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

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

import petl as etl
import cdata_connect_ai

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

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

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

sql = (
    "SELECT sys_id, priority "
    "FROM [ServiceNow1].[ServiceNow].[incident] "
    "WHERE category = 'request'"
)

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

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

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'priority')

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

新しい行を ServiceNow に書き戻す方法は？

ServiceNow が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [ServiceNow1].[ServiceNow].[incident] (sys_id, priority) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

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