DO Qualification Kit

Simulink® Report Generator™

Tool Operational Requirements

R2017a

December 5, 2016 qualkitdo_rptgenext_tor

How to Contact MathWorks
Latest news: www.mathworks.com
Sales and services: www.mathworks.com/sales_and_services
User community: www.mathworks.com/matlabcentral
Technical support: www.mathworks.com/support/contact_us
Phone: 508-647-7000

The MathWorks, Inc.

3 Apple Hill Drive
Natick, MA 01760-2098
DO Qualification Kit: Simulink® Report Generator™ Tool Operational Requirements
© COPYRIGHT 2010–2017 by The MathWorks, Inc.
The software described in this document is furnished under a license agreement. The software may be used or copied only under
the terms of the license agreement. No part of this manual may be photocopied or reproduced in any form without prior written
consent from The MathWorks, Inc.
FEDERAL ACQUISITION: This provision applies to all acquisitions of the Program and Documentation by, for, or through the
federal government of the United States. By accepting delivery of the Program or Documentation, the government hereby agrees
that this software or documentation qualifies as commercial computer software or commercial computer software documentation
as such terms are used or defined in FAR 12.212, DFARS Part 227.72, and DFARS 252.227-7014. Accordingly, the terms and
conditions of this Agreement and only those rights specified in this Agreement, shall pertain to and govern the use, modification,
reproduction, release, performance, display, and disclosure of the Program and Documentation by the federal government (or
other entity acquiring for or through the federal government) and shall supersede any conflicting contractual terms or conditions.
If this License fails to meet the government’s needs or is inconsistent in any respect with federal procurement law, the
government agrees to return the Program and Documentation, unused, to The MathWorks, Inc.
Trademarks
MATLAB and Simulink are registered trademarks of The MathWorks, Inc. See www.mathworks.com/trademarks for a
list of additional trademarks. Other product or brand names may be trademarks or registered trademarks of their respective
holders.
Patents
MathWorks products are protected by one or more U.S. patents. Please see www.mathworks.com/patents for more
information.

December 5, 2016 qualkitdo_rptgenext_tor

Revision History
September 2010 New for Version 1.3 (Applies to Release 2010b)
April 2011 Revised for Version 1.4 (Applies to Release 2011a)
September 2011 Revised for Version 1.5 (Applies to Release 2011b)
March 2012 Revised for Version 1.6 (Applies to Release 2012a)
September 2012 Revised for Version 2.0 (Applies to Release 2012b)
March 2013 Revised for Version 2.1 (Applies to Release 2013a)
September 2013 Revised for Version 2.2 (Applies to Release 2013b)
March 2014 Revised for Version 2.3 (Applies to Release 2014a)
October 2014 Revised for Version 2.4 (Applies to Release 2014b)
March 2015 Revised for Version 2.5 (Applies to Release 2015a)
September 2015 Revised for DO Qualification Kit Version 3.0 (Applies to Release 2015b)
March 2016 Revised for DO Qualification Kit Version 3.1 (Applies to Release 2016a)
September 2016 Revised for DO Qualification Kit Version 3.2 (Applies to Release 2016b)
March 2017 Revised for DO Qualification Kit Version 3.3 (Applies to Release 2017a)

December 5, 2016 qualkitdo_rptgenext_tor

December 5, 2016 qualkitdo_rptgenext_tor
Contents
1 Introduction.......................................................................................................................................1-1
1.1 Simulink Report Generator Product Description.....................................................................1-2
2 Operational Requirements.................................................................................................................2-1
2.1 System Design Description Report Operational Requirements...............................................2-2
2.1.1 Report Contents..............................................................................................................2-3
2.1.2 Report Format and Layout..............................................................................................2-5
2.1.2.1 Customized Versions of the Report...........................................................................2-5
2.1.3 Tool Interfaces and Abnormal Operating Modes...........................................................2-5
2.2 Model XML Comparison Report Operational Requirements..................................................2-6
2.2.1 Main Functional Capabilities..........................................................................................2-6
2.2.2 Report Content................................................................................................................2-7
2.2.3 Tool Interfaces and Abnormal Operating Modes...........................................................2-7
2.3 Simulink Report Generator User Information..........................................................................2-8
3 Installation.........................................................................................................................................3-1
4 Operational Environment..................................................................................................................4-1

December 5, 2016 qualkitdo_rptgenext_tor v

December 5, 2016 qualkitdo_rptgenext_tor vi
1 Introduction

This document comprises the Tool Operational Requirements (reference DO-330 Section
10.3.1) for the following capabilities of the Simulink® Report Generator™ verification product:

 System Design Description (SDD) report

 Model XML Comparison report

The document identifies:

 Features of the Simulink Report Generator product.

 The environment in which the Simulink Report Generator product is installed (reference
DO-330, Sections 10.2.4 and 10.3.2).

This document is intended for use in the DO-178C tool qualification process for verification
tools.

