Python で pandas を使って Paylocity データを可視化する方法

Python の豊富なエコシステムを活用することで、作業を迅速に開始し、システム間の連携をより効果的に行うことができます。CData Python Connector for Paylocity、pandas および Matplotlib モジュール、SQLAlchemy ツールキットを組み合わせることで、Paylocity に接続した Python アプリケーションやスクリプトを構築し、Paylocity のデータを可視化できます。この記事では、pandas、SQLAlchemy、Matplotlib の組み込み関数を使用して Paylocity のデータに接続し、クエリを実行して結果を可視化する方法を説明します。

CData Python Connector は、組み込みの最適化されたデータ処理機能により、Python での Paylocity のデータへのリアルタイムアクセスにおいて比類のないパフォーマンスを提供します。Paylocity に対して複雑な SQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を Paylocity に直接プッシュし、サポートされていない操作（多くの場合、SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Paylocity のデータへの接続

Paylocity のデータへの接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Paylocity への接続を確立するには以下を設定します。

• RSAPublicKey：Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。

  このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。

• UseSandbox：サンドボックスアカウントを使用する場合はTrue に設定。
• CustomFieldsCategory：Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
• Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。これはコンテンツを暗号化するためのキーです。

  Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
  これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。

• IV：コンテンツを暗号化するときに使用するAES IV（base 64 エンコード）。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。

OAuth

OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。

Pay Entry API

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。

UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。

以下の手順に従って、必要なモジュールをインストールし、Python オブジェクトを介して Paylocity にアクセスしてみましょう。

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

pip ユーティリティを使用して、pandas、Matplotlib モジュール、および SQLAlchemy ツールキットをインストールします。

pip install pandas
pip install matplotlib
pip install sqlalchemy

以下のようにモジュールをインポートしてください。

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Python で Paylocity のデータを可視化する

接続文字列を使用して接続できます。create_engine 関数を使用して、Paylocity のデータを操作するための Engine を作成します。

engine = create_engine("paylocity:///?OAuthClientID=YourClientId&OAuthClientSecret=YourClientSecret&RSAPublicKey=YourRSAPubKey&Key=YourKey&IV=YourIV")

Paylocity への SQL の実行

pandas の read_sql 関数を使用して、SQL ステートメントを実行し、結果セットを DataFrame に格納します。

df = pandas.read_sql("SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'", engine)

Paylocity のデータの可視化

クエリ結果が DataFrame に格納されたら、plot 関数を使用して Paylocity のデータを表示するグラフを作成します。show メソッドで、グラフを新しいウィンドウに表示します。

df.plot(kind="bar", x="FirstName", y="LastName")
plt.show()

無料トライアル & 詳細情報

CData Python Connector for Paylocity の 30日間無料トライアルをダウンロードして、Paylocity のデータに接続する Python アプリケーションやスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお気軽にお問い合わせください。

完全なソースコード

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("paylocity:///?OAuthClientID=YourClientId&OAuthClientSecret=YourClientSecret&RSAPublicKey=YourRSAPubKey&Key=YourKey&IV=YourIV")
df = pandas.read_sql("SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'", engine)

df.plot(kind="bar", x="FirstName", y="LastName")
plt.show()