チュートリアル 1: シンプルなリスト・レポートのビルド
このセクションでは、お客様の名前、電話番号、および連絡先名をリストするレポートをビルドする場合の段階的な手順を示します。このレポートには、BIRT Report Designer、Classic Models とともに提供されているサンプル・データベースのデータを使用します。図 1-1 は、完成したレポートの一部を示しています。
図 1-1 お客様の名前、電話番号、および連絡先をリストしたレポート
このチュートリアルでは、以下の作業を行います。
- 新規プロジェクトの作成。
BIRT RCP Report Designer を使用している場合、このステップは実行しません。
作業 1: 新規プロジェクトの作成
Eclipse はプロジェクトごとにファイルを編成します。
すべてのレポートを編成する単一のプロジェクトを作成することも、カテゴリーごとにレポートを編成する複数のプロジェクトを作成することもできます。
作成する各プロジェクトごとに、Eclipse によってファイル・システム内にディレクトリーが作成されます。
BIRT RCP Report Designer を使用している場合は、この作業は実行しないでください。
-
「ファイル」->「新規」->「プロジェクト」を選択する。
図 1-2 に示す「新規プロジェクト」には、作成可能なプロジェクトのタイプが表示されます。
図 1-2 新規プロジェクト
- 「ビジネス・インテリジェンスおよびレポート作成ツール」を展開し、「レポート・プロジェクト」を選択してから、「次へ」を選択する。
- 「新規レポート・プロジェクト」の「プロジェクト名」に、以下のテキストを図 1-3 のように入力する。
- プロジェクトを追加するには、「終了」を選択する。これにより、図 1-4 のように「ナビゲーター」ビューにプロジェクトが表示されるようになります。
図 1-4 「ナビゲーター」ビュー内のプロジェクト
作業 2: 新規レポートの作成
以下の方法でレポートを作成することができます。
このチュートリアルでは、まずブランクのレポートの設計から開始します。
-
「ファイル」->「新規」->「レポート (Report)」を選択する。
「新規レポート」が表示されます。図 1-5 は、BIRT Report Designer で表示されるウィンドウを示しています。
「新規レポート」は、BIRT RCP Report Designer ではこれと若干異なります。
図 1-5 BIRT Report Designer の「新規レポート」
- BIRT Report Designer では、「入力 (Enter)」の下で、または親フォルダーを選択して、作成したプロジェクトを選択する。
このステップは、BIRT Report Designer を使用している場合にのみ行います。
- ファイル名として以下のテキストを入力する。
- 「次へ」を選択する。
「新規レポート」は、図 1-6 のように、1 つのブランクのレポートといくつかのレポート・テンプレートから開始することができます。
図 1-6 「新規レポート」におけるレポート・テンプレート
- 「ブランクのレポート」を選択してから、「終了」をクリックする。メイン・ウィンドウに新規レポートが表示されます。
このウィンドウには、図 1-7 に示されているようなレイアウト・エディターが表示されます。レイアウト・エディターには、空のレポート・ページが表示されます。
このチュートリアルの残りの部分では、カスタマー・レポートの作成手順について詳しく説明します。
図 1-7 ブランクのレポートの設計
作業 3: データ・ソースのビルド
レイアウト・エディターでレポートの設計を開始する前に、BIRT データ・ソースをビルドして、レポートをデータベースまたは別のタイプのデータ・ソースに接続します。
データ・ソースをビルドする場合には、ドライバー・クラス、データ・ソース名、および、ユーザー名とパスワードなどのその他の接続情報を指定します。
このチュートリアルでは、BIRT Report Designer で使用するようにすでに構成されている、サンプル・データベース Classic Models を使用します。
このサンプル・データベースを使用する場合、接続情報を指定する必要はありません。
- 「データ・エクスプローラー」を選択する。デフォルトのレポート設計パースペクティブを使用する場合には、図 1-8 のように、データ・エクスプローラーがレイアウト・エディターの左側の、パレットの隣に表示されます。
データ・エクスプローラーが開かれていない場合は、「ウィンドウ」->「ビューの表示」->「データ・エクスプローラー」を選択します。
図 1-8 データ・エクスプローラー
- 「データ・ソース」を右クリックし、コンテキスト・メニューから「新規データ・ソース」を選択する。
「新規データ・ソース」には、図 1-9 のように、作成可能なデータ・ソースのタイプが表示されます。
図 1-9 新規データ・ソース
- データ・ソース・タイプのリストから、Classic Models Inc. サンプル・データベースを選択する。デフォルトのデータ・ソース名を使用して、「次へ」を選択します。新規データ・ソースに関する接続情報が表示されます。
- 「終了」を選択する。
BIRT Report Designer は、サンプル・データベースに接続する新規データ・ソースを作成します。
この新規データ・ソースは、図 1-10 のように、データ・エクスプローラーの「データ・ソース」の中に表示されます。
図 1-10 データ・エクスプローラー内の「データ・ソース」
作業 4: データ・セットのビルド
これで、データ・セットをビルドする準備ができました。
データ・セットは、データ・ソースから取り出すデータを識別します。
JDBC データ・ソースに接続するレポートの場合は、SQL SELECT ステートメントを使用して、取り出すデータを識別します。
-
「データ・エクスプローラー」で「データ・セット」を右クリックし、コンテキスト・メニューから「新規データ・セット」を選択する。
- 「新規データ・セット」の「データ・セット名」に、以下のテキストを図 1-11 のように入力する。
- その他のフィールドについては、デフォルト値を使用する。
- 「データ・ソース」に、以前に作成したデータ・ソースの名前が表示される。
- 「データ・セット・タイプ」は、そのデータ・セットが SQL SELECT 照会を使用することを示す。
- 「次へ」を選択する。
「照会 (Query)」に、SQL 照会の作成に役立つ情報が表示される。「使用可能な項目」に、Classic Models データベース内のすべてのテーブルがリストされます。テーブル内の列を表示するには、テーブルの隣の正符号 (+) をクリックします。
「データ・セットの編集」の右側のテキスト・エリアに、SQL SELECT ステートメントの必須キーワードが表示されます。
- テキスト・エリアに以下の SQL SELECT ステートメントを入力して、取り出すデータを指定します。
データ・セット・エディターにはテーブル名および列名が大文字で表示されますが、SQL は大/小文字を区別しないため、これらの名前の入力は大文字でも小文字でも構いません。
照会内容をタイプしたくない場合は、列およびテーブルを「使用可能な項目」からテキスト・エリアにドラッグすることができます。
作成した SELECT ステートメント (
図 1-12 に表示されているもの) は、CUSTOMERS テーブルの CUSTOMERNAME 列、CONTACTLASTNAME 列、CONTACTFIRSTNAME 列、および PHONE 列から値を取得します。
図 1-12 「データ・セットの編集」内の SQL SELECT ステートメント
- 「終了」をクリックして、データ・セットを保管する。「データ・セットの編集」は、照会で指定された列を表示し、そのデータ・セットの編集に使用できるオプションを提供します。
- 「結果のプレビュー」を選択して、照会が有効であって、正しいデータが戻されることを確認する。
SELECT ステートメントが正しく入力されている場合、図 1-13 に示されているような結果が表示されます。
これが、照会が戻すデータ行です。
図 1-13 SQL SELECT ステートメントによって戻されたデータ行
- 「OK」を選択する。
作業 5: レポートのレイアウト
この手順では、レポート・ページに要素を挿入し、以前に作成したデータ・セットから得られたデータを表示します。
まず最初にテーブル要素を挿入してから、テーブルにデータ要素を挿入します。
テーブルが提供する以下の機能を理解することが重要です。
- テーブルの操作は、データ・セットが戻すすべてのデータ行に対して繰り返されます。
- テーブルは、行および列フォーマットへのデータのレイアウトを容易にします。
- 「パレット」を選択する。
パレットには、レポートに配置できるすべての要素が表示されます。
-
テーブル要素をパレットからドラッグし、レイアウト・エディター内のレポートにドロップする。
「テーブルの挿入」では、そのテーブル用に作成する列および詳細行の数の指定を求めるプロンプトが出されます。
- 3 つの列および 1 つの詳細行を指定して、「OK」を選択する。
3 つの列と 1 つの詳細行からなるテーブルが、レイアウト・エディターに表示されます。これで、テーブルにデータを挿入する準備ができました。
- 「データ・エクスプローラー」を選択する。
- 「データ・エクスプローラー」で「データ・セット」を展開してから、「お客様 (Customers)」を展開する。
照会で指定した列が「お客様 (Customers)」の下に表示されます。
-
図 1-14 のように、データ・エクスプローラーから CUSTOMERNAME をドラッグして、テーブルの詳細行の最初のセル内にドロップする。
詳細行には、レポートのメイン・データが表示されます。
完了したレポートでは、詳細行が反復して、データ・セットのすべてのデータ行を表示します。
図 1-14 データ・エクスプローラーからの列のドラッグとテーブル・セルへのドロップ
BIRT Report Designer は、データ・セット・フィールドにバインドされた名前付きの列を作成します。
図 1-15 に示されている「データ・バインディングの選択」には、このデータ・バインディングが表示されます。
図 1-15 データ・セット・フィールドにバインドされた名前付き列
- 「OK」を選択して、デフォルトのデータ・バインディング定義を受け入れる。
レイアウト・エディターでは、CUSTOMERNAME フィールドをドロップしたテーブル・セルにデータ要素が入り、[CUSTOMERNAME] と表示されます。
このデータ要素の上方に、レイアウト・エディターが自動的にヘッダー行に追加したラベル要素があります。
このラベルは、静的テキストとしてフィールド名を表示します。
これは列見出しの役割を果たします。
図 1-16 は、データ要素とラベル要素を示しています。
図 1-16 テーブル内のデータ要素およびラベル要素
-
データ・エクスプローラーから PHONE をドラッグし、詳細行の 2 番目のセル内にドロップする。
「OK」を選択して、デフォルトのデータ・バインディングを受け入れます。
-
CONTACTFIRSTNAME をドラッグし、詳細行の 3 番目のセル内にドロップする。
「OK」を選択して、デフォルトのデータ・バインディングを受け入れます。
-
CONTACTLASTNAME をドラッグし、CONTACTFIRSTNAME の下にある、詳細行の 3 番目のセルにドロップする。
「OK」を選択して、デフォルトのデータ・バインディングを受け入れます。
レポート・ページは図 1-17 のような外観になります。
図 1-17 テーブルに追加されたお客様情報および連絡先情報
- レイアウト・エディターの下部にある「プレビュー」タブを選択する。図 1-18 のように、BIRT Report Designer はレポートを HTML フォーマットで生成し、表示します。
レポート全体を見るには、スクロールダウンしてください。レポートは PDF でプレビューすることも可能です。
PDF でプレビューするには、メインメニューから「ファイル」->「PDF でレポートを表示」を選択します。
図 1-18 のように、データは正確ですが、ランダムな順序で表示されます。
お客様の名前でアルファベット順にデータをソートすると使いやすくなります。
レポートの外観も改善する必要があります。
図 1-18 レポート・データのプレビュー
作業 6: データのソート
レポートを作成してプレビューしたときには、レポートのデータ行は照会によって戻された順序で表示されます。その順序は、データがどのようにデータ・ソースに提供されたかなど、さまざまな要因によって変化します。多くの場合、ユーザーはレポートに表示されるデータの順序を変更します。
- 「レイアウト」を選択して、レイアウト・エディターに戻る。
- 必要に応じてプロパティー・エディターを開く。デフォルトのレポート設計パースペクティブを使用する場合、プロパティー・エディターはレイアウト・エディターの下に表示されます。
プロパティー・エディターが開かない場合は、「ウィンドウ」->「ビューの表示」->「プロパティー・エディター」を選択します。
- レイアウト・エディターで、左下隅の「テーブル」タブを選択してテーブルを選択する。このタブは、マウス・ポインターをこの領域上に移動すると表示されます。
プロパティー・エディターは、図 1-19 のようにテーブルのプロパティーを表示します。
図 1-19 プロパティー・エディター
- 「ソート」タブを選択する。
- 「追加」を選択してソート式を作成する。「ソート・キー」の下に行が表示されます。
- 「ソート・キー」の下の行をクリックし、表示される矢印ボタンを選択して、ドロップダウン・リストから CUSTOMERNAME を選択する。
- 「ソート方向」としては、図 1-20 のようにデフォルト値の「昇順」を使用します。
図 1-20 昇順のソート方向
- レポートをプレビューする。
お客様の名前で昇順にソートされたデータが、図 1-21 のように表示されます。
図 1-21 お客様の名前でソートされたデータ
大文字が含まれる名前はリストの先頭に表示されます。BIRT は UCS2 コード・ポイント値によって文字列データをソートします。
ASCII ベースの文字セットでは、大文字は小文字よりもコード・ポイント値が小さくなっています。
そのため、大文字は小文字よりも前に表示されます。
- お客様の名前を大/小文字を区別せずに、例えば ANG Resellers が American Souvenirs Inc. の前ではなく後に来るようにソートするには、「ソート」ページの「ソート・キー」の式を、以下の式に変更する。
この式は、JavaScript の toUpperCase( ) 関数を使用して、ソート前にお客様の名前の値をすべて大文字に変換します。
JavaScript の関数名では大/小文字が区別されますので、正確に toUpperCase( ) と入力する必要があります。列名への参照でも大/小文字が区別されます。
この式では、row["CUSTOMERNAME"] が使用される正しい名前です。
例えば、row["customername"] と入力すると、レポートの実行時に BIRT Report Designer はエラーを表示します。データ・エクスプローラーに表示される名前を参照することで、列名の大文字化を検査することができます。
- レポートをプレビューする。
お客様の名前が異なる順序で表示されます。
大文字が含まれる名前がリストの先頭に表示されることはなくなります。
作業 7: レポートのフォーマット設定
これで、レポートに正しいデータが正しい順序で表示されていることを検証できました。
次は、レポートの外観を改善します。このセクションでは、以下の作業を行います。
列見出しの編集
- 「レイアウト」を選択して、レイアウト・エディターに戻る。
- 最初の列見出し、CUSTOMERNAME をダブルクリックする。列見出しは、テーブルの最初の行 (ヘッダー行) にあります。
- 強調表示されているテキストをすべて置換するには、まず入力し、入力が完了してから Enter キーを押す。
テキストを編集するには、一度クリックしてテキストの選択を解除してから、文字を削除または追加する場所にカーソルを置きます。
CUSTOMERNAME を以下のテキストで置換する。
- 2 と 3 のステップを繰り返して、2 番目および 3 番目の列見出しを以下のテキストに変更する。
図 1-22 レポート設計内の修正された列見出し
列見出しの書式設定
レポート要素のフォーマット設定を行うには、プロパティーを設定します。
この作業は、次の 2 つの方法で行うことができます。
- プロパティー・エディターを使用して要素のプロパティーを設定する。
- 必要なプロパティーを含んだスタイルを定義し、そのスタイルを要素に適用する。この方法は、1 度定義したフォーマット・プロパティーを複数の要素に適用する場合に使用します。
この手順では、最初の方法を使用して列見出しを太字に設定し、2 番目の方法を使用してヘッダー行に色を付けます。
- プロパティー・エディターを使用して列見出しを太字にする方法は、以下のとおりです。
- すべての列見出しを選択する。
複数の要素を選択するには、シフト・キーを押しながら各要素をクリックします。
プロパティー・エディターには、図 1-23 のように、選択された要素のプロパティーが表示されます。
図 1-23 プロパティー・エディターで選択された要素のプロパティー
- B を選択して、列見出しを太字テキストにフォーマット設定する。
- 列見出しの選択を解除するには、テーブルの外側の空白部分をクリックする。
- スタイルを使用してヘッダー行に背景色を追加するには、次のようにする。
- メインメニューから、「要素 (Element)」->「新規スタイル」を選択する。
図 1-24 のように「新規スタイル」が表示されます。左方にプロパティー・カテゴリーが表示されます。
右側には、選択するカテゴリーのプロパティーが表示されます。
図 1-24 新規スタイル
- カスタム・スタイルの場合は、スタイルに以下の名前を指定する。
- プロパティー・カテゴリーのリストから「背景」を選択する。「新規スタイル」に、設定可能な背景プロパティーが表示されます。
- 以下の方法のいずれかを使用して、「背景色」プロパティーの色を指定する。
「OK」を選択する。
- レイアウト・エディターで、左下隅の「テーブル」タブを選択してテーブルを選択する。このタブは、マウス・ポインターをこの領域上に移動すると表示されます。
図 1-25 のように、テーブルの上部および左側に、ガイド・セルが表示されます。
図 1-25 テーブルの上部および左側のガイド・セル
- ヘッダー行の隣のガイド・セルを選択する。プロパティー・エディターには、選択された行のプロパティーが表示されます。
- 「プロパティー」を選択してから「一般」を選択し、その行の一般プロパティーを表示する。
-
「スタイル」の隣のドロップダウン・リストから table_header_row を選択して、作成したばかりのスタイルを適用する。BIRT Report Designer は、そのスタイルをヘッダー行に適用し、色付きで表示します。
- レポートをプレビューする。
レポートは図 1-26 のような外観になります。
図 1-26 ヘッダー行スタイルを表示したレポート・プレビュー
現在のところ、主な改良は、ヘッダーを見やすく明確なものにしたことです。
同じ行の最初と最後の名前を表示
単一のセルに複数の要素を配置すると、BIRT Report Designer はブロック・レベルの要素を作成します。HTML に慣れたユーザーであればご存じのはずですが、各ブロック要素は新規行で始まります。
複数の要素を同じ行に表示するには、表示する要素をインライン要素として設定する必要があります。
あるいは、この手順で説明するように、名と姓の値を連結して、単一のデータ要素として表示することもできます。
- 「レイアウト」を選択して、レイアウト・エディターに戻る。
- 連絡先の姓を表示するデータ要素を削除する。
- 連絡先の名を表示するデータ要素をダブルクリックする。
「データ・バインディングの選択」には、そのレポートで使用されるすべてのデータ・バインディングが表示されます。
CONTACTFIRSTNAME の横のチェック・マークは、そのデータ・バインディングが選択されたデータ要素によって使用されることを示します。
- dataSetRow["CONTACTFIRSTNAME"] 式を表示するセルをクリックしてから、省略符号 (...) ボタンを選択する。
「式ビルダー」によって、ウィンドウの上部のテキスト・エリアに以下の式が表示されます。
- 以下の式を使用して、名と姓を連結する。
図 1-27 は、「式ビルダー」内のこの式を示しています。空の引用符 (" ") によって、名と姓の間にスペースを追加します。
テキスト・エリアに式を入力するか、ウィンドウの右下の項目をダブルクリックすることで、その項目を式に挿入することができます。
図 1-27 「式ビルダー」における連結済みデータ
- 「OK」を選択して「式ビルダー」を閉じてから、「データ・バインディングの選択」で「OK」を選択して変更済みの式を保管する。
- レポートをプレビューする。
レポートは図 1-28 のような外観になります。
図 1-28 連結された連絡先名を表示するレポート・プレビュー
行間のスペースを増やす
デフォルト・レイアウトは、テーブルの行間に最小限のスペースを追加します。
通常は、行間のスペースの調整が必要になります。
- 「レイアウト」を選択して、レイアウト・エディターに戻る。
- 詳細行 (中間の行) 内のすべてのセルを選択する。複数のセルを選択するには、Shift キーを押したままクリックします。
セル内のデータ要素ではなく、セルを選択してください。
図 1-29 のように、選択されたセルの周囲に枠が表示されます。
図 1-29 レイアウト・エディター内の選択済みのセル
プロパティー・エディターには、セルのプロパティーが表示されます。プロパティー・エディターに表示されるタイトルには、選択した要素のタイプが示されますので、「プロパティー・エディター - セル」を参照してください。
- 「埋め込み」を選択する。
プロパティー・エディターには、余白のプロパティーが表示されます。
余白のプロパティーを使用して、要素の上下左右に追加するスペースの量を指定することができます。
- 上部の余白を 12 ポイントに設定する。
ここで、なぜ、行間隔を調整するために行を単純に選択するのではなく、行内の個々のセルを選択するのか疑問に思われるかもしれません。
BIRT Report Designer は行の余白をサポートしていません。これは、この機能をサポートしていないブラウザーがあるためです。
- レポートをプレビューする。
レポートは図 1-30 のような外観になります。
データの行間のスペースが増えています。
図 1-30 行間隔を示しているレポート・プレビュー
作業 8: レポート・タイトルの作成
レポートに必要なのは、あとはタイトルだけとなりました。
タイトルを表示するには、ラベル要素、テキスト要素、またはデータ要素のいずれかを使用します。
- ラベル要素は、列見出しのような短い静的テキストに適しています。
- データ要素は、データ・セット・フィールドまたは計算済みフィールドから得られる動的な値の表示に適しています。
- テキスト要素は、さまざまなフォーマットの値や動的な値を含む、複数行のテキストに適しています。
この手順では、テキスト要素および HTML タグを使用して、テキストをフォーマット設定します。
フォーマット済みテキストの作成に HTML を使用する必要はありません。
ただし、HTML またはウェブ・デザインに精通している場合には、HTML を使用してフォーマット済みテキストのブロックを作成することもできます。
- 「レイアウト」を選択して、レイアウト・エディターに戻る。
- 「パレット」を選択する。
-
テキスト要素をパレットからドラッグし、テーブルの上にドロップする。
- 「テキスト項目の編集」で、「プレーン・テキスト」と表示されたドロップダウン・リストから「HTML/ダイナミック・テキスト」を選択する。
「HTML/ダイナミック・テキスト」を選択すると、テキストに HTML タグまたは CSS プロパティーを組み込めるようになります。タグを入力することも、テキスト・エディターによって提供される、よく使用される HTML タグを挿入することもできます。
- 図 1-31 に示すように、テキスト・エリアで以下のテキストを指定します。
- 「OK」を選択して、レポートをプレビューする。
レポートは図 1-32 のような外観になります。
図 1-32 フォーマット済みレポート・タイトルを表示したレポートのプレビュー
ご覧のように、組み込み HTML を持つテキスト要素を使用すると、以下のことが可能になります。
あるいは、以下のものを使用することもできます。
- 静的テキストの最初の行と 2 番目の行の表示に使用する 2 つのラベル要素
- 動的な値を含む 3 番目の行の表示に使用する 1 つのデータ要素
次のステップ
これで、初めてのレポートがビルドされ、BIRT Report Designer のいくつかの基本的なツールおよび機能が使用されました。
より洗練されたレポートをビルドする際に行うことのできる作業は、まだ多く残されています。
そうした作業の一部については、本書の以下の章などで説明しています。
