ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →Paylocity Connector の30日間無償トライアルをダウンロード
30日間の無償トライアルへ製品の詳細
Paylocity Python Connector 相談したいPaylocity へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにPaylocity をシームレスに統合。
CData
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Paylocity は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Paylocity にデータ連携するPython アプリケーションを構築し、Paylocity データを可視化できます。 本記事では、SQLAlchemy でPaylocity に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors は、以下のような特徴を持った製品です。
CData Python Connectors では、1.データソースとしてPaylocity の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
pip でSQLAlchemy ツールキットをインストールします:
pip install sqlalchemy
モジュールのインポートを忘れずに行います:
import sqlalchemy
次は、接続文字列で接続を確立します。create_engine 関数を使って、Paylocity データに連携するEngne を作成します。
engine = create_engine("paylocity///?OAuthClientID=YourClientId&OAuthClientSecret=YourClientSecret&RSAPublicKey=YourRSAPubKey&Key=YourKey&IV=YourIV&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Paylocity への接続を確立するには以下を設定します。
このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。
Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。
OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。
Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。
UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Employee テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。
base = declarative_base() class Employee(base): __tablename__ = "Employee" FirstName = Column(String,primary_key=True) LastName = Column(String) ...
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
engine = create_engine("paylocity///?OAuthClientID=YourClientId&OAuthClientSecret=YourClientSecret&RSAPublicKey=YourRSAPubKey&Key=YourKey&IV=YourIV&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Employee).filter_by(EmployeeId="1234"): print("FirstName: ", instance.FirstName) print("LastName: ", instance.LastName) print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
Employee_table = Employee.metadata.tables["Employee"] for instance in session.execute(Employee_table.select().where(Employee_table.c.EmployeeId == "1234")): print("FirstName: ", instance.FirstName) print("LastName: ", instance.LastName) print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Paylocity データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Paylocity にすべての追加インスタンスを送ります。
new_rec = Employee(FirstName="placeholder", EmployeeId="1234") session.add(new_rec) session.commit()
Paylocity データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Paylocity にレコードを追加します。
updated_rec = session.query(Employee).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.EmployeeId = "1234" session.commit()
Paylocity データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Employee).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。