Main Content

要件トレーサビリティ レポートの作成とカスタマイズ

モデルの要件トレーサビリティ レポートの作成

Simulink® モデルの既定の要件レポートを作成するには、次を行います。

  1. モデル例を開きます。

    openExample("slvnvdemo_fuelsys_officereq.slx")

  2. 現在の作業フォルダーが書き込み可能であることを確認します。

  3. [アプリ] タブで、[要件マネージャー] をクリックします。[要件] タブで、[共有] 、 [モデルのトレーサビリティ レポートの生成] を選択します。

    モデルが大きく、要件リンクが多い場合、レポートの作成に数分間かかります。

Web ブラウザー ウィンドウが開き、レポートの内容が表示されます。次の図は slvnvdemo_fuelsys_officereq モデルの [目次] を示しています。

Requirements report for the slvnvdemo_fuelsys_officereq Simulink model

一般的な要件レポートの内容は次のとおりです。

  • 目次

  • 表目次

  • サブシステムごとのセクション。次の内容が含まれます。

    • 要件があるオブジェクトと、関連する要件ドキュメントへのリンクが記載された表

    • 要件があるオブジェクトのグラフィック イメージ

    • 要件がないオブジェクトの一覧

    • MATLAB Function ブロック内に要件がある MATLAB® コード行

要件レポートの詳細については、モデルの要件トレーサビリティ レポートのカスタマイズを参照してください。

モデルにライブラリ参照ブロックがある場合

ライブラリ参照ブロックに関連付けられた要件リンクを含めるには、[要件の設定] の [レポート] タブで [参照ライブラリおよびデータ ディクショナリ内のリンクを含める] を選択しなければなりません (要件レポートのカスタマイズを参照)。

モデルにモデル参照ブロックがある場合

既定では、モデル内のモデル参照ブロックの中の要件リンクは要件トレーサビリティ レポートに含められません。参照モデルの要件情報を含むレポートを生成するには、モデル ブロックの要件のレポートの手順に従ってください。

モデルの要件トレーサビリティ レポートのカスタマイズ

既定の要件レポートの作成

外部要件ドキュメントへのリンクが存在するモデルがある場合、そのリンクに関する概要と詳細情報が記載された HTML レポートを作成できます。また、このレポートに含まれているリンクを使用して、モデルと要件ドキュメントを双方向に移動できます。

モデルとそのオブジェクトに関連付けられたすべての要件に関する情報が含まれた、既定のレポートを生成することができます。

メモ

レポートの作成対象となるモデルに Model ブロックがある場合は、モデル ブロックの要件のレポートを参照してください。

レポートを生成する前に、Stateflow® チャートに要件を追加して、要件レポート内の Stateflow に関する情報を確認できるようにします。

  1. モデル例を開きます。

    openExample("slvnvdemo_fuelsys_officereq.slx")

  2. fuel rate controller サブシステムを開きます。

  3. Microsoft® Word 要件ドキュメントを開きます。

    openExample( ...
    "slrequirements/ManageReqsForFaultTolerantFuelCtrlSysMicrosoftOffice07Example", ...
    supportingFile="slvnvdemo_FuelSys_RequirementsSpecification.docx")

  4. control logic Stateflow チャートからこのドキュメント内の場所へのリンクを作成します。

  5. モデル例は開いたままにして、要件ドキュメントを閉じます。

slvnvdemo_fuelsys_officereq モデル用の既定の要件レポートを生成するには、[要件] タブで、[共有] 、 [モデルのトレーサビリティ レポートの生成] を選択します。

要件管理インターフェイス (RMI) はモデル内のすべてのブロックとサブシステム内で関連付けられている要件を検索します。RMI では完全なレポートが HTML 形式で生成され、表示されます。

このレポートは既定の名前 (model_name_requirements.html) で保存されます。その後、同じモデルでレポートを生成すると、新しいレポート ファイルによって以前のレポート ファイルが上書きされます。

このレポートの内容は次のとおりです。

