8/20/2019 Qualkitdo Rptgenext Tor
1/21
DO Qualification Kit
Simulink® Report Generator™ Tool Operational Requirements
R2015b, September 2015
8/20/2019 Qualkitdo Rptgenext Tor
2/21
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 – 2015 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 documentationas 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, thegovernment 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 f or a
list of additional trademarks. Other product or brand names may be trademarks or registered trademarks of their respectiveholders.
Patents
MathWorks products are protected by one or more U.S. patents. Please see www.mathworks.com/patents f or moreinformation.
http://www.mathworks.com/http://www.mathworks.com/http://www.mathworks.com/sales_and_serviceshttp://www.mathworks.com/sales_and_serviceshttp://www.mathworks.com/matlabcentral/http://www.mathworks.com/matlabcentral/http://www.mathworks.com/support/contact_us/http://www.mathworks.com/support/contact_us/http://www.mathworks.com/trademarkshttp://www.mathworks.com/trademarkshttp://www.mathworks.com/trademarkshttp://www.mathworks.com/patentshttp://www.mathworks.com/patentshttp://www.mathworks.com/patentshttp://www.mathworks.com/patentshttp://www.mathworks.com/trademarkshttp://www.mathworks.com/support/contact_us/http://www.mathworks.com/matlabcentral/http://www.mathworks.com/sales_and_serviceshttp://www.mathworks.com/
8/20/2019 Qualkitdo Rptgenext Tor
3/21
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)
8/20/2019 Qualkitdo Rptgenext Tor
4/21
8/20/2019 Qualkitdo Rptgenext Tor
5/21
v
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 Options ............................................................................................................... 2-2
2.1.2
Report Contents ............................................................................................................. 2-3
2.1.3
Report Format and Layout ............................................................................................. 2-5
2.1.3.1
Customized Versions of the Report .......................................................................... 2-5
2.2
System Design Description Report User Information ............................................................. 2-6
2.3
Model XML Comparison Report Operational Requirements .................................................. 2-6
2.3.1 Main Functional Capabilites .......................................................................................... 2-6
2.3.2 Tool Interfaces ............................................................................................................... 2-8 2.3.3
Report Content ............................................................................................................... 2-8
2.3.4 Abnormal Operating Modes .......................................................................................... 2-9 2.4
Model XML Comparison Report User Information ................................................................ 2-9
3 Installation ........................................................................................................................................ 3-1 4
Operational Environment ................................................................................................................. 4-1
8/20/2019 Qualkitdo Rptgenext Tor
6/21
vi
8/20/2019 Qualkitdo Rptgenext Tor
7/21
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 (referenceDO-330, Sections 10.2.4 and 10.3.2).
This document is intended for use in the DO-178C tool qualification process for verificationtools. The applicant needs to:
Review the Tool Operational Requirements for applicability in the project or programunder consideration.
Configure the Tool Operational Requirements in the project or program’s configurationmanagement system.
Complete the Tool Operational Requirements and make the document available for review.
See documentation for the following products at the MathWorks® Documentation Center,R2015 b:
DO Qualification Kit (for DO-178)
Simulink Report Generator
Simulink Verification and Validation
Simulink ®
Stateflow®
http://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.html
8/20/2019 Qualkitdo Rptgenext Tor
8/21
1-2
1.1 Simulink Report Generator Product DescriptionDesign 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 andgenerated code, requirements traceability, and testing reports. You can publish these artifacts in
an interactive web format that colleagues can use without opening the model. You can compare
Simulink models, review comparison results in an interactive XML report, and merge modeldifferences.
Simulink Report Generator produces artifacts for DO-178, ISO 26262, IEC 61508, and relatedindustry standards.
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 with XML comparison tool
8/20/2019 Qualkitdo Rptgenext Tor
9/21
2 Operational Requirements
8/20/2019 Qualkitdo Rptgenext Tor
10/21
2-2
2.1 System Design Description Report OperationalRequirementsThe 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 reportdialog 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-300 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
2.1.1 Report Options
You can specify options for layout and content using the System Design Description dialog box.
8/20/2019 Qualkitdo Rptgenext Tor
11/21
2-3
2.1.2 Report Contents
Note You can generate summary and detailed versions of the System DesignDescription. The detailed version is a superset of the summary version. The DOQualification Kit covers only the detailed version. It is assumed that you have
selected all of the options in the Include in report subpane of the System Design
Description dialog box.
The detailed version of the report includes the information that is in the summary form of thereport, 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 versionand checksum information.
SDD_mdlver
SDD_checksum
Root System The Root System section shall describe the root levelsystem:
Model
Diagram: block diagram representing the algorithms thatcompute root system outputs
Description (if available from model)
Interface
Input signals: name, data type, and other properties of
the input signalsOutput signals: name, data type, and other properties
of the output signals
Blocks
Block parameters
Block execution order (for blocks in the root systemand blocks in virtual subsystems of the root system)
SDD_blkdiag
SDD_descr
SDD_inputs
SDD_outputs
SDD_blkparas
SDD_execorder
8/20/2019 Qualkitdo Rptgenext Tor
12/21
2-4
Report Section Report Section Requirement Requirement ID
Subsystems The Subsystems section shall describe each subsystem:
Subsystem name Subsystem path
Diagram
Blocks
Block parameters
Block execution order (for atomic subsystems andreference models)
Checksum (for atomic subsystems and reference models)
SDD_name SDD_path
SDD_blkdiag
SDD_blkparas
SDD_execorder
SDD_chksum
State Charts The State Charts section shall describe state machines used
by Stateflow blocks (if available):
Chart: Diagram representing the state machine
States
Transitions
Junctions
Events
Graphical functions
Truth tables
MATLAB® functions Data: data types and other properties of state machine
data
Targets
SDD_SF_chart
SDD_SFstates
SDD_SFtrans
SDD_SFjunctions
SDD_SFevents
SDD_SFgraphfunc
SDD_SFtt
SDD_eml SDD_SFdata
SDD_SFtarget
MATLAB®
function
The MATLAB function section shall document MATLAB
code:
For MATLAB Function blocks.
From MATLAB files referenced by MATLAB Function blocks.
SDD_eml
Model Blocks The Model Blocks section shall provide information aboutreferenced models
SDD_mdlref
System DesignVariables
The System Design Variables section shall reportworkspace variables referenced by the model (variables inmodel and base workspaces, and bus, signal, and parameter
objects).
SDD_data
RequirementsTraceability
The Requirements Traceability section shall document therequirements associated with the system (if available).
SDD_reqs
Configuration Set The Configurations Set section shall r eport the model’sactive configuration set.
SDD_configset
8/20/2019 Qualkitdo Rptgenext Tor
13/21
2-5
2.1.3 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)
Subtitle
Authors
SDD_userdef_title
SDD_userdef_subtitle
SDD_userdef_authors
Report Output Options
Report Output Requirements Requirement ID
The report output file formats shall be:
Adobe Acrobat (PDF)
Web (HTML)
Microsoft Word (DOC)
Microsoft Rich Text Format (RTF)
SDD_rptformat_PDF
SDD_rptformat_HTML
SDD_rptformat_DOC
SDD_rptformat_RTF
2.1.3.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.
8/20/2019 Qualkitdo Rptgenext Tor
14/21
2-6
2.2 System Design Description Report UserInformationThe Simulink Report Generator user information for the System Design Description is in the
Simulink Report Generator System Design Description User Information.
To access the user information document, on the MATLAB® command line, type qualkitdo to open the Artifacts Explorer. The document is in Simulink Report Generator.
2.3 Model XML Comparison Report OperationalRequirementsThe 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 yourmodel 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-300 Section 6.2.1.aa).
2.3.1 Main Functional Capabilites
The Simulink Report Generator compares Simulink models and generates comparions 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
compare two Simulink models and generate a Model XMLComparison report in HTML format.
SDD_comp_gen
Simulink Report Generator shall detect and report the
differences of model configuration parameters.SDD_comp_cfg
Simulink Report Generator shall detect and report thedifferences in the model blocks and block properties.
Note: Requirement only applies to blocks in the Simulinklibrary.
SDD_comp_blc
8/20/2019 Qualkitdo Rptgenext Tor
15/21
2-7
Requirements Requirement ID
Simulink Report Generator shall detect and report the
differences in the model Stateflow charts and chart properties.SDD_comp_sfc
Simulink Report Generator shall detect and report thedifferences in the model signal lines and signal line propertis.
SDD_comp_ln
Simulink Report Generator shall detect and report thedifferences in the model workspace.
SDD_comp_wsp
Note: Simulink Report Generator does not support detection of the differences in the model testharness.
8/20/2019 Qualkitdo Rptgenext Tor
16/21
2-8
2.3.2 Tool Interfaces
Simulink Report Generator provides interfaces for selecting models to compare and saving
generated reports.
Requirements Requirement ID
Simulink Report Generator shall operate on model files stored
in SLX format for the current relase, and for any previousreleases supported by the current release of Simulink.
SDD_if_slx
Simulink Report Generator shall operate on model files stored
in MDL format for the current relase, and for any previousreleases supported by the current release of Simulink.
SDD_if_mdl
Simulink Report Generator shall operate on model files stored
in different supported formats.
SDD_if_mxd
2.3.3 Report Content
Simulink Report Generator compares the models and generates a Model XML Comparisonreport in HTML format.
Requirements Requirement ID
The Model XML Comparison report shall include:- Header- Comparison results
SDD_rep_gen
The header of the comparison report shall include:
- Title of the report- Author of the report- Date and time stamp of report generation- Attributes of the compared files:
o File nameo File patho Date of last modificationo MD5 checksumo Model version
o Version of Simulink used for model saveo Model description (if provided)
- Operational environment, including target platformand versions of MATLAB, Simulink and ReportGenerator
SDD_rep_hdr
8/20/2019 Qualkitdo Rptgenext Tor
17/21
2-9
Requirements Requirement ID
The subsections with comparison results shall contain a list of
applied filters and a list of differences, which includes for
each differing item:
- Path in the model hierarchy- Value of the differing item
SDD_rep_res
2.3.4 Abnormal Operating ModesSimulink Report Generator detects the abnormal operating modes and generates correspondingerror messages.
Requirements Requirement ID
If the input model files cannot be compared due to invalidinput files, Simulink Report Generator shall generate an error
message.
SDD_abn_inp
2.4 Model XML Comparison Report User InformationThe Simulink Report Generator user information for the Model XML Comparison report is inthe Simulink Report Generator Model XML File Comparison User Information .
To access the user information document, on the MATLAB® command line, type qualkitdo
to open the Artifacts Explorer. The document is in Simulink Report Generator.
8/20/2019 Qualkitdo Rptgenext Tor
18/21
2-10
8/20/2019 Qualkitdo Rptgenext Tor
19/21
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,R2015 b:
Installation
http://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.htmlhttp://www.mathworks.com/help/releases/R2015b/index.html
8/20/2019 Qualkitdo Rptgenext Tor
20/21
3-2
8/20/2019 Qualkitdo Rptgenext Tor
21/21
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
MATLAB® Software
Simulink ® Software
MATLAB® Report Generator™ Software
1 Linux® is a registered trademark of Linus Torvalds.