Generate System Architecture Reports
You can use System Composer™ and Simulink® Report Generator™ to design and generate reports containing architectural design information and artifacts. You can interactively and programmatically customize system architecture reports to best suit the formatting and content requirements from your stakeholders.
Export architectural design data captured from your System Composer architecture models using custom reports with report generation classes to PDF, DOCX, and HTML file formats. Use report components including finders, results, and reporters to dynamically generate report contents. A Simulink Report Generator license is required to generate reports.
For more information on generating reports for Simulink models, see Create Simulink Report Generator Reports (Simulink Report Generator).
Report Generation Workflow for Architecture Models
Use the System Architecture Report tool and Report API classes to find architecture elements and report on the design. You can use report properties to filter and format the results.
Report Structure
A report is a container object of type slreportgen.report.Report (Simulink Report Generator) that holds the report. You can add various
document elements to a report such as a title page, table of contents, chapters, and
sections. For more information on these capabilities, see Title Pages, Tables of Contents, Lists of Figures, Tables, and Captions (MATLAB Report Generator).
For example, this table of contents page is from a generated report.
In addition to document elements and structure, your report contains content related to your architecture model. To generate specific content, you can add report components to create a report generator that finds and reports on System Composer architecture model elements.
Report Components for Architecture Models
Components determine the behavior and content of your report. Using the system architecture report integrated with System Composer, you can generate reports containing design information on these architectural elements:
Allocation sets and lists
Components
Connectors
Dictionaries
Functions
Interfaces
Profiles
Requirement sets and link sets
Sequence diagrams
Stereotypes
Views
In general, each report component has a finder class, a result class, and a reporter class. For more information, see Using System Composer Report Generation API.
Using the System Architecture Report
Using the System Architecture Report tool, you can:
Browse and select architecture models from which to generate consolidated reports that include multiple architecture models.
Create and manage custom report templates.
Define report contents by selecting which sections to include in your report and customizing section descriptions and which architectural element properties to include.
Export architectural data by saving reports in PDF, DOCX, and HTML formats.
Using System Composer Report Generation API
The System Composer report generation API, stored in the
systemcomposer.rptgen namespace, comprises objects that find and
format architecture model data. You can use these objects with MATLAB® Report API and DOM API objects to create MATLAB programs that generate reports on System Composer architecture models.
You can use the Simulink report constructor, slreportgen.report.Report (Simulink Report Generator), to create a report object to hold the contents
of the report.
You can use report component finders, results, and reporters to add content specific to each architecture model to your report.
Finders – Find specific elements, such as components or stereotypes, in a given architecture model.
Results – Contain an array corresponding to the results of the finder object. Each result object returned by a finder has an associated reporter object.
Reporters – Hold the content and formats the content. You add reporter objects to your report.
Each Report API page has detailed examples of using the provided finder, result, and reporter classes.
For more information, see Generate System Architecture Reports with System Composer Report API and Generate System Architecture Reports with System Composer Report API for Software Architectures.
See Also
Tools
Classes
systemcomposer.rptgen.report.AllocationList|systemcomposer.rptgen.report.AllocationSet|systemcomposer.rptgen.report.Component|systemcomposer.rptgen.report.Connector|systemcomposer.rptgen.report.DependencyGraph|systemcomposer.rptgen.report.Function|systemcomposer.rptgen.report.Interface|systemcomposer.rptgen.report.Profile|systemcomposer.rptgen.report.RequirementLink|systemcomposer.rptgen.report.RequirementSet|systemcomposer.rptgen.report.SequenceDiagram|systemcomposer.rptgen.report.Stereotype|systemcomposer.rptgen.report.View
Topics
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: United States.
You can also select a web site from the following list
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)