Learn more about Simulink Verification and Validation

Creating a Requirements Report

On this page…
Creating the Default Requirements Report Customizing a Requirements Report

Creating the Default Requirements Report

After you add requirements to a model, you can generate a report on all the requirements associated with the model and its blocks.

To generate a requirements report for the sf_car_linking model that you saved in Linking a Signal Builder Block to a Requirement:

1. Open the sf_car_linking model.

2. Select Tools > Requirements > Generate Report.

   The RMI searches through all the blocks and subsystems in the model for associated requirements. It generates and displays a complete report in HTML format with the default name requirements.html .

Table of Contents / List of Tables

The beginning of the report includes:

• A Table of Contents that lists the major sections of the report. There is one System section for the top-level model and one System section for each subsystem or referenced model. The final section lists the systems and subsystems that do not have any requirements.

• A List of Tables in the report, numbered by section.

Model Information

The Model Information contains version information about the model for which you created the report.

Documents Information

The Documents Information section lists all the requirements documents to which objects in the model link to.

System

The first System section lists information about the top-level model, sf_car_linking. It also lists information about its child objects that have requirements—the shift_logic chart and the Passing Maneuver signal group. The subsystems in sf_car_linking that have requirements—Engine and transmission—each have their own System section.

The first System section also lists objects in the top-level model that do not have requirements.

Systems and subsystems with no requirements

The Systems and subsystems with no requirements section lists objects in the model that do not have requirements links. However, it does not list child objects that have requirements links. In this example, that list includes the top-level model (sf_car_linking), which does not have links to requirements.

Back to Top

Customizing a Requirements Report

RMI uses the Simulink^® Report Generator™ software to generate the requirements report. You can customize the report using the RMI, or you can use the Simulink Report Generator software for advanced customization.

Customizing the Report Using the RMI

To customize the requirements report in the Model Editor:

1. Select Tools > Requirements > Settings.

   The Requirements Settings dialog box opens.

2. Click the Report tab.

   

   The options that you select in the Requirements Settings dialog box determine the contents of the report.

   Requirements Settings Report Option	Description
   Highlight the model before generating report	Highlights the Simulink objects with requirements in the Model Editor before creating the report and then highlights them in the report.
   Report objects with no links to requirements	Lists Simulink objects that have no requirements.
   Use document index in requirements tables where possible	Uses a document ID, if available, instead of a path name in the requirements table.

3. Select the options that you want and click Close.

Run the report to generate the requirements report for your model.

Customizing the Report Using the Simulink Report Generator Software

If you have a license for the Simulink Report Generator software, you can further modify the default requirements report.

To customize the requirements report, first start the Simulink Report Generator software. At the MATLAB command prompt, enter the following command:

setedit requirements

The Report Explorer dialog box opens the requirements report template that the RMI uses when generating a requirements report. The report template contains Simulink Report Generator components that define the structure of the requirements report.

If you click a component in the middle pane, the options you can specify for that component appear in the right-hand pane. For detailed information about using a particular component to customize your report, at the bottom of the right-hand pane, click Help.

In addition to the standard report components, Simulink Report Generator provides RMI-specific components. These components insert information about Simulink objects whether or not they have associated requirements:

• Missing Requirements Block Loop — Applies all child components to blocks that have no requirements

• Missing Requirements System Loop — Applies all child components to systems that have no requirements

• Requirements Block Loop — Applies all child components to blocks that have requirements

• Requirements Documents Table — Inserts a table that lists requirements documents

• Requirements Signal Loop — Applies all child components to signal groups with requirements

• Requirements Summary Table — Inserts a property table listing blocks that have requirements and requirements details

• Requirements System Loop — Applies all child components to systems with requirements

• Requirements Table — Inserts a table that lists system and subsystem requirements

There are several ways you can customize the requirements report:

• Add or delete components.

• Move components up or down in the report hierarchy.

• Customize components to specify how the report presents certain information.

For more information about customizing reports, see Simulink Report Generator User's Guide.

Back to Top

Creating Requirements in Linked Libraries

Navigating from Requirements Documents to Simulink Objects

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS