バッチの設計書作成のコツ

本連載は、設計書ジェネレータ「SI Object Browser Designer（以下、OBDZ）」を使ってソフトウェアの設計書（仕様書、基本設計書、詳細設計書）を作る講座です。今回はOBDZのバッチ設計のコツをご紹介します。OBDZにご興味があればぜひ評価版をお申込みください。以下のURLよりお申込みいただくと、製品のログインに必要なアカウントを取得いただけます。
https://www.sint.co.jp/products/obdz/trial/trial.html

OBDZによるバッチ設計書のコツ

以下の図はEコマースのサンプルのバッチです。受注データの状態を確認し、未入金かつ未出荷であれば、受注一覧伝票を作成、そうでなければエラーログにエラーを出力するサンプルとなっています。

図．バッチのサンプル

これをOBDZで表現するには、「編集メニュー」→「新規作成」→「新規バッチ」より新規バッチを作成します。名前は「受注データ作成」にします。次にバッチ画面の「ロジック」タブで右クリック→「ロジックの新規作成」を選択し、「メインコントロール」というロジックを新規作成します。メインコントロールは複数ロジックの制御用となるロジックです。また、「存在チェック」「受注一覧出力」「エラーログ出力」という上記の処理に対応するロジックも新規作成し、メインコントロールのアクション欄に関連付けます。以下がメインコントロールの設計画面です。

画面１．メインコントロールのサンプル画面

また、「存在チェック」「受注一覧出力」「エラーログ出力」ロジックのサンプルは画面２~４の通りです。在チェックでは「受注ヘッダ」というテーブルを参照の上、存在チェックをしています。また、受注一覧出力では、受注伝票（帳票）と関連付けています。このように、生成する伝票やアクセスするテーブルはメインコントロールではなく、サブロジック側に記載するのがポイントです。また、細かな条件は備考や処理内容に記載します。

画面２．存在チェックのロジック画面

画面３．受注一覧出力のロジック画面

画面4．エラーログ出力のロジック画面

ロジック画面の「項目名」「操作」列について 項目名列には「名称」列に画面が選択されていればコントロール名、「名称」列にテーブル名が選択されていれば列名がプルダウン選択できますが、当サンプルのように項目名は省略（未入力）にしても問題ありません。「操作」列にはCRUD情報を入力しますが、こちらは必ず入れたほうが良いでしょう。「クロスリファレンス機能」による影響範囲確認や、「CRUD図」などが出せるようになります。

以上で入力は完了です。最後に受注データ作成バッチの「モジュール関連図」タブを開いてみましょう。

画面５のように自動でフローが生成されています。個々のロジックやテーブル、帳票をダブルクリックすることで個々の設計画面にドリルダウン表示することもできます。また、レポート出力すると、このモジュール関連図やや個々のロジック定義書がバッチ設計書として生成されます。

画面５．バッチのサンプル画面

いかがでしたでしょうか。ポイントは「従来のフローで描いていたことを表で表現する」ということです。はじめは慣れが必要かもしれませんが、基本的には同じ作業です。また、どうしてもフローチャートで設計したいという場合は、バッチの補足説明タブにて描く運用もできますが、クロスリファレンスなどの機能を使うには今回用のようにロジック表で表現する必要があります。ぜひ今回の記事を参考に挑戦してほしいと思います。