Main Content

Generate Model Advisor Reports

By default, when the Model Advisor runs checks, it generates an HTML report of check results in the slprj/modeladvisor/model_name folder. On Windows® platforms, you can generate Model Advisor reports in HTML, Adobe® PDF, and Microsoft® Word .docx formats.

The beginning of the Model Advisor reports contain the:

  • Model name

  • Simulink® version

  • System

  • Treat as Referenced Model

  • Model version

  • Current run

Generate Results Report When Executing Model Advisor Checks

Use these steps to generate a Model Advisor report when executing the checks. This report is in HTML format.

  1. In the left pane of the Model Advisor, select the checks you want to run.

  2. Click on the folder that contains the checks and, in the right pane of the Model Advisor, select Show report after run.

  3. Click Run Selected Checks. When complete, the Model Advisor automatically opens an HTML version of the report.

  4. To save, right-click on the report and select Save As

Generate Results Report After Executing Model Advisor Checks

To generate a Model Advisor report in Adobe PDF or Microsoft Word:

  1. In the left pane of the Model Advisor, select the checks you want to run. Click on the folder that contains the checks and, in the right pane of the Model Advisor, select Run Selected Checks.

  2. When complete, reselect the folder and click Generate Report in the right pane of the Model Advisor.

  3. In the Generate Model Advisor Report dialog box:

    • Enter the path to the folder where you want to generate the report.

    • Provide a file name.

    • Use File format to select HTML, PDF, or Word.

  4. Click OK. The Model Advisor generates the report and saves it to the designated location. If you selected View report after generation, the report opens automatically.

Modify Template for Model Advisor Check Results Report

If you have a MATLAB® Report Generator™ license, you can modify the default template that the Model Advisor uses to generate the report in PDF or Microsoft Word.

The default template contains fields that the Model Advisor uses to populate the generated report with information about the analysis. If you want your Model Advisor report to contain the analysis information, do not delete the fields. When the Model Advisor generate the report, analysis information overrides the text that you enter in the template field.

Template FieldIn generated report, displays
ModelNameModel name
SimulinkVersionSimulink version
SystemNameSystem name
TreatAsMdlRefWhether or not model is treated as a referenced model
ModelVersionModel version
CurrentRunModel Advisor analysis time stamp
PassCountNumber of checks that pass
FailCountNumber of checks that fail
WarningCountNumber of checks that cause a warning
NrunCountNumber of checks that did not run
TotalCountTotal number of checks
CheckResultsResults for each check

This example shows how to add a header to a PDF version of a Model Advisor report.

  1. Using Microsoft Word, open the default template matlabroot/toolbox/simulink/simulink/modeladvisor/resources/templates/default.dotx.

  2. Rename and save the template default.dotx to a writable location. For example, save template default.dotx to C:/work/ma_format/mytemplate.dotx.

  3. In the template C:/work/ma_format/mytemplate.dotx file, add a header. For example, in the template header, add the text My Custom Header. Save the template as a Microsoft Word .dotx file.

  4. In the Model Advisor window Report pane, click Generate Report.

  5. In the Generate Model Advisor Report dialog box:

    • Enter the path to the folder where you want to generate the report and provide a file name.

    • Set File format to PDF.

    • Select View report after generation.

    • Set Report template to C:\work\ma_format\mytemplate.dotx.

  6. Click OK. The Model Advisor generates the report in PDF format with the custom header.

See Also

|

Related Topics