IT技術 副業

システム方式設計:「帳票処理方式」の書き方

IT技術
おく
おく

システム方式設計書(アプリケーション方式設計書)には具体的に何を書いたらいいのでしょうか。
せっかく作るのですから役に立つシステム方式設計書にしたいですよね。
システム方式設計書を作ったのはいいけど、しっかり活用できているでしょうか。
役に立つシステム方式設計書を作るコツをお話していきましょう。
今回は帳票処理方式にどのようなことを書いたらいいのかです。

帳票処理方式に書くこと

帳票処理方式は帳票を出力するための仕組みを設計する章です。
Webシステムの様なオンラインシステムで帳票出力というのは「CSVファイルダウンロード」「エクセルファイル」「pdfダウンロード」「プリンタ出力」などが主でしょうか。
これらを実現するためにどのようなアプリケーションを使ったり、どんなデータを作って帳票出力機能に渡したらいいのかなどを設計します。

今回は帳票処理方式について説明します。
システム方式設計書の全体構成については以下の記事をご覧ください。

帳票処理方式に書く要素

帳票処理方式にはどのようなことを書いたらいいのでしょうか。
必要な要素を列挙してみます。
一応、前提としてWebシステムを想定します。

・アプリケーション構造
・フォルダ構成
・出力方式(ファイル出力、プリンタ出力などを決める)
・ファイル形式
・印刷レイアウト
・中間ファイル管理
・管理方式(保管)

これらの要素について「概要」「方式設計」「実装方式」の3部構成で説明していくとよいでしょう。
この構成については以下の記事をご覧ください。

帳票処理方式の「概要」

概要には帳票に対する要件とその方式を書きだしていきます。
きれいな文章にならなくてもいいでしょう。
箇条書きで要件と選択する方式、その理由を書きだしていきます。
方式設計ではその方式の仕組みを説明していきます。

では、そのような要件があるでしょうか、例を挙げてみます。
・手元印刷、センター印刷などの方式
・出力ファイルの種類
・印刷前のブレビュー機能
・特殊用紙(専用用紙)や専用プリンタの有無
・特殊文字やバーコードの要件有無
・印刷履歴の管理(再印刷)

これらの要素について「方式設計」の章で仕組みの説明をしていきます。

帳票処理方式の「方式設計」

「方式設計」章では帳票を出力するために必要な仕組みを設計していきます。
主な設計要素を挙げてみます。

アプリケーション構造

クライアント端末やバッチ処理から帳票出力を行う場合の流れがわかるように構造を説明します。
重要なポイントは、どのサーバにどのような機能を実装させるか。
必要な定義ファイルなどはどこに保存されているのか。
出力する帳票はどこのサーバもしくは端末から印刷するのか。
ファイル形式の場合はダウンロードするファイルをどのように転送するのか。
などを説明します。
このような仕組みがわかるようなアプリケーション構造図を書くとよいでしょう。

フォルダ構成

帳票作成に必要なファイルを置くサーバのフォルダ構成を明らかにします。
帳票の場合、帳票定義体、作成した帳票ファイル、作成の中間ファイルなどを配置するフォルダ構成を具体化します。

出力方式

帳票をプリンタに出すのかファイルダウンロードするのかを決めます。
またその場合の仕組みを明らかにします。
プリンタに出力する場合は、クライアント端末に接続されたプリンタから出すのか、サーバに接続された端末から出すのかなど考えられます。

クライアント端末のプリンタから出す場合は、クライアントまで印刷データを転送してプリンタドライバを起動する必要があります。
サーバに接続されたプリンタの場合、複数プリンタからどのように出力するプリンタを選択するのかなどを考えます。

ファイル形式

帳票出力でファイルのダウンロードをさせる場合は、ダウンロード可能なファイル形式を決めます。
ファイル形式によってクライアント端末で表示するためのツールが必要になります。
クライアントの端末要件にも影響します。

中間ファイル管理

帳票作成のために作成した中間ファイルの管理方法を検討します。
中間ファイルのファイル名や不要になったときに削除する方法を決めます。

ファイル名は一意になるように考えます。
Webシステムの場合、不特定多数の人が同じ機能を使うことを想定します。
同時に作成してもファイル名が重複しないようにファイル命名規約を考えます。

上記で作成したファイルが印刷またはダウンロードが終わると不要になります。
不要になったファイルをいつ、どのように削除するのか仕組みを考えます。

帳票処理方式の「実装方式」

帳票を作成するために必要な情報を記載します。
対象は開発者向けです。
帳票出力はミドルウェアを利用することが多いので、ミドルウェアを呼び出すための具体的なAPIを記載します。
マニュアルを読めば書いていますが、このシステムで使う方法に限定して書きます。
ミドルウェアは多種多様な使い方ができます。
これを各開発者が自由に使うとバラバラな方式になっています。
このシステムで必要な帳票要件から必要な呼び出し方式に限定して使うことをルール化します。

コメント

タイトルとURLをコピーしました