KONTAKTIEREN SIE UNS!
+49 (0) 30 20916463 14



SYSTEM REQUIREMENTS

The following system requirements must be in place to use MXAM:

  • Windows XP (32-bit version)
  • Windows Vista, Windows 7, Windows 8, Windows 10 (32-bit and 64-bit versions)
  • Web service Port 10117 (default) must be accessible and can be changed in the tool preferences.
  • System requirements when using MXAM with MATLAB®/Simulink®/Stateflow®, and TargetLink®:
    • MATLAB® version see table below
    • TargetLink® (base suite) version see table below
    • Port 5564 (default) must be accessible
  • System requirements when using MXAM with ASCET: ASCET 6.1 to 6.2.1
  • System requirements when using MXAM with EXCEL: Excel 2003 and higher

INSTALLATION

Manual installation

  • Installer: Install MXAM by executing the setup file (.exe) and follow the setup instructions.
    • The startup of the installation process might take a while depending on the security settings of the client machine.
    • Installation to a write-protected directory: Right click the setup file and execute as administrator.

Automatic headless installation

  • Run the MXAM installation once on a machine and save your automatic installation data in the Finish Panel to auto-install.xml.
    With this data, you will be able to run the same installation on another similar machine.
  • Configure the auto-install.xml
  • Run the automatic installation: >>[installer-name].exe [ABSOLUTE-PATH/auto-install.xml]

LICENSE CONFIGURATION

Node-locked license.

  • To activate MXAM, save the license file to the 'license' subfolder of the MXAM installation directory.

Dongle license

  • To activate MXAM, save the license file to the 'license' subfolder of the MXAM installation directory.

...

QUICK START

Starting MXAM

  • For MATLAB platform: Open MATLAB, navigate to the MXAM installation directory and execute >>mxam
  • For other platforms: Start MXAM using the program shortcut or go to the MXAM installation directory and execute mxam.exe

Starting an analysis

For MATLAB platform:

  • Open a model in MATLAB
  • Press "Analyze" in MXAM
  • Select the model in the artifact dialog
  • Press "Finish"

For ASCET:

  • Press "Analyze" in MXAM
  • Press 'Open ASCET' in the artifact dialog if it is not open yet
  • Press 'Refresh' to fetch models from the database
  • Press "Finish"

For Others:

  • In the Project perspective press 'Add...' in the Artifact Section to add an artifact
  • Select the artifact and press "Finish"
  • Press "Analyze"

Guidelines

  • Go to the 'Project Guidelines' perspective to see which guidelines are checked during the analysis.
  • To see the pool of all available guidelines go to the 'Library Browser' perspective and select the 'Guidelines' view.

Help

  • Help and Release Notes are available after starting MXAM in the menu under Help > Help Contents.
  • To get startet you can learn from our tutorials under Help > Tutorials

Support

If you have any questions or suggestions which can help us to improve the MES Model Examiner® DRIVE please do not hesitate to contact us:

KONTAKTIEREN SIE UNS!
+49 (0) 30 20916463 22
mxam@model-engineers.com


DEVELOPER-, EDITOR- & USER GUIDE



MXAM Help

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

RELEASE NOTES

V4.4.0 04-10-2017

Tool Framework

Model referencing support

  • Set the global parameter 'ResolveModelReferences' in the project settings to 'true' to prepare the MXAM project for model referencing.
  • Use the tool artifact tab to analyze the model with its references or only one referenced child model.
  • Use the context menu in the artifact navigation to jump to the referenced models and back to the location where they are referenced within the report perspective.
  • For more help, see MXAM DRIVE User Guide > Use Case Scenarios > Run a Guideline Compliance Analysis > Running an analysis using the UI.

Distribution of guideline violations of artifacts

  • The overview view in the report perspective offers a summary of the overall aggregated result for each artifact.
  • Get an overview of each artifact's guideline compliance.
  • For more help, see MXAM DRIVE User Guide > User Interface > Perspectives > Report Perspective.

