各製品の資料を入手。
詳細はこちら →
SQLAlchemy ORM を使って、Python でSmartHR のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSmartHR にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるSmartHR 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for API は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで SmartHR にデータ連携するPython アプリケーションを構築し、SmartHR のデータを可視化できます。 本記事では、SQLAlchemy でSmartHR に連携して、データを取得、 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- SmartHR をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにSmartHR のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてSmartHR の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でSmartHR のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、SmartHR のデータに連携するEngne を作成します。
engine = create_engine("api///?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 のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Departments テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Departments(base): __tablename__ = "Departments" Name = Column(String,primary_key=True) Position = Column(String) ...
SmartHR のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("api///?Profile=C:\profiles\SmartHR.apip&UseSandbox=false&ProfileSettings='APIKey=your_api_token&TenantId=1234567890&''InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Departments).filter_by(Id="1"):
print("Name: ", instance.Name)
print("Position: ", instance.Position)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Departments_table = Departments.metadata.tables["Departments"]
for instance in session.execute(Departments_table.select().where(Departments_table.c.Id == "1")):
print("Name: ", instance.Name)
print("Position: ", instance.Position)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
SmartHR からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
