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

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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;''InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

SmartHR に接続するには、SmartHR API トークンとTenantId が必要です。API トークンはSmartHR のアプリケーション統合ページで生成できます。トークンを取得したら、ProfileSettings API Key 接続プロパティに指定してください。TenantId は自身のSmartHR ページのURL「https://1234567890.smarthr.jp/」で確認できます（ここでは「1234567890」）。もしSandbox 環境を使用する場合は、接続プロパティにUseSandbox=true を設定してください。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

SmartHR をクエリするSQL 文の作成

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

sql = "SELECT Name, Position FROM Departments WHERE Id = '1'"

SmartHR データ のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;''InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Name, Position FROM Departments WHERE Id = '1'"

table1 = etl.fromdb(cnxn,sql)

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

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