See documentation for the following products at the MathWorks® Documentation Center,
R2017a:

 DO Qualification Kit (for DO-178)

 Simulink Report Generator
 Simulink Verification and Validation
 Simulink®
 Stateflow®
1.1 Simulink Report Generator Product Description
Design and generate reports from models and simulations
Simulink® Report Generator™ lets you design and generate richly formatted Microsoft® Word,
HTML, and PDF reports from Simulink models and simulations. The report generator lets you
automatically create artifacts for Model-Based Design, such as system design descriptions and
generated code, requirements traceability, and testing reports. You can publish these artifacts in
an interactive web format that colleagues can use without opening the model. It can produce
artifacts for DO-178, ISO 26262, IEC 61508, and related industry standards. An interactive
rendition of your model can be generated for viewing in a web browser.

Using the Simulink Report Generator you can compare models, review comparison results in an
interactive XML report, merge model differences, and create difference reports.

Key Features

 Automatic capture of simulation results and model specifications

 Report formatting based on Word and HTML report templates
 Interactive reports for viewing models, generated code, and analysis results in web
browsers
 Report designer for creating custom Word, HTML, PDF, RTF, and XML reports
 Artifacts for DO-178, IEC 61508, and ISO 26262, including system design, model and
code verification, and requirements documentation
 API for forms-based Word and HTML report generation
 Model differencing and merging (two-way and three-way) with XML comparison tool

Note Not all tool features are covered by the DO Qualification Kit. For the list of qualified
tool features, see Chapter 2, “Operational Requirements”.
2 Operational Requirements
2.1 System Design Description Report Operational
Requirements
The Simulink Report Generator product includes the capability to generate a System Design
Description (SDD) report for your Simulink model. The report provides detailed information
about the system design represented by a model. You can customize the report using the report
dialog box. The user is responsible for ensuring that the tool features they rely on to eliminate,
reduce or automate the process are sufficiently covered by Tool Operational Requirements
(reference DO-330 Section 6.2.1.aa).

You can access the System Design Description report from the Simulink Model Editor.

You can use the System Design Description to:

 Review a system design without having the model open

 Generate summary and detailed descriptions of the design
 Assess compliance with higher-level requirements
 Archive the system design in a format independent of the modeling environment
 Build a customized version of the report, using the Report Explorer

December 5, 2016 qualkitdo_rptgenext_tor 2

2.1.1 Report Contents
Note You can generate summary and detailed versions of the System Design Description.
The detailed version is a superset of the summary version. The DO Qualification Kit covers only
the detailed version. It is assumed that you have selected all of the options in the Include in
report sub pane of the System Design Description dialog box.

The detailed version of the report includes the information that is in the summary form of the
report, as well as more information about the system components. Also, atomic subsystem
information is more detailed than virtual subsystem information.
Report Content Requirements
Report Section Report Section Requirement Requirement ID
Report Overview The Report Overview section shall contain model version  SDD_mdlver
and checksum information.  SDD_checksum
Root System The Root System section shall describe the root level
system:
 Model
 Diagram: block diagram representing the algorithms that  SDD_blkdiag
compute root system outputs
 Description (if available from model)  SDD_descr
 Interface
 Input signals: name, data type, and other properties of  SDD_inputs
the input signals
 Output signals: name, data type, and other properties  SDD_outputs
of the output signals
 Blocks
 Block parameters  SDD_blkparas
 Block execution order (for blocks in the root system
and blocks in virtual subsystems of the root system)  SDD_execorder
Subsystems The Subsystems section shall describe each subsystem:
 Subsystem name  SDD_name
 Subsystem path  SDD_path
 Diagram  SDD_blkdiag
 Blocks
 Block parameters  SDD_blkparas
 Block execution order (for atomic subsystems and  SDD_execorder
reference models)
 Checksum (for atomic subsystems and reference models)  SDD_chksum

December 5, 2016 qualkitdo_rptgenext_tor 3

 Report Section Report Section Requirement Requirement ID
State Charts The State Charts section shall describe state machines used
by Stateflow blocks (if available):
 Chart: Diagram representing the state machine  SDD_SF_chart
 States  SDD_SFstates
 Transitions  SDD_SFtrans
 Junctions  SDD_SFjunctions
 Events  SDD_SFevents
 Graphical functions  SDD_SFgraphfunc
 Truth tables  SDD_SFtt
 MATLAB® functions  SDD_eml
 Data: data types and other properties of state machine  SDD_SFdata
data
MATLAB® The MATLAB function section shall document MATLAB  SDD_eml
function code:
 For MATLAB Function blocks.
 From MATLAB files referenced by MATLAB Function
blocks.
Model Blocks The Model Blocks section shall provide information about  SDD_mdlref
referenced models
System Design The System Design Variables section shall report  SDD_data
Variables workspace variables referenced by the model (variables in
model and base workspaces, and bus, signal, and parameter
objects).
Requirements The Requirements Traceability section shall document the  SDD_reqs
Traceability requirements associated with the system (if available).
Configuration Set The Configurations Set section shall report the model’s  SDD_configset
active configuration set.

