サポート > リポジトリ > 帳票 > Excel帳票 - 一覧表示
ja | en

一覧帳票データをExcelファイルとして出力します。Excelを用いてプリンタに印刷することができます。

Excel帳票機能を設定した顧客モデルの一覧表示画面を開きます。図1に示すように「帳票(全件)」ボタンが用意されています。

図1 一覧画面に用意された帳票ボタン

このボタンを押下すると、Excel形式のファイルがダウンロードされます。(図2)

図2 Excelファイルがダウンロードされる

Excelでファイルを開きます。この顧客の一覧情報がレイアウトされていることがわかります。これをプリンタで印刷することで帳票出力を行います。

図3 Excelに埋め込まれた一覧情報
一覧表示の帳票出力では、現在画面に表示されているデータではなく、検索条件で適合したすべてのデータが対象になります。(例 100件のデータを検索し、画面には10件表示されている場合、帳票出力は100件が対象となります。)

Excel帳票の定義は、次の手順で行います。

  1. Designerによるボタン設定とビルド。
  2. ビルドによって得られたExcelテンプレートファイルのレイアウト設計
  3. (ビルドした)Wagbyアプリケーションで行う「帳票テンプレート」の設定

ここでは、それぞれの手順の一覧を説明します。

Designerの設定

「画面>帳票出力」タブを開きます。帳票出力設定欄で、次の設定を行います。

設定項目 説明 入力例
テンプレートファイル名 後述する「帳票テンプレート」の識別子になります。重複しない名前を英数字の組み合わせで決めてください。拡張子 (.xls や .xlsx) は含めません。 printListCustomer1
表示画面 一覧表示を選択します。 一覧表示
出力方式 Excelを選択します。 Excel
利用ライブラリ 出力方式に Excel を指定した場合、どのライブラリを使うのかという組み合わせが提示されますので、一つを選択します。通常、Excelを使う場合は(ライブラリとして)POIを指定します。 POI
表示する この欄をチェックすると、帳票出力が有効になります。 -
表示条件 ボタンの表示条件式を記述することができます。「画面機能>ボタン名と表示条件のカスタマイズ」で説明しています。(ただし式中にモデル項目名は利用できません。一覧表示の場合、モデルの主キーを特定して値を読み出す方法は提供されていません。TODAY()など、モデル項目名に拠らない関数などは利用できます。) (中略)
ボタン名 ボタン名を指定します。省略時は「"帳票" + 連番」となります。式を使ってボタン名を決定することもできます。(ただし式中にモデル項目名は利用できません。一覧表示の場合、モデルの主キーを特定して値を読み出す方法は提供されていません。TODAY()など、モデル項目名に拠らない関数などは利用できます。) -
図4 帳票出力の設定

Excelテンプレートファイルのレイアウト設計

図4の設定後にビルドすると、Wagbyインストールフォルダ内のwork/reportフォルダ内に、テンプレートファイル名で指定したExcelファイルが自動生成されます。(図5)

図5 自動生成されたテンプレートファイル

このテンプレートファイルをExcelで開くと、図6のようになっています。レイアウト設計なしで、項目名とプレースホルダが列挙されています。

モデル定義で、一覧表示として指定した項目がプレースホルダとして使われます。

図6 項目名とプレースホルダが埋め込まれたExcelファイル

ここで "${" ではじまり、"}" で終わる部分をプレースホルダと呼びます。プレースホルダの構造は次のとおりです。最後の "#" は、行が増えることを示します。