Configure check parameters while working with the MXAM Main Window (#4404)

  • Use the 'Customize Check Parameters Dialog' simultaneously to using the MXAM Main Window. This enhances the workflow of configuring check parameters while inspecting the current report or referring to documentation.
  • For more help, see MXAM DRIVE User Guide > User Interface > Wizards > Customize Check Parameters Wizard

UI support for cleanup of unmapped annotations (#4809)

  • Use the new context menu on the unmapped category in the annotations view to remove all unmapped annotations.
  • Remove only annotations created with the report's project via the option 'Delete Unmapped Annotations for Selected Report's Project'.
  • For more help, see MXAM DRIVE User Guide > User Interface > Perspectives > Report Perspective > Annotations.

ASCET Adapter

  • Use ASCET Formula objects as referenced objects of ASCET findings in the ASCET check implementation.
  • Mark an arbitrary location in the ASCET result image to highlight, for instance, signal crossings. (#4933)

Improvements

  • Memory usage during report generation has been improved to allow a higher number of reports to be generated in one batch execution. (#4901)
  • Improvement of matching algorithm for annotations.
  • Create an ignore list in the "File -> New ..." Wizard. After a new MXAM ignore list file has been created, the Windows text editor will subsequently open the file. Thus, the user can directly modify the new file. (#4946)
  • Use the quick run on checks in the library browser to speed up your testing process while implementing checks.

Bug fixes

  • Export of ASCET result images with previous ASCET versions fixed. (#4905)
  • Fixed a bug in the transformation logic when transforming the model to a lower version. (#4994)
  • Fixed rare error that did not allow report files to be written to disk. (#4780)
  • Fixed base ASCET check implementation for projects with modules to omit 'inapplicable' results on project artifacts that have modules. (#4941)
  • Fixed a bug where the structure of a Simulink model was not identified correctly. (#5005)

Guidelines, Checks, and Documents

Support of MATLAB 2017a

  • The diagnostic option 'Mux blocks used to create Bus signal' is always set to error, thus this will be ignored in the check execution. Limitation: InBusElements and OutBusElements used in the model are not supported by MXAM.

Review support for MATLAB Functions in Simulink and Stateflow

The generic review checks mes_sl_generic_001 and mes_sf_generic_001 support MATLAB Functions and are referenced in the following guidelines:

  • na_0016
  • na_0017
  • na_0019
  • na_0021
  • na_0022
  • na_0025
  • na_0034.

New Check

  • mes_cgtl_4301: Avoidance of TargetLink Specifications for Stateflow Input Variables (referenced in Guideline TL_RULE_STATEFLOW_EXPLICIT_INPUT_SPEC, document dSpace Modeling Guidelines 4.0.3)

Changes

  • mcheck_mes_slsf_9003: Issues a warning if a chart property is not available in the currently used MATLAB Version. (#4841)
  • mcheck_mes_slsf_9100: Define a free fragment for the naming convention pattern. See \libraries\checks\MATLAB_MES\mcheck_mes_slsf_9100\v01\NamingConventions_Example.xlsm for documentation. (#4224)
  • mcheck_misra_slsf_005_a: The check takes into account the libraries defined in the global parameter 'Global.Ignored Libraries', i.e. blocks linked to a globally ignored library will be ignored now. (#4887)
  • mes_mes_slsf_9001: The check has a new parameter 'MES.mes_slsf_9001.b_minDiagnosticsError'. If the parameter is set to true, the check does not report a failed finding for parameters with a more strict warning/error level than the desired value. (#4882)

Bug fixes

  • mcheck_misra_slsf_008_b, mcheck_misra_slsf_016_d, mcheck_ds_0100: An incorrect handling of Vector Concatenation blocks caused the abortion of the checks. This has been fixed. (#4911)
  • The analysis of labels containing the '<>' operator did not work properly. The operator is now handled correctly in Stateflow checks. (#4900)
  • mcheck_na_0008: The check reported a failed result for 'Compare To Constant' blocks, as these where treated as subsystems (blocktype subsystem). 'Compare To Constant' blocks are handled correctly now. (#4867)
  • mcheck_mes_slstl_002_b: Due to an incorrect handling of an index, the control input of Switch blocks has been analyzed instead of the data inport. This resulted in a failed finding in some specific cases which has been fixed. (#4896)
  • mcheck_db_0110, mcheck_misra_slsf_006_a: These checks reported a failed for the 'parameter data type' of Gain blocks and for the 'accumulator data type' of Sum blocks if 'fixdt()'' was selected. This has been fixed. (#4973)
  • mcheck_mes_tl_001: An aborted result occurred because the check did not handle vector valued DD variables properly. This has been fixed. (#4981)
  • mcheck_misra_slsf_013_b: The check was aborted if the number of elements in a Demux block was defined by a base workspace variable. The check is now able to evaluate the base workspace variable correctly. (#5015)

FAQ

These are some of the most frequently asked questions:

Questions asked by users

How can I start an analysis?

You can start an analysis in the Project perspective. A default project is already open. Just press the 'Analyze' link.

How can I handle the different views in the report perspective?

The report perspective has different views that interact with each other. 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.

How can I repair guideline violations?

To make use of the automatic repair function, use the tree menu in the Document Navigation view to show repairable checks only. Right-click on 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.

How can I justify guideline violations?

To justify guideline violations you can use annotations. 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.

How can I save my report?

To save a report select the report in the Navigation view and press 'Save Report' in the context menu. The report will be saved in MXMR format. This format can be used to re-open the report in the user interface (File > Open Report). You can also export the report in HTML, PDF, or Excel format.

Questions asked by quality/project managers

How can I setup and configure a new MXAM project?

First it is recommended to think about how the MXAM setup and all configuration files should be included in an existing tool chain 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.

How can I customize the check behavior?

Most checks provide parameters that can be used to configure custom check behavior. In the tool menu, choose 'Tool > Customize Check Parameters' to open the parameter 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.

How can I ignore elements and exclude them from being analyzed?

There are two ways to exclude elements from the analysis. You can use global MATLAB® parameters to exclude Simulink® 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'.

How can I create a customized guideline document?

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 as you like. A document editor opens to edit the chapter structure and add guidelines.

Questions asked by tool chain managers

What are the system requirements to run MXAM?

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.

How can I install MXAM?

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, see the installation instructions.

How can I setup the license?

MXAM can be used with a node-locked, dongle, or floating network license. For a detailed description, see how to configure the license.

How can I automate an analysis?

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.

How can I execute custom code during an analysis in MATLAB?

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

How can I implement custom checks?

To implement custom checks, refer to the developer guide for helpful information and to get started.