Jaspersoft Studio から Workday のデータに接続
この記事では、CData JDBC Driver for Workday を使って、Jaspersoft Studio からWorkday に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってWorkday へのSQL クエリを作成していきます。クエリは直接Workday API に実行されるため、Workday のデータへのリアルタイム接続が可能になります。
Workday データ連携について
CData は、Workday のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:
- Prism Analytics Data Catalog で作成したテーブルやデータセットにアクセスでき、Workday システムの忠実性を損なうことなく、ネイティブの Workday データハブを操作できます。
- Workday Reports-as-a-Service にアクセスして、Prism から利用できない部門データセットや、Prism の許容サイズを超えるデータセットのデータを表示できます。
- WQL、REST、または SOAP でベースデータオブジェクトにアクセスし、より詳細で細かいアクセスを実現できます(ただし、クエリの作成には Workday 管理者や IT の支援が必要な場合があります)。
ユーザーは、Tableau、Power BI、Excel などの分析ツールと Workday を統合し、当社のツールを活用して Workday データをデータベースやデータウェアハウスにレプリケートしています。アクセスは、認証されたユーザーの ID とロールに基づいて、ユーザーレベルで保護されます。
Workday を CData と連携させるための設定についての詳細は、ナレッジベース記事をご覧ください:Comprehensive Workday Connectivity through Workday WQL および Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices
はじめに
Workday のデータにJDBC データソースとして接続
Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。
- Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
- Database JDBC Connection を選択します。
- ドライバーのわかりやすい名前を入力します。
- Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
- Database Location タブで、JDBC ドライバーのクラス名を入力します:cdata.jdbc.workday.WorkdayDriver
- JDBC URL を入力します。
Workday 接続プロパティの取得・設定方法
ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。
接続の前提条件
API / 前提条件 / 接続パラメータ
WQL / WQL サービスを有効化(下記参照) / ConnectionType: WQL
Reports as a Service / カタログレポートの設定(ヘルプドキュメントの「データアクセスのファインチューニング」参照) / ConnectionType: Reports
REST / 自動で有効化 / ConnectionType: REST
SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照BaseURL およびTenant の取得
BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。
REST API Endpoint のフォーマットは、 https://domain.com/
/mycompany です。ここで、
- https://domain.com(URL のサブディレクトリと会社名の前の部分)はBaseURL です。
- mycompany(URL の最後のスラッシュの後の部分)はTenant です。
例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。
WQL サービスを有効化
Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。- Workday を開きます。
- 検索バーにView Domain と入力します。
- プロンプトにWorkday Query Language と入力します。
- Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。
Workday への認証
Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。組み込みの接続文字列デザイナー
JDBC URL の構成をサポートするために、Workday JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.workday.jar
接続プロパティに値を入力して、接続文字列をクリップボードにコピーします。
JDBC URL を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。
以下はWorkday の一般的なJDBC URL です:
jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;
Workday のデータでレポートを作成
以下のステップに従って、Workday へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。
- File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
- Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
- Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例:
SELECT Worker_Reference_WID, Legal_Name_Last_Name FROM Workers WHERE Legal_Name_Last_Name = 'Morgan'
- データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
- Group By ステップをスキップして、ウィザードを完了します。
Preview タブで、現在のWorkday のデータでレポートがどのように表示されるかをプレビューできます。
チャートを作成
以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。
DataSet を作成
以下のステップに従って、チャートを入力する新しいデータセットを作成します。
- レポートの編集エリアで、Design タブをクリックします。
- Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
- データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
- Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
- 次のようなクエリを入力します:
SELECT Worker_Reference_WID, Legal_Name_Last_Name FROM Workers WHERE Legal_Name_Last_Name = 'Morgan'
- データセットに含めるフィールドを選択します。この例ではWorker_Reference_WID とLegal_Name_Last_Name を使用します。
- フィールドによるグループ化のステップをスキップして、ウィザードを完了します。
チャートを構成
データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。
- Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
- パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
- チャートのタイプを選択します。この例では棒グラフを使用します。
- Dataset メニューで、チャート用に作成したデータセットを選択します。
- Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
- チャートのシリーズを指定します:Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、Worker_Reference_WID カラムをダブルクリックして、式を$F{Worker_Reference_WID} に設定します。
y 軸の値を指定します:チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、Legal_Name_Last_Name をダブルクリックして、式を$F{Legal_Name_Last_Name} に設定します。
- シリーズ要素のラベルを指定します:チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、Worker_Reference_WID カラムをダブルクリックして、式を$F{Worker_Reference_WID} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します:
$F{Worker_Reference_WID}.toString()
- チャートを拡大してSummary セクションを埋めます:チャートを右クリックして、Size to Container -> Fit Both をクリックします。
レポートの実行
他のJDBC データソースと同様に、Workday のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。