目次.  [目次] には、レポートの主なセクションの一覧が表示されます。最上位モデルの [System] セクションが 1 つあり、さらにサブシステム、Model ブロックまたは Stateflow チャートごとに [System] セクションが 1 つあります。

リンクをクリックすると、モデルの特定のセクションに関する情報が表示されます。

Table of contents listing the seven systems and one chart in the slvnvdemo_fuelsys_officereq Simulink model

表目次.  [表目次] には、レポート内の各表へのリンクがあります。

List of the 13 tables in the requirements report for the slvnvdemo_fuelsys_officereq Simulink model

モデル情報.  [モデル情報] には、モデルの作成日時や最終変更日時などの一般的な情報が表示されます。

Model information chapter from the requirements report. The table shows the original model was created in 1998 and last modified in 2010.

概要.  [概要] セクションには、slvnvdemo_fuelsys_officereq モデル内のオブジェクトがリンクしているすべての要件ドキュメントの一覧と、各ドキュメントに関する追加情報が表示されます。

Document summary chapter from the requirements report. A table lists four linked requirements.

  • ID — ID。この例の DOC1、DOC2、DOC3、DOC4 は、このモデルからリンクされている要件ドキュメントの省略名です。

    レポートを生成する前に、[要件の設定] ダイアログ ボックスの [レポート] タブで [要件テーブルのドキュメント ID を使用] を選択すると、要件ドキュメントを参照する際に、レポート全体のリンクには、これらの省略名が含まれるようになります。レポート内で省略名で表示されたリンクをクリックすると、そのドキュメント ID に関連付けられている要件ドキュメントが開きます。

    要件ドキュメントのパス名が長すぎてレポートが煩雑になる場合、[要件テーブルのドキュメント ID を使用] オプションを選択します。この節の例で示されているように、このオプションは既定では無効になっています。

  • モデルに保存されたドキュメント パス — このリンクをクリックすると、要件ドキュメントがネイティブ アプリケーションで開きます。

  • 最終変更日時 — 要件ドキュメントが最後に変更された日時。

  • # 個のリンク — 要件ドキュメントへのリンクの総数。

システム.  それぞれの [System] セクションの内容は次のとおりです。

  • モデルまたはモデル オブジェクトのイメージ。要件があるオブジェクトが強調表示されます。

    System chapter from the requirements report includes a static image of the model

  • 当該のモデルまたはモデル オブジェクトに関連付けられた要件の一覧。この例では、目的のドキュメント名をクリックして slvnvdemo_fuelsys_officereq モデルに関連付けられている要件ドキュメントを開きます。

    Table that lists a Microsoft Word document that contains requirements linked to the model

  • 要件がある最上位モデルのブロックの一覧。この例では、最上位では MAP sensor ブロックにしか要件がありません。[ターゲット:] の横にあるリンクをクリックして、MAP sensor ブロックに関連付けられている要件ドキュメントを開きます。

    Table that lists the block in slvnv_demo_fuelsys_officereq that has associated requirements

    上記の表には、以下の理由によりこれらの最上位モデルのブロックがありません。

    • fuel rate controller および engine gas dynamics サブシステムはレポート内の専用の章にあります。

    • このレポートでは、Signal Builder ブロックは別途記載されています (この例では表 3.3)。

  • すべての Signal Builder ブロックの各信号グループに関連付けられている要件と、各信号グループのグラフィックスの一覧。この例では、最上位モデルの Signal Builder ブロック Test inputs に、要件リンクを含む信号グループが 1 つあります。[ターゲット (ドキュメント名と場所 ID)] の下のリンクをクリックすると、Test inputs ブロック内のこの信号グループに関連付けられた要件ドキュメントが開きます。

    Table that lists a test input and the linked requirement. The section also includes an image of the signal group.

チャート.  各 [Chart] セクションには Stateflow チャートの要件に関するレポートが表示されます。内容は以下のとおりです。

  • 各ステートを表す Stateflow チャートのグラフィックス。

  • 要件がある要素の一覧。

    チャートの要素に関連付けられた要件ドキュメントに移動するには、[ターゲット] の横のリンクをクリックします。

    Table that lists the Stateflow objects and the linked requirements.

