本記事では、Creative Content Lab Tokyo（クリエイティブコンテンツラボトウキョウ）が作成した帳票定義書のテンプレートをご提供しております。
帳票一覧が必要な方はこちらからダウンロードしてご利用ください。
帳票は、出力項目やレイアウトよりも先に出力件数の見積もりが問題になります。他の成果物との関係と作る順序は、システム設計書のテンプレート一覧にまとめています。
1.サンプル
1.帳票定義書のサンプル
帳票レイアウト
帳票項目定義
画像はクリックすると拡大表示されます。
2.テーラリングガイド
処理概要
帳票出力に関する処理概要など基本設計で利用します
[主要項目]
- 処理概要：帳票の処理概要を定義
- 帳票レイアウト：帳票イメージを添付
- 操作概要：帳票出力の操作概要を記述
- オブジェクト構成：帳票で利用するオブジェクトのCRUDを定義
- メッセージ一覧：メッセージを定義
- アクター：帳票を利用するプロファイルを定義
帳票レイアウト
帳票レイアウトの各項目やコンポーネントに対して番号を採番しておき、後続の画面項目とマッピングしておきます。
帳票項目定義
帳票レイアウトで採番した番号と一致するように番号と項目名を定義します
[主要項目]
- 表示ラベル：項目の論理名を定義
- 固定・可変：表示項目の値が固定値か可変値かを定義
- フォント種類：利用するフォントの種類を指定
- ポイント：利用するフォントのポイント（サイズ）を指定
- 表示位置：値を表示する位置を定義
- スタイル：フォントのスタイルを定義
- フォーマット：日付や数値の表示フォーマットを定義
- 取得元オブジェクト：値を取得する元のオブジェクトを定義
- 取得元項目：値を取得するオブジェクト項目を定義
- 編集：取得した値を加工する必要がある場合に編集内容を定義
- 補足：項目の補足
入出力処理設計
帳票の詳細設計（プログラムレベル）の処理を定義します。
SOQL定義
入出力処理設計で利用するSOQLを設計します。
帳票設計の進め方
帳票設計でつまずくのは、レイアウトを描き始めるのが早すぎるときです。出力方式と項目を先に決めると、後戻りがほとんど無くなります。 順番としては次の4つになります。- 出力方式を決める：画面から即時出力するのか、バッチでまとめて出すのか。PDFなのか、Excel・CSVなのか。これで実装方式が変わるため最初に決めます。
- 出力項目を洗い出す：どのデータをどこから取るかを、項目単位で確定させます。ここが曖昧なままレイアウトを描くと、後から「その項目は取れない」が発生します。
- レイアウトを決める：用紙サイズ、向き、明細の行数、改ページの条件、繰り返し部分の扱いを決めます。改ページ条件の決め忘れが最も多い漏れです。
- 件数と性能を確認する：最大何件出るのか、その件数で現実的な時間に収まるのかを見ます。帳票は本番データで初めて破綻することが多い領域です。
帳票定義書のダウンロード
資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。
一般公開資料
update 2022/04/17 直接エクセルファイルをダウンロードするリンクを追加
帳票定義書（EXCEL版）のダウンロードはこちら
以下は、スプレッドシートでの表示となります。
帳票定義書をスプレッドシートで開く
関連記事
他にも要件定義で必要となる以下のようなテンプレートなども用意しているのでぜひご利用ください。
サポーターさんブログランキングに参加しましたので、ご支援していただけると幸いです。
