Page tree

MagicDraw 2021x Refresh1 Documentation


You can enable or disable any invalid properties, references, and exception messages except invalid syntax messages by editing the config.xml file or through Report Environment options. Invalid syntax messages are always enabled.

Enabling or disabling warning messages by editing the config.xml file

To enable or disable a warning message by editing the config.xml file, do one of the following


  • Edit the config.xml file in the ...\plugins\com.nomagic.magicdraw.reportwizard\data folder to enable or disable all templates’ warning messages.
  • Edit the config.xml file and create a file in the ...\plugins\com.nomagic.magicdraw.reportwizard\data\templatefolder folder to enable or disable each template's warning message.


For example, to enable or disable a warning message of the Class Specification report, you need to edit the config.xml file in the ...\plugins\com.nomagic.magicdraw.reportwizard\data\Class Specification Report folder.


Adding tags and values to enable or disable warning messages

The table below lists the warning message types and their tags.

Warning message type Tag 
Invalid property <template.warn.invalid.property> 
Invalid reference<template.warn.invalid.reference>
Invalid method reference <template.warn.invalid.method>
Exception <template.warn.exception>


To enable or disable a warning message by adding its tags and values in the config.xml file


  1. Apply the following XML with a warning message type and its tags:

    A Tag for a Warning Message Type

  2. Set the boolean value to true to enable the warning message or false to disable the warning message.


An example of how to enable an invalid reference warning message of the Class Specification report is shown below.

The Invalid Reference Warning Message Enabled through File config.xml

Editing the config.xml file with tags and values to enable an invalid reference warning message of the Class Specification report.

Enabling or disabling warning messages through the Report Environment options

To enable or disable a warning message through the Report Environment options


  1. On the main menu, select Options > Environment. The Environment Options dialog opens.
  2. In the left pane, click Report Wizard.
  3. Set the value of the following properties in the table under the Configure report properties section to true to enable the warning message or false to disable the warning message.

    Property

    Description

    template.warn.invalid.property

    Enable or disable the invalid property warning message.

    template.warn.invalid.reference

    Enable or disable the invalid reference warning message.

    template.warn.invalid.method

    Enable or disable the invalid method reference.

    template.warn.exception

    Enable or disable the exception message.



  4. Click OK to apply the updates.

Note

To allow the updates set in the Report Wizard Environment Options dialog to take effect, you must close the UI before running Report command line.

  • No labels