モデル ブロックの要件のレポート

モデル内の Model ブロックが外部のモデルを参照する場合、既定のレポートには参照モデル内の要件に関する情報は記載されません。参照モデルの要件の情報が記載されたレポートを生成するには、Simulink Report Generator™ ソフトウェアのライセンスが必要です。このレポートには、最上位モデルに関してと同様に、参照モデルに関する情報とグラフィックスが含まれています。

Simulink Report Generator ライセンスを保有している場合は、要件レポートの生成前に次の手順に従います。

  1. 要件レポートの作成対象となるモデルを開きます。このワークフローでは、モデル例 slvnvdemo_fuelsys_officereq を使用します。

  2. 既定の要件レポートのテンプレートを開くには、MATLAB コマンド プロンプトで以下を入力します。

    setedit requirements

  3. Simulink Report Generator ソフトウェア ウィンドウの左端のペインで Model Loop コンポーネントをクリックします。

    Tree of report options tree in the Report Explorer window

  4. 右端のペインには [モデル参照] フィールドがあります。このフィールドのドロップダウン矢印が表示されない場合は、ペインを拡大してください。

    Model Options pane in the Report Explorer window

  5. [モデル参照] フィールドのドロップダウン リストから、[すべてのモデル参照ブロックに従う] を選択します。

  6. 開いているモデルについて、参照モデルに関する情報を含む要件レポートを生成するには、[レポート] アイコン をクリックします。

要件レポートのカスタマイズ

要件管理インターフェイス (RMI) では Simulink Report Generator ソフトウェアを使用して要件レポートを生成します。要件レポートをカスタマイズするには、RMI または Simulink Report Generator ソフトウェアを使用します。

RMI 設定による要件レポートのカスタマイズ.  [要件の設定] ダイアログ ボックスで要件レポートをカスタマイズする方法は複数あります。

Requirement Settings dialog box. The Report tab is selected.

[レポート] タブで、レポートに必要な内容を指定するオプションを選択します。

[要件の設定] のレポート オプション説明

モデルを強調表示してからレポートを作成

レポート グラフィックスにおいて、要件をもつ Simulink オブジェクトの強調表示を有効にします。

参照ライブラリ内のリンクを含める

生成されたレポートに参照ライブラリ内の要件リンクが含められます。

要件へのリンクがないオブジェクトをレポート

要件がないモデル オブジェクトの一覧が表示されます。

レポート内のリンクごとにキーワードを表示

ユーザー キーワードがある場合は、レポート内のリンクごとに、ユーザー キーワードを一覧表示します。

要件テーブルのドキュメント ID を使用

ドキュメント ID が使用可能な場合、要件レポートの表には、パス名ではなくドキュメント ID を使用します。この機能を使用すると、要件ドキュメントのパス名が長すぎるためにレポートの表が煩雑になることはありません。

リンクされたドキュメントからの詳細を含める

リンクされている要件の詳細情報が表示されます。次の要件ドキュメントに適用可能です。

  • Microsoft Word

  • Microsoft Excel®

  • IBM® DOORS®

Simulink オブジェクトへのリンクを含める

レポートから Simulink のオブジェクトへのリンクが表示されます。

内部 HTTP サーバーを使用してシステム ブラウザーからの移動をサポート

生成されたレポートからドキュメントやモデル オブジェクトへの移動に内部 MATLAB HTTP サーバーを使用します。この設定を選択した場合、MATLAB 内部 HTTP サーバーがローカル ホストでアクティブである限り、システム ブラウザーからこの移動ができます。内部 HTTP サーバーを起動するには、MATLAB コマンド プロンプトで rmi('httpLink') と入力します。

