Spring Boot からPaylocity のデータに接続する方法

Jerod Johnson
Senior Technology Evangelist

CData JDBC Paylocity Driver を使用してSpring Boot アプリケーションからPaylocity に接続。

Spring Boot は、Java Web アプリケーションの開発を容易にするフレームワークです。最小限の設定でスタンドアロンアプリケーションを作成できるのが特徴です。 CData JDBC Driver for Paylocity と組み合わせることで、Spring Boot からリアルタイムのPaylocity のデータを扱えるようになります。この記事では、CData JDBC Driver for Paylocity を使用してSpring Boot アプリケーションでデータソースを設定し、データを取得する方法を説明します。

ビルトインの最適化されたデータ処理機能により、CData JDBC Driver はリアルタイムのPaylocity のデータとのやり取りにおいて比類のないパフォーマンスを発揮します。Paylocity に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を直接Paylocity にプッシュし、サポートされていない操作（多くの場合SQL 関数や JOIN 操作）は組み込みのSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用して Paylocity のデータを操作・分析できます。

Java でSpring Boot プロジェクトを作成

IDE（このチュートリアルではIntelliJ を使用）で、Maven プロジェクトを選択します：新しいMaven プロジェクトを作成生成されたプロジェクトで、pom.xml ファイルを開き、Spring Boot に必要な依存関係を追加します：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.2</version>
<relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<build>
<plugins>
	<plugin>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-maven-plugin</artifactId>
	</plugin>

	<plugin>
		<groupId>org.apache.maven.plugins</groupId>
		<artifactId>maven-install-plugin</artifactId>
		<version>2.5.1</version>
		<executions>
			<execution>
				<id>id.install-file</id>
				<phase>clean</phase>
				<goals>
					<goal>install-file</goal>
				</goals>
				<configuration>
					<file>C:\Program Files\CData[product_name] ####\lib\cdata.jdbc.paylocity.jar</file>
					<groupId>org.cdata.connectors</groupId>
					<artifactId>cdata-paylocity-connector</artifactId>
					<version>23</version>
					<packaging>jar</packaging>
				</configuration>
			</execution>
		</executions>
	</plugin>
</plugins>
</build>

<dependencies>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-jdbc</artifactId>
	<version>2.7.0</version>
</dependency>
<dependency>
	<groupId>org.cdata.connectors</groupId>
	<artifactId>cdata-paylocity-connector</artifactId>
	<version>23</version>
</dependency>

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<scope>test</scope>
</dependency>
</dependencies>



<distributionManagement>
<repository>
	<uniqueVersion>false</uniqueVersion>
	<id>test</id>
	<name>My Repository</name>
	<url>scp://repo/maven2</url>
	<layout>default</layout>
</repository>
</distributionManagement>

</project>

Note: 年（####）とバージョン番号（上記のXML スクリプトに記載）は、使用しているCData JDBC Driver の現在のバージョンに合わせて調整してください。

プロジェクト構造

java ディレクトリに新しいパッケージを作成します。通常、パッケージ名はgroupId （com.example）の後にartifactId（.MDS）を付けたものになります。 java フォルダに新しいパッケージを作成パッケージ名を入力

「java」ディレクトリを「Sources Root」としてマーク（青色で表示）します。これを行うには、java ディレクトリを右クリックし、「Mark Directory as」->「Sources Root」を選択します（以下を参照）。また、「resources」ディレクトリを「Resources Root」としてマークします。ディレクトリをSources Root としてマーク

データベース接続プロパティの保存

データベース接続プロパティを保存するための「application.properties」ファイルを作成します。これを行うには、「resources」フォルダを右クリックし、「New」->「File」を選択し、ファイル名を「application.properties」と入力してEnter を押します。新しい（設定）ファイルを作成ファイル名をapplication.properties とする

