レポート機能を使いこなす

OBDZは設計書作成作業をシステム化し、設計工程の合理化・標準化を実現できるツールです。
本連載では、設計書ジェネレータ「SI Object Browser Designer（以下、OBDZ）」を使ってソフトウェアの設計書（仕様書、基本設計書、詳細設計書）を作る講座です。

今回は、レポート機能関連の便利なテクニックをご紹介します。
レポート出力機能については、「画面設計書を作成する」、「設計書をカスタマイズする」でもご紹介しましたが、 細かなテクニックもあわせてご紹介したいと思います。

操作方法を覚えるには、実際に製品を触りながら行うのが一番ですので、 OBDZをお持ちでない方はぜひ評価版をインストールの上、お読みください。 以下のURLよりお申込みいただくと、製品のログインに必要なアカウントを取得いただけます。
https://www.sint.co.jp/products/obdz/trial/trial.html

OBDZのレポート出力の概要

最初に、OBDZのレポート機能の特長についておさらいしてみたいと思います。
OBDZでは専用の画面で設計データを作り、最後にレポートを生成する流れで基本設計書、詳細設計書を作成します。

図１．OBDZのレポート作成方法（２段階で作成）

ExcelやWordで直接設計書を作成している方には一見面倒と思われるかもしれませんが、 これは、OBDZが効率よく、品質の高い基本設計書、詳細設計書を作成できるように「設計データ」と「レポートフォーマット」の設定（データ）を それぞれ独立させているためとなります。

プログラマの方であれば「MVCモデル」と同じだと思えば、わかりやすいと思います。
例えば、Excelのみの運用ですと、設計書を作った後でフォーマットだけ一括変更することは、非常に労力がかかりますが、 OBDZではこのような場合もフォーマット設定だけ変更して再出力ができるメリットがあります。

図２．OBDZのレポート出力のメリット

 また、OBDZの各画面は設計データを作ることに特化され、統一されたインタフェースとなっています。これにより、 画面レイアウトを作成するとコントロール定義も自動生成される等の生産面のメリットや、各設計者のスキルや経験に依存せず、 統一された設計内容、フォーマットで作成できるメリットがあります。さらに、設計データは自動バージョン管理されるため、 後で過去バージョンのレポート生成できるなどの管理面のメリットもあります。

このように生産性やメンテナンス面、管理面をトータルで考えた場合、従来の運用よりも大きなコストメリットを生み出せることがOBDZの特長となっています。

レポート生成のテクニック

前述のようにOBDZでは「出力設定」を変えることで柔軟にレポートを出力することが可能となっています。
今回はその具体的な手順をいくつかの例でご紹介したいと思います。

①過去バージョンの設計書を出力する

OBDZのバージョン管理機能を使用して、過去バージョンの設計書を出力が可能となりました。
当機能を利用するには、あらかじめシステム画面でバージョンを記録する必要があります。
これは、ソース管理ソフトの「VSS」でいうラベル機能のようなもので、システム（バージョン）全体に対してバージョンを記録するものになります。 システム画面の基本情報タブの「変更」ボタンを押すと、以下のバージョン一覧画面が表示されます。この画面の「新規作成」ボタンより、新たにバージョンを記録することができます。

画面１．システム登録画面

 バージョンを記録すると、レポート出力画面の「システムバージョン」コンボボックスに記録したバージョンがプルダウン表示されます。こちらを選択して出力するとバージョンを記録した時点の設計書が出力されます。

画面２．レポート出力画面

②Excel上や印刷時に表示が切れないようにする

例えばコントロール定義の「備考」列などに、長い文字列を入力し、レポート出力すると文字が切れてしまう場合があります。 また、Excelの画面上での表示は切れていなくても、プリンタで印刷すると表示が切れてしまう場合もあります。 これを防止するために、レポートの出力オプションで余白を挟むことが可能です。 利用する場合は、レポート出力画面にて「出力」ボタンを押した際に表示されるオプション画面にある「セルの高さを自動で調整する」 というチェックボックスをONにして出力します。これにより、長い文字列が入った箇所や改行が入った箇所は、 自動でセルの行高が高くなり、表示が切れないようになります。

画面３．レポート出力オプション

画面４．「セルの高さの自動調整」オプションをONにして出力した場合

 ただし、特定のデータに多く改行を入れている場合は、当オプションをONにしても表示が切れてしまう場合があります、 その場合は、さらに右にあるスライダーの設定を調整します。スライダーのつまみを「多い」に近づけるほど余白行が多く出力されますので、 完全に表示が切れないようにすることも可能です。

③画面設計書のみをまとめて出力する

設計書を作成する際、１つの画面のレイアウト定義、コントロール定義などをまとめて詳細設計書として出力したいときもあれば、 画面レイアウト設計書だけを基本設計書としてまとめて出したいときもあります。このような場合も、レポート出力のオプション画面 にある「複数出力時、1ファイルにまとめる」というチェックボックスで出しわけが可能となっています。

画面５．レポート出力オプション

ONの場合は、１つのExcelファイル上にシート分割された上、複数の機能がまとめて出力されます。
OFFの場合は、画面や帳票などの機能ごとにファイル分割されてExcelが作成されます。

画面６．「1ファイルにまとめる」オプションをONにして出力した場合

 例えば、画面レイアウト定義など、特定の設計書だけをまとめて出す場合はONにすると便利です。

④フォーマットの設定を別のシステムに引継ぐ

最後にフォーマットのカスタマイズ設定を他のシステム（プロジェクト）に引き継ぐ方法についてご紹介します。 例えば、あるシステムでカスタマイズした内容を別システムでも利用したい場合、システムのコピー機能を利用することで可能です。 コピーする場合は、システム一覧よりコピー元のシステムの右にある「…」をクリックし、ポップアップメニューから「システムコピー」を選択します。

画面７．システムエクスプローラ

 以下のようなコピーの設定画面が表示されますので、コピー先のシステムコード（プロジェクトコード）、システム名の情報を入力します。 また、同画面にある各チェックボックスで画面や帳票などの各設計データやそのバージョン履歴、システムの閲覧可能なアカウント設定を 同時に新システムにコピーすることも可能です。これらを設定後、「OK」ボタンを押すことでコピーが実行されます。 システムをコピーした場合、自動でフォーマット設定の他、表示項目や予備項目、データ型などのカスタマイズ設定がすべて引き継がれます。

画面８．システムのコピー画面

いくつかのよくある例をもとにテクニックをご紹介しました。今回ご紹介したオプション以外にも、画面レイアウトのサイズ自動調整など さまざまな出力設定が可能ですので、ぜひご活用いただきたいと思います。

出展：ブラックジャックによろしく　佐藤秀峰　漫画 on web　（http://mangaonweb.com）