MXAM: Frequently Asked Questions
These are some of the most frequently asked questions:
How do I start an analysis?
How do I handle the different views in the report perspective?
How do I repair guideline violations?
How do I justify guideline violations?
How do I save my report?
Why can't I see the MXAM Report Adapter in the Artifacts Wizard?
How do I select the reports that I want to compare?
Questions asked by users
You can start an analysis in the Project perspective.
A default project is already open.
Simply select the 'Analyze' link.
The report perspective has different views that interact with one another.
On the left-hand side are two navigation views. Use the Document Navigation view to see an overview and filter the reported findings by the document structure. The view on the bottom-left side shows an overview of the selected element. If you select an element in the tree, all findings for this element and all sub-elements will be displayed in the Findings view. Use the Artifact Navigation view to filter the findings by the artifact/model structure. If you select a model part, e.g. subsystem or chart, the Findings view only displays findings located in the selected model part.
The Findings view on the top-right side shows all guideline deviations found by the checks.
Select a finding to see the details below in the Finding Details view.
To make use of the automatic repair function, use the tree menu in the Document Navigation view to show repairable checks only. Right-click the check in the tree and press 'Repair'.
You can also manually repair findings in the model. Afterwards, right-click the check and press 'Rerun' to see whether the guideline violations have been solved.
You can use annotations to justify guideline violations. Select a finding and press 'Add Annotation' in the context menu. Write a comment and optionally change the result type of the finding. Save your annotations on the second page of the wizard in an annotation definition (file) next to the artifact or in a library. The annotation will be mapped for each run. The annotation details and the original result type are shown in the Finding Details view. Annotations are also included in all report export formats.
To save a report select the report and press 'Save Report' in the context menu. The report will be saved in MXMR format. This format can be used in the user interface (File > Open Report, or drag&drop an .mxmr file into the MXAM application window).
You can also export your report in HTML, PDF, or Excel format.
Please check what version of MXAM you are using, as not all versions support this feature. It is only available in the MXAM Functional Safety Solution starting with version 5.0.
The Artifacts Wizard allows you to select the base report as a tool or file artifact.
The other report will automatically be the last report in the report perspective as soon as the analysis is started.
Questions asked by quality/project managers
Firstly, we recommend that some thought is given to how the MXAM setup and all configuration files should be included in an existing toolchain environment and how these can be shared with a development team. To create a new MXAM project file, choose 'File > New... > Project > MXAM Project'. The project editor opens up in the project perspective. Use the settings page to configure guideline documents, report and annotation settings etc.
Most checks provide parameters that can be used to configure custom check behavior. In the tool menu, choose 'Settings > Check Parameters' or double click a parameter in the 'Details' view to open the `Customize Check Parameters Wizard'. Use the search and filter options to find the right parameter and select it in the table. In the Parameter Settings section, overwrite the default value for your project configuration.
There are two ways to exclude elements from the analysis:
You can use global MATLAB\ :sup:® parameters to exclude Simulink\ :sup:® libraries, block types, or mask types.
These elements are filtered during analysis and are not included in the report.
Alternatively, you can use ignore-lists to exclude elements, e.g. subsystems, block types, or mask types, for all or for specific checks.
Check findings of ignore-list elements are included in the report and marked as 'ignored'.
MXAM includes a set of guideline documents that you can find in the Guideline Documents view of the Library Browser perspective.
To create a custom document, select 'New...' in the view toolbar to create a new document, or select an existing document, press 'Save as...', and change the document according to your preferences.
A document editor opens to edit the chapter structure and add guidelines.
Questions asked by toolchain managers
Be aware of the system requirements for the operating system and respectively for MATLAB, ASCET, or Excel depending on the artifacts that are used for the analysis.
MXAM can be installed with the EXE installer in any directory. The installer can also be used to automate the installation. Upon request a zip package is available for special IDEs. For more details, click here: Installation
MXAM can be used with a node-locked, dongle, or floating network license. For a detailed description, see how to configure the license here: MES Quality Tools License Configuration
To automate an analysis, MXAM provides different batch interfaces. The headless windows interface, MATLAB API, JAVA API, or web service interface (upon request) can be used to control MXAM from another application or continuous integration server.
MXAM provides hook/callback functions that can be used to customize the startup, shutdown, or the analysis.
These hook functions are located in the doc directory of MXAM. To use a hook function, copy the function to a different directory, customize it, and make sure it is in the MATLAB path during startup or analysis.
Questions asked by check developers
To implement custom checks, please refer to the developer guide for helpful information and how to get started.