製品をチェック

API Driver のダウンロード

30日間無償トライアルへ

プロファイルのダウンロード

SmartHR プロファイル

JDBI からSmartHR データ のデータアクセスオブジェクトを作成

JDBI でSmartHR データ 用のSQL オブジェクトAPIを作成する方法を概説します。

加藤龍彦
デジタルマーケティング

最終更新日:2022-05-25
smarthr ロゴ

CData

jdbc ロゴ画像
JDBI ロゴ

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

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムSmartHR データ のデータ連携を実現します。これらの技術を組み合わせることによって、SmartHR データ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するSmartHR データ の読み書きのためのコードの作成について説明します。

SmartHR Departments Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyDepartmentsDAO { //request specific data from SmartHR (String type is used for simplicity) @SqlQuery("SELECT Position FROM Departments WHERE Id = :id") String findPositionById(@Bind("id") String id); /* * close with no args is used to close the connection */ void close(); }

SmartHR への接続を開く

必要な接続プロパティを収集し、SmartHR に接続するための適切なJDBC URL を作成します。

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

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

ビルトイン接続文字列デザイナー

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

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

SmartHR の接続文字列は、通常次のようになります。

jdbc:api:Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;''InitiateOAuth=GETANDREFRESH

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;''InitiateOAuth=GETANDREFRESH"); MyDepartmentsDAO dao = dbi.open(MyDepartmentsDAO.class); //do stuff with the DAO dao.close();

SmartHR データ について

SmartHR への接続を開いた状態で以前定義したメソッドを呼び出すだけで、SmartHR のDepartments エンティティからデータを取得できます。

//disply the result of our 'find' method String position = dao.findPositionById("1"); System.out.println(position);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSmartHR を操作しましょう。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。