JReport Designer で Webflow のデータを連携利用
CData JDBC Driver for Webflow のデータ を使えば、ダッシュボードやレポートから Webflow をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Webflow のデータ のライブデータにアクセスできます。この記事では、JReport Designer で Webflow のデータ に JDBC データソースとして接続し、Webflow のデータ のデータをもとにレポートを作成する方法を説明します。
Webflow ののデータに接続
- C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。
... set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Webflow 2016\lib\cdata.jdbc.api.jar; ...
- File メニューから New、Data Source と進み、新しいデータソースを作成します。
- 表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Webflow）、JDBC を選択して OK をクリックします。
- Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
cdata.jdbc.api.APIDriver
- URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
認証
Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。
OAuth 2.0 のセットアップと設定
ステップ 1：Webflow OAuth アプリケーションの作成
OAuth 認証をセットアップするには、以下のステップで進めます：
- Webflow Developer Portal にアクセスします
- Webflow アカウントの「Apps & Integrations」に移動します
- 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
- アプリケーション名、説明、リダイレクト URI（CallbackURL）を設定します
- 接続で使用する Client ID と Client Secret をコピーします
必須の接続プロパティ
- AuthScheme：OAuth に設定します（必須）
- OAuthClientId：Webflow OAuth アプリケーションの Client ID（必須）
- OAuthClientSecret：Webflow OAuth アプリケーションの Client Secret（必須）
- CallbackURL：OAuth アプリケーションで指定したリダイレクト URI（必須）
- InitiateOAuth：トークンを自動管理するには GETANDREFRESH に設定します（推奨）
必須の OAuth スコープ
Webflow API プロファイルでは、以下の OAuth スコープが必要です：
- sites:read - サイト情報および設定への読み取りアクセス
- pages:read - サイトページへの読み取りアクセス
- cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
- forms:read - フォームおよびフォーム送信への読み取りアクセス
- assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
- ecommerce:read - 製品、注文、在庫への読み取りアクセス
- authorized_user:read - 認可されたユーザーへの読み取りアクセス
組み込みの接続文字列デザイナー
JDBC URL の構築には、Webflow JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
一般的な JDBC URL は次のとおりです。
jdbc:api:Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。
テーブルの読み込みが完了したら Done をクリックします。
- Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Webflow）を展開（）し、Queries を右クリックして Add Query を選択します。
- Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
- Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
SELECT , FROM Sites WHERE Id = 'your_site_id'
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Webflow のデータ を新規または既存のレポートに追加する準備が整いました。
NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。
Webflow ののデータをレポートに追加
これで Webflow のデータ を使用したレポートを作成する準備が整いました。
- File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
- Query を選択します（または新規作成します。上記を参照）。
- クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。
- レポートの View タブをクリックして、チャートを表示します。