${モデル名_lp.項目名.#}

プレースホルダには、実際の値が設定されます。プレースホルダの記述ルールの詳細は「プレースホルダ」をお読みください。

このプレースホルダ表記を残しつつ、帳票レイアウト設計を行います。図7にレイアウトの例を示します。

図7 帳票レイアウトを行った例

一覧帳票用のテンプレートでは詳細帳票とは異なり、レコード数が動的に変更されます。そのためプレースホルダは1行にのみ記述します。(帳票処理時に、出力レコード数だけ自動的に追加されます。)

帳票テンプレートの設定

ビルドしたアプリケーションにシステム管理者でログオンします。モデルと、図7の帳票ファイルを紐付けるために「帳票テンプレート」の設定を行います。(図8)

図8 帳票テンプレートメニュー

新しい帳票テンプレートを作成します。(図9)

図9 帳票テンプレートの新規登録を行う

ID項目は、Designerに設定した帳票テンプレートID(図4)を指定します。拡張子 (.xls や .xlsx) は含めません。

ここでは適用モデルを "顧客" とします。説明欄は自由に設定してください。

テンプレートファイルとして、図7を保存したExcelファイルを指定します。(図10,図11)

図10 帳票テンプレートの設定
図11 帳票テンプレートを登録した
ここで登録したテンプレートファイルは、upload_dir フォルダ以下に保存されます。詳細は「文字列 - ファイル > 仕様 > 内部の構造」をお読みください。

動作例

一覧表示画面に用意される帳票用ボタン名を "Excel印刷" に変更した例を図12に示します。

図12 帳票ボタン名の変更

定義方法

Designer側でボタン名を指定します。

図13 Designerでボタン名を設定する

検索処理を実行するまで、帳票ボタンを表示させない設定を行うことができます。必ず検索処理を実行させるようにすることで、大量データの全件出力を行わせないようにします。

検索画面遷移直後の検索処理を止める

「画面 > 検索・一覧表示画面 > 検索画面 > 検索画面遷移直後の検索処理を止める」を有効にします。

図14 検索画面遷移直後の検索処理を止める

一覧表示のボタン表示条件

「画面 > 帳票出力」で、帳票タイプが一覧表示のボタン表示条件として次の式を設定します。

RESULTSIZE() > 0

RESULTSIZE 関数は、検索結果数を返します。

帳票テンプレート設定で、出力ファイル名を指定することができます。固定値を設定します。

シート名7.10

出力される Excel のシート名になります。

  • プレースホルダは利用できません。
  • 拡張子は含めないようにしてください。

出力ファイル名

出力される Excel のファイル名になります。

  • プレースホルダは利用できません。
  • ファイル名には拡張子を含めてください。(.xlsまたは.xlsx)
この設定は、HTTPレスポンスヘッダの"Content-Disposition"フィールドの"filename"属性に反映されます。

出力ファイル名(一括帳票用)

一覧帳票では無効です。(設定は無視されます。)

設定方法

プレースホルダを指定することができます。ファイル名は、拡張子も含めて指定してください。例を示します。

図15 出力ファイル名の指定
顧客情報一覧.xls
顧客情報${customer_lp.customerid.0}.xls

プレースホルダでは、モデル名の後ろに接尾後 "_lp" を付与します。最後の ".0" は先頭行のデータを意味します。

出力ファイル名が空欄の場合、テンプレートファイル名が使われます。

プレースホルダに指定した項目は「一覧表示項目」として指定されている必要があります。一覧表示項目として指定し、表示時には隠し項目とすることもできます。
テンプレートファイルが .xls 形式ファイルだが、出力ファイル名を .xlsx とする、といったことはできません。出力ファイル名を指定するときは、テンプレートファイルの拡張子を使ってください。

帳票テンプレートで、出力方法を指定することもできます。

"ブラウザで表示" と "ダウンロード" を選択できます。空白時は "ブラウザで表示" となります。

図16 出力方法の指定

この設定は、HTTPレスポンスヘッダの"Content-Disposition"フィールドに相当します。"ブラウザで表示" は "inline" として、また "ダウンロード" は "attachment" としてそれぞれ反映されます。

"ブラウザで表示" は Wagby R6 との互換性のために残っていましたが、最新のブラウザでは動作しなくなっています。これはブラウザのセキュリティ対策強化によるものです。そのためこの設定は非推奨となっています。
Internet Explorer 利用時、出力方法に "ダウンロード" を指定した場合にダイアログが二重に表示されることがありますが、動作に支障はありません。

一覧表示画面には表示させないが、一覧帳票には出力させるような定義を行うこともできます。 図17では、会社名項目は一覧表示として指定していません。

モデル項目詳細定義の「出力制御>その他>帳票>一覧帳票に出力する」をチェックします。(図18)

図17 モデル定義で、会社名項目の一覧表示を無効とした
図18 一覧帳票に出力する設定

一覧帳票用のテンプレートから、出力しない項目のプレースホルダを記述しないようにします。 自動生成された一覧帳票テンプレートを用いている場合、当該項目のプレースホルダを除去してください。

一覧帳票用のテンプレートでは詳細帳票とは異なり、レコード数が動的に変更されます。そのためプレースホルダは1行にのみ記述します。生成されたWebアプリケーション側で必要なレコード数を増やす処理が行われます。このように、システム側で行の追加を行うことから、テンプレートファイルのレイアウトデザインにはいくつかの制限があります。

図19 顧客情報の一覧帳票用テンプレートの例

(1) プレースホルダの添字(数字部分)は#で記述する

挿入されるレコードは0から連番で増えていきますが、詳細帳票とは異なり、ここでは連番部分を "#" という「ワイルドカード」で表現し、これを1行のみ記述します(例:${customer_lp.name.#})。

(2) プレースホルダを複数行にわたって記述しない

1行にプレースホルダを記述してください。複数行にわたって記述することはできません。プレースホルダが記述された行より下部分は「フッター」と判断され、レコード出力の最後に記述されます。

(3) フッター部分の制約

プレースホルダの指定されている行より下の部分は、一覧帳票のテンプレートでは「フッター」と判断され、レコードを追加した最後にコピーされます。ただし以下のような制限があります。

  • フッター部分でセルの結合はできません。セルの結合情報が残ってしまうため、追加されるレコードのセルに影響します。
  • 式を記述できません。式の情報は消去されます。あるいは式のエラーが発生します。
  • 画像を貼ることができません。画像が元のセル位置に残ってしまうため、結果的に画像の位置がフッターとは異なる場所に表示されてしまいます。

これらの制約は、プレースホルダ行より上部(ヘッダ部分)には適用されません。

(4) 繰り返し項目の扱い

繰り返し項目は「,(コンマ)」区切りで出力されます。

(5) 繰り返し項目の扱い

繰り返しコンテナ内の項目は出力できません。(JOIN関数などを用いて繰り返しコンテナを「1つの」文字列に整形した出力用項目を内部で用意し、それを帳票で用いることはできます。

(6) モデル参照の扱い

モデル参照は「値」部分が出力されます。「コード」部分(モデルの主キー値)を指定することはできません。

(7) 全文検索結果の扱い

全文検索の結果を指定することはできません。

単一項目のグルーピング

列の値が同じであった場合にその列のセルを「(縦方向に)グルーピング」できます。このような処理を行わせたい場合は、プレースホルダに「$J」を付与します。

$J${customer_lp.companyname.#}
図20 グルーピング指定

出力イメージは図21のようになります。

図21 グルーピングによる出力イメージ

複数項目のグルーピング

複数項目をグルーピングすることもできます。 $G○(数字)を指定することで、同じ数字を指定した項目すべてがグルーピングされます。

$G1${customer_lp.companyname.#}
$G1${customer_lp.deptname.#}
図22 グルーピング指定

出力イメージは図23のようになります。$G1を含むセルに重複する値が存在した場合に自動的にセルの結合を行います。

図22 グルーピングによる出力イメージ

仕様

  • グルーピング処理は行(横)方向への結合はできません。
  • 詳細帳票には対応していません。

エラーメッセージを出力する (標準)

データが一件も存在しない場合に印刷ボタンを押すと、図24のようなエラーメッセージが表示されます。これが標準の動作です。

図23 データが存在しない場合に印刷ボタンを押下する
図24 別タブにエラーメッセージが表示される

エラーメッセージを出力しない設定

エラーメッセージを出力しない設定とすると、図25に示すようにファイルが生成されます。しかしデータ部は空となっています。(図26)

図25 空のファイルが出力される (1)
図26 空のファイルが出力される (2)

定義方法

「画面>帳票出力>出力対象データが無かったときにメッセージを表示する」を有効にします。(標準では有効になっています。)

図27 出力対象データが無かったときにメッセージを表示する設定

Excel帳票出力機能は、オープンソースのExcel生成ライブラリである Apache POI または JExcelAPI を使って実現しています。

通常は "POI" を選択してください。"JExcelAPI" は下位互換のために残していますが、積極的に用いることはありません。

テンプレートファイル

  • テンプレートファイルとして用いるExcelファイルの拡張子は ".xls" または ".xlsx" となります。[注意点...]
  • テンプレートファイルのファイル名は半角英数字のみとしてください。日本語文字は指定できません。
  • テンプレートの Excel ファイルでは、以下の機能を利用することはできません。
    • ピボットテーブル
    • ドロップダウンリスト
    • パスワード保護
  • テンプレートの Excel ファイルにマクロを設定した場合、正しく出力されないことがあります。この場合はマクロの内容を変えるなどして調整してください。
  • うまく印刷されない場合、帳票テンプレートの最初のシートに印刷領域が設定されているかどうかを確認ください。
  • プレースホルダから1つのセルに値をセットする場合、R7.10.3までは文字数の上限が1024文字です。R7.11以降は上限が32,767文字となります。

テンプレートファイルに .xlsx を利用した場合

拡張子 ".xlsx" 利用時には次の制約があります。

  • テンプレートファイルにセルコメントを含めることができません。

実行環境

  • Wagby アプリケーションを稼働させるサーバ機に Excel をインストールする必要はありません。サーバ機のメモリ上で直接 Excel ファイルを生成します。そのため出力処理中は一時的に多くのメモリを消費します。同時接続数が多い環境で、帳票出力が集中するような運用環境では、メモリを多めに搭載するようにしてください。
  • Excel ファイルを開くために、各利用者の PC (端末) には Excel または OpenOffice が必要です。