これらのオプションがレポートの内容にどのように影響するか確認するには、次の手順に従います。

  1. slvnvdemo_fuelsys_officereq モデルを開きます。

    openExample("slvnvdemo_fuelsys_officereq.slx")

  2. [アプリ] タブで、[要件マネージャー] を選択します。

  3. [要件] ペインで、[ビュー] ドロップダウン メニューを [リンク] に設定します。

  4. [要件] タブで、[リンクの設定] 、 [リンク オプション] を選択します。

  5. [要件の設定] ダイアログ ボックスで [レポート] タブをクリックします。

  6. この例では、[モデルを強調表示してからレポートを生成] を選択します。

    このオプションを選択した場合、レポートを生成する前にレポートで表示されるモデルのグラフィックスが強調表示されるため、どのオブジェクトに要件があるか簡単に確認できるようになります。

  7. [要件の設定] ダイアログ ボックスを閉じるには、[閉じる] をクリックします。

  8. 要件レポートを生成します。[要件] タブで、[S] を選択します。

    要件レポートがブラウザー ウィンドウで開き、レポートの内容を確認できるようになります。

  9. 要件レポートの生成時に現在のレポートが上書きされるのを防ぐには、HTML ファイルの名前を (たとえば slvnvdemo_fuelsys_officereq_requirements_old.html に) 変更します。

    既定のレポート ファイル名は model_name_requirements.html です。

  10. [要件] タブで、[共有] 、 [モデルのトレーサビリティ レポートの生成] を選択します。

    • レポート内のリンクごとにキーワードを表示 — 各要件に関連付けられたユーザー キーワード (存在する場合) の一覧がレポートに表示されます。

    • リンクされたドキュメントからの詳細を含める — 次の種類の要件ドキュメントにある要件の詳細情報がレポートに表示されます。

      要件ドキュメントの形式レポートに含まれる内容

      Microsoft Word

      要件の段落またはサブセクションのテキスト全体 (表を含む)。

      Microsoft Excel

      ターゲットの要件がセルのグループである場合、レポートにはすべてのセルが表として表示されます。ターゲットの要件が 1 つのセルである場合、レポートにはそのセルが表示され、さらに同じ行でターゲットのセルより右側にあるすべてのセルもあわせて表示されます。

      IBM DOORS

      既定では、レポートに次の内容が含まれます。

      • DOORS Object Heading

      • DOORS Object Text

      • [Created Thru] 以外のすべての属性、空の文字列値がある属性、false であるシステム属性。

      関数 RptgenRMI.doorsAttribs を使用すると、特定の属性や属性のグループを指定または除外することができます。

  11. [要件の設定] ダイアログ ボックスを閉じます。

  12. 新規要件レポートを生成します。[要件] タブで、[共有] 、 [モデルのトレーサビリティ レポートの生成] を選択します。

  13. この新しいレポートを、手順 7 で名前を変更したレポートと比較します。

    • 要件リンクに関連付けられているユーザー キーワードが表示されています。

    • 要件の詳細情報が手順 9 で指定したとおりに表示されています。

  14. レポートを確認したら、レポートとモデルを閉じます。

Simulink Report Generator を使用した要件レポートのカスタマイズ.  Simulink Report Generator ソフトウェアのライセンスを保有している場合、既定の要件レポートをさらに変更することができます。

MATLAB コマンド プロンプトで、以下のコマンドを入力します。

setedit requirements

レポート エクスプローラーの GUI で、要件レポートの生成時に RMI で使用される要件レポート テンプレートが開きます。このレポート テンプレートには、要件レポートの構造を定義する Simulink Report Generator コンポーネントがあります。

中央のペインでコンポーネントをクリックすると、そのコンポーネントで指定できるオプションが右側のペインに表示されます。特定のコンポーネントを使用してレポートをカスタマイズする方法の詳細については、右側のペインの下部にある [ヘルプ] をクリックします。

Simulink Report Generator では、標準的なレポート コンポーネントの他に、[要件管理インターフェイス] カテゴリにある RMI 特有のコンポーネントを使用できます。

