2021年8月4日勉強会レポート　設計書（参加者執筆）①

このレポートは、8/4に実施された勉強会を基にSAP設計書（クエリ）の手順と感想をまとめます。

（今回はクエリができた状態で、設計書を作成するやり方を例にしています）

設計書（クエリ）の概要

設計書はベンダーが主に見るものであるため、詳細に書く必要はありませんが、パッと見て分かりやすい資料を作成することが求められます。

クエリとは、データ照会機能を簡単に作れるための機能です。ここでは、クエリの設計書作成について書いていきます。

設計書作成（クエリ）の手順

1. 表紙

表題を記入。

（今回は、SAPクエリ　生産BOM／販売BOMクエリ　外部設計書）加えて、変更履歴の枠を設けて、「日付け、編集者の名前、変更点」を記入する必要があります。

2. オブジェクト関連図

※ページの頭に以上の情報を記載する必要があります。

※以上の図は、(a),(b),(c)をどこに記載するかを明らかにすることが目的のため、省略して書いています。

オブジェクトの関連図を作成する際に記載するのは「（a）結合条件、（b）トランザクションコード（今回は、販売BOMと生産BOM）、（c）各システムバリアントの値（販売BOM、生産BOM）」です。

以下にどのようにそれらを指定するかについて書きます。

(a)結合条件は「SQ02：インフォセット」（対象のインフォセットを選択）→「結合」。結合条件を見ることができます。

(b)トランザクションコードは「SE93」と、「SE16からTSTCT：トランザクションコードが集まるテーブル」の二通りで調べることができます。

(c)「SE93」より、システムバリアントの値を調べることができます。（今回は販売BOMのトランザクションコードを入力した後にシステムバリアントの値を見ることができました）

3. 画面レイアウト

※ページ頭に記載します。

「SQ01」を指定（a）クエリ選択画面レイアウトを照会し記載します。

（b）項目定義も記載します。

なお項目定義には、選択画面表示項目、SAPテーブル名、項目名を記載します。

「基本一覧」→「技術名称」からこれらを照会することができます。

（b）項目定義例

4. 実行画面

※ページ頭に記載します。

「SQ01」を指定（a）クエリ実行画面を照会し記載します。

（b）項目定義も記載します。

（b）項目定義例

※#２のようなテキスト項目のSAPテーブル名と、項目名はインフォセットの「テキストテーブル」より照会することができます。

勉強会の感想

みさきちゃんは、理解しやすいように色々な資料を準備してくれたので設計書の作成方法が理解しやすかったです。

設計書を作成する段階で、テストを見据えた設計書を作成することができればテストをスムーズに行えると考えました。

課題

オブジェクトの関連図を正確に書けるようにする。

特に、結合条件に関してそれが内部なのか、外部なのかはインフォセットから確認することはできますが、確認するだけではなく、設計書を書くにあたり完全に理解しておく必要があると考えました。

項目定義などは、値をそのまま正確に抜きとる必要があるためにコピーアンドペーストを有効活用し、ミスを出さない。

今回の設計書はクエリ作成でしたが、トランザクションコードの探し方などは、他の場面にも使えるので一度習ったことを、違う場面でもアウトプットするようにします。

【総帥コメント】

いくつか解釈に誤りがある。

①「設計書はベンダーが主に見るものであるため、詳細に書く必要はありませんが」は、いくつもの意味で全く違う。

まず、設計書はユーザも見るし、ユーザからレビューOKを頂かなければ先＝実装に進むことはできない。

また、設計書はあくまで実際のモノづくりのために設計を行いその結果をまとめたものであるため、詳細に書かなくても良いというわけではない。記載に過不足や曖昧さがあってはモノづくりに差し支えてしまう。

②設計書の書き方についてメモを取っているが、設計書の記載の仕方は会社やプロジェクトによって異なるため、書き方を覚えるという表面的なアプローチは良くない。

設計書に必要なエッセンスは、その機能が必要である背景、機能における関連オブジェクト、機能の振る舞い、Inputにあたる選択画面や入力ファイル、Outputにあたる結果画面や出力ファイルなど。今回の題材はたまたまSAPクエリだったのでインフォセットやシスバリが登場したに過ぎない。

みか