EGL レポート作成プロセスの概要

このトピックでは、EGL プロジェクト用にレポートを作成および生成するための一般的なプロセスについて、その概要を示します。 これらのプロセスに関する追加の詳細は、EGL レポート・タスクのヘルプ・トピックに記載されています。

レポートを作成するには、以下に述べる 3 つのプロセスを実行します。 このうちの 2 つのプロセスは、XML 設計の作成とレポートを駆動するコードの作成で、これらは必須のプロセスです。 第 3 のプロセスであるレポート・ハンドラーの作成は、オプションです。 これらのプロセスは、説明されている順序で実行しなくてもかまいません。 例えば、レポート・ハンドラーが必要な場合は、それを作成してから XML 設計文書を作成するか、設計文書とレポート・ハンドラーの作成を同時に行うことができます。ただし、その例外が、以下に示すステップ 2 の『レポート・ハンドラーと XML 設計文書のコードの相互関係』で説明されています。

XML 設計文書と、レポートを駆動するためのコードがないと、レポートを生成できません。

レポートを作成するために実行する 3 つのプロセスは、以下のとおりです。
  1. XML 設計文書を作成して、レポートのレイアウト情報を指定します。 この文書は、次のどちらの方法でも作成できます。
    • サード・パーティーの JasperReport 設計ツール (Jasper Assistant や iReports など) を使用する。
    • テキスト・エディターを使用して、新しいテキスト・ファイルに Jasper XML 設計情報を書き込む。

    XML 設計文書は、.jrxml という拡張子を持っている必要があります。作成したファイルにこの拡張子が付いていない場合は、そのファイルを .jrxml ファイルとして名前変更してください。 また、XML 設計文書は、必ず EGL レポート・ハンドラーやレポート起動コード・ファイルと一緒に、同じ EGL パッケージに保管してください。

    作成した .jrxml ファイルは、.jasper ファイルへコンパイルされます。 新しい .jrxml ファイルを作成しない場合は、前にコンパイルされた .jasper ファイルをインポートする必要があります。

  2. レポート作成時のイベント処理ロジックを提供するレポート・ハンドラーを使用したい場合は、次のいずれかの方法でレポート・ハンドラーを作成できます。
    • EGL レポート・ハンドラー・ウィザードを使用して、レポート・ハンドラー用の情報を指定する。
    • 新規 EGL ソース・ファイルを作成し、レポート・ハンドラー・テンプレートを使用してハンドラーを挿入するか、手動でハンドラー・コードを入力する。
    レポート・ハンドラーと XML 設計文書のコードの相互関係 .jrxml ファイルの中で、EGL レポート・ハンドラーから生成されたレポート・ハンドラー・ファイルを参照する scriptletClass を指定できます。 以下の点に留意してください。
    • .jrxml ファイルが、レポート・ハンドラーによって生成された Java™ コードを使用する場合は、.jrxml ファイルを作成する前に、レポート・ハンドラーを生成する必要があります。
    • レポート・ハンドラーを変更した場合は、.jrxml ファイルを再コンパイルする必要があります。
    • .jrxml ファイル内のコンパイル・エラーを解決する必要がある場合、または、レポート・ハンドラーに変更を加えた後に .jasper ファイルを再コンパイルしたい場合は、.jrxml ファイルを変更して保管する必要があります。
  3. EGL レポート・ライブラリー関数を使用して、EGL プロジェクト内にレポート起動コードを作成します。 レポート起動コードを作成するときは、EGL プログラム・パーツ・ウィザードを使用できます。

重要: レポート・ハンドラーおよびレポート起動コード・ファイルには、XML 設計文書と異なる名前を付ける必要があります。 そのようにしなかった場合は、設計ファイルのコンパイルによって、Java コードが上書きされます。 問題を回避するために、レポート・ハンドラーには reportName_handler.egl という名前を付け、XML 設計文書には reportName_XML.jrxml という名前を付けてください。 例えば、レポート・ハンドラーに abc_handler.egl、設計文書に abc_XML.jrxml という名前を付けることができます。 また、XML 設計ファイルには必ず固有の名前を付け、EGL プログラム・ファイルと競合しないようにしてください。

XML 設計文書、レポート・ハンドラー (使用したい場合)、およびレポート起動コードを作成した後、レポートのビルドと生成を行うには、以下のプロセスを実行します。
  1. 「プロジェクト (Project)」>「すべてをビルド (Build All)」を選択して EGL プロジェクトをビルドします。

    EGL は、自動的に EGL レポート・ハンドラーから Java コードを生成し、XML 設計文書 (.jrxml ファイル) を .jasper ファイルへコンパイルします。

  2. レポート起動コードを備えた EGL プログラムを実行します。

EGL プログラムが実行された後、EGL によって使用された JasperReports プログラムは、生成されたレポートを、レポート起動コード内の reportDestinationFileName によって指定されたロケーションに自動的に保管します。

レポートを生成する JasperReports プログラムは、中間ファイル・フォーマットである .jprint ファイルも生成して保管します。このファイルがエクスポートされて、最終的なレポート・フォーマット (.pdf、.html、.xml、.txt、または .csv) になります。

プログラムは、1 つの .jprint を何度もエクスポートに再利用できます。

レポート起動コード内の exportReport() 関数により、EGL はレポートを指定されたフォーマットでエクスポートします。 例えば、次のコードを指定すると、EGL はレポートを .pdf フォーマットでエクスポートします。
 reportLib.exportReport(myReport, ExportFormat.pdf);

EGL は、エクスポートされたレポートを自動ではリフレッシュしません。レポートの設計を変更した場合、またはデータが変更された場合は、あらためてレポートへの埋め込みを行い、レポートを再エクスポートする必要があります。

注: EGL レポートを削除した場合は、そのレポートへの参照をすべて除去する必要があります。

関連する概念
EGL レポートの概要

関連するタスク
パッケージへの設計文書の追加 (Adding a design document to a package)
レポート・テンプレートの使用 (Using report templates)
EGL レポート・ハンドラーの作成 (Creating an EGL report handler)
EGL レポート・ハンドラーの手動作成 (Creating an EGL report handler manually)
レポートを駆動するコードの作成 (Writing code to drive a report)
レポートの実行 (Running a report)
レポートのエクスポート (Exporting reports)
EGL でのコンテンツ・アシストの使用

関連する参照項目
EGL レポート・ライブラリー (EGL report library)
データ・ソース (Data sources)
EGL レポート・ハンドラー (EGL report handler)

ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.(C) Copyright IBM Japan 2005.