Jaspersoft Studio からNetSuite のデータに接続する方法

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

この記事では、CData JDBC Driver for NetSuite を使ってNetSuite の連携機能を持つJaspersoft Studio の基本的な帳票をテーブルやチャートで作成する方法を説明します。レポートを実行するたびに、チャートおよびテーブルはリアルタイムデータを表示します。JasperSoft のウィザードを使って、レポートエレメントを埋めるSQL クエリをいくつかビルドします。ドライバーは、リレーショナルデータベースへのデータのコピー処理をスキップする間、標準SQL を利用可能にします。代わりに、クエリは基になるNetSuite API に直接実行されます。

JDBC データソースとしてNetSuite のデータに接続

Jaspersoft Studio で、［Data Adapter］ウィザードを使ってJDBC データソースに接続できます。下記の手順に従って、プロジェクトからNetSuite に接続します。NetSuite のデータアダプターをワークスペースに追加します。

1. ［Repository Explorer］で［Data Apters］ノードを右クリックし、［Create Data Adapter］をクリックします。
2. ［Database JDBC Connection］を選択します。
3. ユーザーフレンドリーなドライバー名を入力します。
4. ［Driver Classpath］タブで［Add］をクリックします。ダイアログが表示されたら、インストールディレクトリの［lib］サブフォルダにナビゲートします。ドライバーのJAR を選択します。
5. ［Database Location］タブでは、以下の情報が必要です：
   • JDBC Driver：JDBC driver のクラス名cdata.jdbc.netsuite.NetSuiteDriver を入力。

   • JDBC URL：JDBC URL に必要な接続プロパティを入力。接続プロパティは、セミコロン区切りでname-value ペアを入力する必要があります。NetSuite の一般的なJDBC URL は次のとおりです：

     jdbc:netsuite:Account Id=XABC123456;Password=password;User=user;Role Id=3;Version=2013_1;

     Netsuite への接続

     NetSuite は現在、2つの異なるAPI を提供しています。

     • SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。 しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、 そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
     • SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。 加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。

     NetSuite に接続するには、以下を行う必要があります。

     1. Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
     2. 使用するAPI に適した接続オプションを設定します。（それぞれのAPI で利用可能な接続オプションが異なります。ヘルプドキュメントの「許可の設定」を参照してください。）

     Netsuite への認証

     SuiteTalk またはSuiteQL

     NetSuite は3つの形式のOAuth 認証を提供します。

     • トークンベース認証（TBA）は、基本的にOAuth 1.0 で、OAuthAccessToken とOAuthAccessTokenSecret を実行時ではなくNetSuite UI 内で作成します。 TBA は、2020.2 以降のSuiteTalk およびSuiteQL の両方で利用可能です。
     • OAuth 2.0 認証は、SuiteQL でのみ利用できます。OAuth 2.0 認証を強制するには、次のいずれかを実行します。
       • OAuthVersion を使用するAPI に明示的に設定、または
       • Schema をSuiteQL に設定
     • OAuth JWT 認証は、OAuth 2.0 クライアント認証フローであり、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。この認証方法は、Schema がSuiteQL に設定されている場合にのみ使用できます。

     認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。

NetSuite データ で帳票を作成

NetSuite のデータアダプターを作成したら、NetSuite のデータをJasperReports に追加できます。このセクションでは同梱されているテンプレートの一つをNetSuite のデータに連携させる方法について説明します。

1. ［File］>［New Jasper Report］をクリックします。テンプレートを選択し、親プロジェクトを選択して、帳票に名前を入力します。
2. ［Data Adapter］ウィザードで、先のセクションで作成したデータアダプターを選択します。
3. ［Diagram］タブでは、クエリを視覚的にビルドできます：テーブルをボックスにドラッグしお好みのカラムをクリックします。カスタムクエリも入力可能です。例： SELECT * FROM SalesOrder
4. データセットに含めたいフィールドを選択します。

［Preview］タブでは、最新のNetSuite を使ったものと同じ帳票を見ることができます。

チャートを追加

下記の手順に従って、NetSuite のチャートを既存の帳票に追加します。棒グラフを、先のセクションで作成した帳票テンプレートの最後に追加します。

1. ［Design］タブをクリックします。
2. ［Outline］ビューで、帳票のルートノードを右クリックし［Create Dataset］をクリックします。
3. データセット名を入力し、オプションをクリックして接続またはデータソースから新しいデータセットを作成します。
4. ［Data Adapter］メニューで、最初のセクションで作成した［Data Adapter］を選択します。
5. 次のクエリを入力します：
   SELECT Customer.FirstName AS CustomerName, SalesOrder.Total AS SalesOrderTotal FROM SalesOrder, Customer
6. データセットに必要なフィールドを選択します。この例ではすべてのフィールドを使います。
7. カラムでグループ化する手順はスキップします。NetSuite API はGROUP BY のステートメントをサポートしていません。

データセットを追加したら、下記の手順に従ってチャートを作成します。

1. ［Outline］ビューの［Summary］ノードをクリックします。［Properties］ビューで高さを400ピクセルに設定します。サマリーバンドが帳票の最後にプリントされます。
2. チャートを［Palette］からsummary にドラッグします。Chart ウィザードが表示されます。
3. チャートの種類を選択します。この例では棒グラフを使います。
4. ［Dataset］メニューで、チャート用に作成したデータセットを選択します。
5. ［Dataset］タブで、オプションを選択してマスター帳票と同じ接続を使用します。Chart ウィザードは接続パラメータを入力し、メニューセレクションを［Use Another Connection］に変更します。
6. ［Series］メニューの隣にあるボタンをクリックし、デフォルトシリーズを削除します。［Add］をクリックします。
7. ［Expression Editor］が表示されたら、カラムをダブルクリックして各カラム値に新しいシリーズを作成します。例：CustomerName。シリーズをCustomerName に設定した場合、CustomerName ごとに新しい棒グラフが作成されます。
8. ［Value］ボックスの隣にあるボタンをクリックし、チャートのmeasures 用に［Expression Editor］を開きます。カラムをダブルクリックしてy 軸に追加します。例：SalesOrderTotal。
9. ［Label］ボックスの隣にあるボタンをクリックし、チャートのdimensions 用に［Expression Editor］を開きます。カラムをダブルクリックしてx 軸に追加します。例：CustomerName。
10. この例ではカテゴリを使用しないため、［Category］ボックスに空の文字列 "" を入力します。

チャートを作成したら基本的なフォーマットを行い、サブレポートをレポートに未使用スペースなくシームレスに追加できるようにします。

1. チャートを右クリックして［Size to Container］>［Fit Both］をクリックします。
2. メインレポートでサブレポートを右クリックして［Size to Container］>［Fit Both］をクリックします。

プレビューする前に帳票への変更を保存します。チャートが帳票の最後のページに表示されます。