application.properties ファイルで、クラス名とJDBC URL を使用してPaylocity JDBC Driver の設定プロパティを設定します：

	spring.datasource.driver=cdata.jdbc.paylocity.PaylocityDriver
	spring.datasource.url=jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

組み込みの接続文字列デザイナー

JDBC URL の作成については、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

java -jar cdata.jdbc.paylocity.jar

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 を設定することを意味します。組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）

application.properties ファイルでプロパティを設定したら、次にそれらを構成します。

データソースの設定

まず、Paylocity データソースをプライマリデータソースとしてマークします。次に、データソースBean を作成します。

DriverManagerDataSource.java ファイルを作成し、以下のようにBean を作成します。@Bean でエラーが発生する場合、 Spring Boot が正しくロードされていない可能性があります。これを修正するには、「File」->「Invalidate Caches」でキャッシュを無効にして再起動します。また、Maven がSpring Boot の依存関係を追加していることを確認してください。

データソースBean を作成するには、DriverManagerDataSource クラスを使用します。このクラスを使用すると、データソースのプロパティを設定できます。このJava クラスを作成するには、「com.example.MDS」パッケージを右クリックし、「New」->「Java Class」を選択します。新しいJava クラスを作成

以下のコードは、データソースのBean 定義を示しています。各ドライバーにはBean が必要です。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Primary;
import org.springframework.core.env.Environment;
import javax.sql.DataSource;

public class DriverManagerDataSource{
	@Autowired
	private static Environment env;

	@Bean(name ="Paylocity")
	@Primary
	public static DataSource PaylocityDataSource()
	{

	DataSourceBuilder<?> dataSourceBuilder = DataSourceBuilder.create();
		dataSourceBuilder.driverClassName("cdata.jdbc.paylocity.PaylocityDriver");
		dataSourceBuilder.url("jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;");
		return dataSourceBuilder.build();
	}

	//@Override
	public void setEnvironment( final Environment environment) {
	env=environment;
	}
}

次に、Paylocity jar ファイルをDocuments フォルダに移動します（以下のコマンドのパスを参照）。jar ファイルのパスにスペースが含まれないようにするためです。次に、 Maven アイコン（IntelliJ の右上隅）をクリックし、「Execute Maven Goal」をクリックします。以下のコマンドを実行します： Maven Goal を実行 Maven install コマンドを実行

mvn install:install-file "-Dfile=C:\Program Files\CData[product_name] ####\lib\cdata.jdbc.paylocity.jar" -DgroupId=org.cdata.connectors -DartifactId=cdata-paylocity-connector -Dversion=23 -Dpackaging=jar

このコマンドを実行するには、以下のいずれかの手順に従ってください：

「-Dfile location」はCData JDBC Driver のデフォルトのインストールパスのままにできます。この場合、パスを引用符で囲んでください。また、使用しているドライバーの現在のバージョンに基づいて年と「Dversion」を変更してください。
記事の前半で述べたように、 jar ファイルをDocuments フォルダに移動した場合は、提供されたコマンドのパスを変更してください。この場合、Dfile location を引用符で囲まないでください。使用しているドライバーの現在のバージョンに基づいて「Dversion」を編集してください。

Enter を押すと、以下の出力が表示されます： JDBC Driver のインストール成功

接続のテスト

最後のステップは接続のテストです。（例：「MDSApplication」）の形式で新しいJava クラスを作成します。アプリケーションクラスには任意の名前を選択できます。 MDSApplication.java のmain メソッドでデータソースを呼び出します：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import java.sql.Connection;
import java.sql.SQLException;
import static com.example.demo.DriverManagerDataSources.PaylocityDataSource;


@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
	public class MDSApplication {
		//remove the comment on the line below
		public static void main (){
		SpringApplication.run(DemoApplication.class, args);
		Connection conn = PaylocityDataSource().getConnection();
		System.out.println("Catalog: "+ conn.getCatalog());
	}
}

生成される出力は以下のようになります：テスト接続成功