December 5, 2016 qualkitdo_rptgenext_tor 4

2.1.2 Report Format and Layout
You can specify the contents of the title page as well as different report formats using the
System Design Description dialog box.

Title Page Options

Title Page Requirement Requirement ID
The title page shall contain:
 Title (default: model name)  SDD_userdef_title
 Subtitle  SDD_userdef_subtitle
 Authors  SDD_userdef_authors

Report Output Options

Report Output Requirements Requirement ID
The report output file formats shall be:
 Adobe Acrobat (PDF)  SDD_rptformat_PDF
 Web (HTML)  SDD_rptformat_HTML
 Microsoft Word (DOC)  SDD_rptformat_DOC
 Microsoft Rich Text Format (RTF)  SDD_rptformat_RTF

2.1.2.1 Customized Versions of the Report

Simulink Report Generator allows you to generate custom System Design Description reports by
using the Report Explorer to customize the System Design Description template. The DO
Qualification Kit covers only the default version of the System Design Description report.

2.1.3 Tool Interfaces and Abnormal Operating Modes

Requirements Requirement ID
Simulink Report Generator shall operate on model files stored
in SLX format for the current release. SDD_if_slx
If SDD report cannot be generated due to invalid input files,
Simulink Report Generator shall generate an error message. SDD_abn_inp

December 5, 2016 qualkitdo_rptgenext_tor 5

2.2 Model XML Comparison Report Operational
Requirements
The Simulink Report Generator product includes the capability to generate a Model XML
Comparison report for your Simulink model. You can use the report to review changes to your
model throughout the workflow for Model-Based Design (MBD). The user is responsible for
ensuring that the tool features they rely on to eliminate, reduce or automate the process are
sufficiently covered by Tool Operational Requirements (reference DO-330 Section 6.2.1.aa).

2.2.1 Main Functional Capabilities

The Simulink Report Generator compares Simulink models and generates comparison reports.
The comparison reports can be used to review changes in the Model-Based Design workflow.

Requirements Requirement ID
Simulink Report Generator shall provide the capability to XML_comp_gen
compare two Simulink models and generate a Model XML
Comparison report in HTML format.

Simulink Report Generator shall detect and report the XML_comp_cfg

differences of model configuration parameters.

Simulink Report Generator shall detect and report the XML_comp_blc

differences in the model blocks and block properties.

Note: Requirement only applies to blocks in the Simulink

library.
Simulink Report Generator shall detect and report the XML_comp_sfc
differences in the model Stateflow charts and chart properties.

Simulink Report Generator shall detect and report the XML_comp_ln

differences in the model signal lines and signal line
properties.

Simulink Report Generator shall detect and report the XML_comp_wsp

differences in the model workspace.

December 5, 2016 qualkitdo_rptgenext_tor 6

2.2.2 Report Content
Simulink Report Generator compares the models and generates a Model XML Comparison
report in HTML format.

Requirements Requirement ID
The Model XML Comparison report shall include:
- Header XML_rep_gen
- Comparison results

The header of the comparison report shall include:

XML_rep_hdr
- Title of the report
- Author of the report
- Date and time stamp of report generation
- Attributes of the compared files:
o File name
o File path
o Date of last modification
o MD5 checksum
o Model version
o Version of Simulink used for model save
o Model description (if provided)
- Operational environment, including target platform
and versions of MATLAB, Simulink and Report
Generator

The subsections with comparison results shall contain a list of

applied filters and a list of differences, which includes for XML_rep_res
each differing item:
- Path in the model hierarchy
- Value of the differing item

2.2.3 Tool Interfaces and Abnormal Operating Modes

Requirements Requirement ID
Simulink Report Generator XML comparison shall operate on
model files stored in SLX format for the current release. XML_if_slx

December 5, 2016 qualkitdo_rptgenext_tor 7

 Requirements Requirement ID
If the input model files cannot be compared due to invalid
input files, Simulink Report Generator shall generate an error XML_abn_inp
message.

2.3 Simulink Report Generator User Information

The Simulink Report Generator User’s Guide includes user information for the following:

 System Design Description

 Model XML Comparison report

To access the documents, on the MATLAB® command line, type qualkitdo to open the
Artifacts Explorer. The documents are in Simulink Report Generator.

December 5, 2016 qualkitdo_rptgenext_tor 8

3 Installation

To use the Simulink® Report Generator™ product, install the following MathWorks® products:

 MATLAB®
 Simulink®
 MATLAB® Report Generator™
 Simulink Report Generator

Instructions for installing the products are available at the MathWorks Documentation Center,
R2017a > Installation.
4 Operational Environment

The DO Qualification Kit product supports the following operating environments for the
Simulink® Report Generator™ product:

 Personal computer
 One of the following operating systems:
- Microsoft® Windows®
- Linux®1
- Mac OS X
 MATLAB® Software
 Simulink® Software
 MATLAB® Report Generator™ Software

Linux® is a registered trademark of Linus Torvalds.