Simulink Report Generator コンポーネントレポート情報
要件が設定されていないブロックのループ (Simulink Report Generator)すべての子コンポーネントを、要件がないブロックに適用する
要件が設定されていないシステムのループ (Simulink Report Generator)すべての子コンポーネントを、要件がないシステムに適用する
要件が設定されたブロックのループ (Simulink Report Generator)すべての子コンポーネントを、要件があるブロックに適用する
要件ドキュメント テーブル (Simulink Report Generator)要件ドキュメントの一覧表を挿入する
要件が設定された信号ループ (Simulink Report Generator)すべての子コンポーネントを、要件がある信号グループに適用する
要件の概要テーブル (Simulink Report Generator)要件が関連付けられているブロックの要件情報の一覧が表示されるプロパティ テーブルを挿入する
要件が設定されたシステムのループ (Simulink Report Generator)すべての子コンポーネントを、要件があるシステムに適用する
サブシステム要件テーブル (Simulink Report Generator)システム要件とサブシステム要件の一覧が表示されるテーブルを挿入する
データ ディクショナリ トレーサビリティ テーブル (Simulink Report Generator)データ ディクショナリの情報を要件にリンクするテーブルを挿入する
MATLAB コード トレーサビリティ テーブル (Simulink Report Generator)MATLAB コードを要件にリンクするテーブルを挿入する
Simulink テスト スイート トレーサビリティ テーブル (Simulink Report Generator)Simulink テスト スイートを要件にリンクするテーブルを挿入する

要件レポートをカスタマイズする場合、次の操作を実行できます。

  • コンポーネントを追加または削除する。

  • レポート階層内でコンポーネントを上下に移動させる。

  • コンポーネントをカスタマイズし、レポート内での特定の情報の表示形式を指定する。

詳細については、Simulink Report Generator ドキュメンテーションを参照してください。

Simulink を使用した要件レポートの生成

Simulink でモデルを開いている場合、モデル エディターには要件レポートを作成するためのオプションが 2 つあります。

システム設計説明レポート.  システム設計の説明レポートには、現在の Simulink モデルが表すシステム設計が記載されます。

システム設計の説明レポートを使用して、次のことができます。

  • モデルを開かずにシステム設計を確認する。

  • 設計の概要説明と詳細説明を生成する。

  • 設計要件の準拠性の状況を評価する。

  • モデリング環境に依存しない形式でシステム設計をアーカイブする。

  • Simulink Report Generator ソフトウェアを使用してレポートのカスタマイズ バージョンを作成する。

要件情報が記載されたシステム設計の説明レポートを生成するには、次の手順に従います。

  1. レポートの作成対象となるモデルを開きます。

  2. [モデル化] タブで、[比較] 、 [システム設計の説明レポート] を選択します。

  3. [設計の記述] ダイアログ ボックスで、[要件のトレーサビリティ] を選択します。

  4. レポートで必要な他のオプションをすべて選択します。

  5. [生成] をクリックします。

    レポートの生成中は、ステータスが MATLAB コマンド ウィンドウに表示されます。

このレポート名は、モデル名、数値、ドキュメント タイプを示す拡張子 (.pdf、.html など) が順に続きます。

モデルにリンク付きの要件がある場合、レポートには要件のトレーサビリティという章が含まれます。この章の内容は次のとおりです。

  • 要件があるモデル オブジェクトの一覧と、各オブジェクトを表示するためのハイパーリンク

  • 各サブシステムのイメージ (要件があるモデル オブジェクトを強調表示)

設計要件レポート.  [アプリ] タブで、[要件マネージャー] をクリックします。[要件] タブで、[共有] 、 [モデルのトレーサビリティ レポートの生成] を選択します。このオプションは、既定の要件レポートの作成で説明するように、要件レポートを作成します。

レポートのオプションを指定するには、[共有] 、 [レポート オプション] を選択します。レポートを生成する前に、[レポート] タブで必要なオプションを設定します。これらのオプションの詳細については、要件レポートのカスタマイズを参照してください。

関連するトピック