OData を介してTIBCO Spotfire でfreee人事労務 のデータをビジュアライズ

OData は、クラウドベース、モバイル、およびその他のオンラインアプリケーション間のリアルタイム通信を可能にする主要なプロトコルです。CData API Server は、freee人事労務 のADO.NET Provider for API と組み合わせると、freee人事労務 のデータ（またはその他の250+ のADO.NET Providers データ）をTIBCO Spotfire などのOData コンシューマに提供します。この記事では、API Server とSpotfire のOData の組み込みサポートを使用して、freee人事労務 のデータにリアルタイムでアクセスする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなfreee人事労務 OData サービスを作成していきましょう。

freee人事労務 への接続

TIBCO Spotfire からfreee人事労務 のデータを操作するには、まずfreee人事労務 への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「freee人事労務」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、freee人事労務 への接続設定を行っていきましょう！

5. まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

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

   その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

   • AuthScheme：OAuth に設定します。
   • OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
   • OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
   • CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

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

その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

• AuthScheme：OAuth に設定します。
• OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
• OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
• CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

API Server のユーザー設定

次に、API Server 経由でfreee人事労務 にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

freee人事労務 用のAPI エンドポイントの作成

ユーザーを作成したら、freee人事労務 のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でfreee人事労務 への接続を設定してユーザーを作成し、API Server でfreee人事労務 データのAPI を追加しました。これで、OData 形式のfreee人事労務 データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

外部freee人事労務 のデータでデータビジュアライゼーションを作成する

1. Spotfire を開き、「Add Data Tables」->「OData」をクリックします。
2. 「OData Connection」ダイアログで、以下の情報を入力します。
   • Service URL：API Server のOData エンドポイントを入力します。例：

     http://localhost:8032/api.rsc

   • Authentication Method：Username とPassword を選択します。
   • Username：API Server ユーザーのユーザー名を入力します。管理コンソールの「Security」タブでAPI ユーザーを作成できます。
   • Password：API Server でユーザーの認証トークンを入力します。
   
3. ダッシュボードに追加するテーブルとカラムを選択します。この例ではEmployees を使います。
4. リアルタイムデータを使いたい場合は、「Keep Data Table External」オプションをクリックします。このオプションは、データの変更をリアルタイムでダッシュボードに反映します。

   データをメモリにロードしてローカルで処理したい場合は、「Import Data Table」オプションをクリックします。このオプションは、オフラインでの使用、またはネットワーク接続が遅くダッシュボードとのやり取りが遅延する場合に適しています。

5. テーブルを追加すると「Recommended Visualizations」ウィザードが表示されます。テーブルを選択すると、Spotfire はカラムのデータ型を使ってnumber、time、category カラムを検出します。この例ではNumbers セクションでDisplayName を、Categories セクションでId を使用しています。

［Recommended Visualizations］ウィザードでいくつかビジュアライズを作成したら、ダッシュボードにその他の修正を加えることができ、例えばフィルタを適用できます。「Filter」ボタンをクリックすると、各クエリで使用可能なフィルタが「Filters」ペインに表示されます。