MagicDraw® 17.0.5 SP1 
 Reader Readme

(Build ID: 167098)


Overview System requirements Installation Configuration Troubleshooting


    

What is MagicDraw Reader?


Top

MagicDraw Reader edition is made for reading and previewing UML models created with MagicDraw and is free of charge. It is extremely useful when you want to share your ideas expressed in UML with partners, colleagues, or clients, who do not have their copy of MagicDraw. This edition is also equipped with printing and the image export capabilities.


    

System requirements


Top

Resource

Minimum

Recommended

Powerful

CPU

Pentium™ 4, 1.6 GHz or higher

Core™ 2 Duo, 2.2 GHz

Core™ i5, 4.0 GHz

RAM

1 GB

4 GB

8 GB

Disk space

500MB or more depending on used plug-in

Video mode

1024*768 @ 64k colors

1280*1024 @ 64k colors

1280*1024 @ 64k colors

OS

Windows XP SP 3, Mac OS X Lion, or Linux that runs with recommended Java

Windows 7/8, Mac OS X Mountain Lion, or Linux that runs with recommended Java

Windows 7/8, Mac OS X Mountain Lion, or Linux that runs with recommended Java

Java

32 bit

64 bit

64 bit

JAVA_ARGS parameter*

If 32 bit Java is used

JAVA_ARGS=-Xmx800M

JAVA_ARGS=-Xmx1400M

JAVA_ARGS=-Xmx1400M

If 64 bit Java is used

JAVA_ARGS=-Xmx800M

JAVA_ARGS=-Xmx2000M

JAVA_ARGS=-Xmx4000M

* Sometimes when running the application, the OutOfMemory error occurs. This means that your computer has not enough memory for working with the application. Ways of solving the problem are described in section OutOfMemory problem.

Operating system: Any Java SE 6 or later compatible virtual machine, i.e., Windows 95/98/NT/2000/XP/Vista/ 7/ 8, Linux, Mac OS X (most testing procedures and debugging were performed on those operating systems).

HTML browser: Any. Preferred Firefox or Internet Explorer and Safari for Mac OS X.

Java Virtual Machine:

You can find the up-to date JVM list at:
http://www.nomagic.com/support/jvm-list.html


    

Installation


op

First, obtain the MagicDraw Reader installation files. You can download the latest version from the MagicDraw homepage http://www.nomagic.com/products/magicdraw.html

If you are going to install MagicDraw Reader on Unix, MAC OS, or other operating system that is not Windows OS, then JVM must be installed on your computer. For more information about the recommended Java version, see http://www.nomagic.com/support/jvm-list.html

If you use an operating system other than Windows, Unix, or Mac OS X, we recommend to run MagicDraw Reader from the no-install package (see section Using no-install package).

Using installer

Windows 95/ 98/ NT/ 2000/ XP/ Vista/ 7/ 8
  1. Ensure that your computer meets the system requirements for running the application.

  2. Download either:

  3. Double-click the installer.

  4. In case the User Account Control dialog appears asking your permission for the installer to make changes in your computer, click Yes.

  5. Follow the on-screen instructions to install MagicDraw.

  6. NOTES:

Unix

  1. Download MagicDraw_Reader_<version number>_unix.sh.

  2. Double-click the installer.
    IMPORTANT!
     Be sure you have:

Mac OS X

IMPORTANT! Be sure you have JVM installed. Mac OS X Lion and Mac OS X Mountain Lion do not include a Java runtime by default. It must be installed separately.

  1. Download MagicDraw_Reader_<version number>_mac.dmg.

  2. Open the Applications folder and create a new folder named, for example, MagicDraw Reader <version number>.
    NOTE: We suggest creating a new folder for each MagicDraw version in order to not overwrite earlier MagicDraw versions. After installing a new version in the newly created folder you will be able to import the configurations from an earlier MagicDraw version.

  3. Double-click the installer.

  4. Drag the MagicDraw Reader folder to the Applications/MagicDraw Reader <version number> folder or some other folder.


Using no-install package

Download the no-install package to run MagicDraw Reader on any operating system.

Windows 95/ 98/ NT/ 2000/ XP/ Vista/ 7/ 8

  1. Download MagicDraw_Reader_<version number>_no_install.zip.

  2. Extract the file.

  3. Open the bin directory and run magicdraw.exe to start MagicDraw Reader.

Unix

  1. Download MagicDraw_Reader_<version number>_no_install.zip.

  2. Extract the file.

  3. Open the bin directory and run magicdraw to start MagicDraw Reader.
    IMPORTANT! Be sure you have installed JVM.

Mac OS X

IMPORTANT! Be sure you have JVM installed. Mac OS X Lion and Mac OS X Mountain Lion do not include a Java runtime by default. It must be installed separately.

  1. Download MagicDraw_Reader_<version number>_no_install.zip.

  2. Extract the file.

  3. Open the root directory and double-click MagicDraw Reader <version number>.app to start MagicDraw Reader.


    

Startup configuration


Top

Changing Java version

On all operating systems

In the magicdraw.properties file, which is located in <MagicDraw Reader installation directory>/bin, add the value for the following parameter:

JAVA_HOME=<path to new JRE>

NOTE: Integrated MagicDraw Reader runs on the JVM specified by the IDE. In order to change JVM, you need to modify startup properties for the IDE, MagicDraw Reader integrates with. If you are running MagicDraw Reader integrated with IDE, read the appropriate readme.html for the specific integration, which can be found in <MagicDraw Reader installation directory>\integrations\<IDE directory>.

Changing the location for storing configuration files

By default MagicDraw Reader configuration and auxiliary files are stored in the following location:

OS
Configuration files storage

Windows Vista/7/8

C:\Users\<username>\AppData\Local\.magicdraw_reader\<MagicDraw Reader version number>

Windows 2000/XP

C:\Documents and Settings\<username>\Local Settings\Application Data\.magicdraw_reader\<MagicDraw Reader version number>

Windows NT4

C:\WINNT\Profiles\<username>\Local Settings\Application Data\.magicdraw_reader\<MagicDraw Reader version number>

Other OS

<user.home>/.magicdraw_reader/<MagicDraw Reader version number>

If MagicDraw Reader is running, you can open the configuration files folder directly from the application. Do the following:

  1. On the main menu, click HelpAbout MagicDraw.
  2. Open the Environment tab.
  3. Click the Configuration Files hyperlink.
You can also save configuration files in any of the following locations:
To store configuration files in MagicDraw Reader installation directory:
  1. Open the magicdraw.properties file, which is located in <MagicDraw Reader installation directory>/bin.
  2. Change the parameter value from
    -DLOCALCONFIG=true
    to
    -DLOCALCONFIG=false
  3. On Windows OS, add the additional parameter
    -DWINCONFIG=false
    IMPORTANT: It is important to add the DWINCONFIG parameter on Window OS, otherwise the configuration files will not be stored at MagicDraw Reader installation directory.
To store MagicDraw Reader configuration files in Common Application Data location on Windows OS
  1. Open the magicdraw.properties file, which is located in <MagicDraw Reader installation directory>/bin.
  2. Change the parameter value from
    -DLOCALCONFIG=true
    to
    -DLOCALCONFIG=false
  3. NOTE: The Common Application Data location is the following:
To store configuration files in other directory:

Do either:

  1. Open the folder, where the configuration files are stored (for the exact location, see the preceding table).
  2. Create a new file named magicdrawredirect.
  3. In the file, type the absolute path to the folder, wherein MagicDraw Reader configuration files will be saved, e.g., C:/<directory name>.
Or:
  1. Open the md.properties file, which is located in <MagicDraw Reader installation directory>/bin.
  2. Change the parameter value:
    -Dlocalconfig.location=<absolute path to a chosen location>
    NOTE: If you have defined to store files in the MagicDraw Reader installation directory (see section To store configuration files in MagicDraw Reader application installation directory), files will not be stored in the defined location.

Redirecting output info to the console

The MagicDraw Reader output information by default goes into the magicdraw.log file. If there is a need, you can redirect the output to the console.

NOTE: If you cannot find the magicdraw.log file, see section magicdraw.log file location.

On all operating systems

In the md.properties file, which is located in <MagicDraw Reader installation directory>/bin, add the value for the following parameter:

APP_ARGS =-verbose

    

Troubleshooting


Top

OutOfMemory problem

Sometimes when running the program the OutOfMemory error occurs.

Windows, Linux OS, Mac OS X

If you are running the Sun's JVM, set the following java properties in your magicdraw.properties file to avoid the above problem:
in the line JAVA_ARGS=-Xmx600M, change the number of the heap size '600' to the maximal heap size in megabytes.

For example, the java heap size would be:
JAVA_ARGS=-Xmx800M
This sets the java heap size to 800 megabytes.

NOTE: Integrated MagicDraw runs on the JVM, specified by the IDE. If you are running MagicDraw, integrated with the IDE, you will need to modify startup properties for the appropriate IDE.


OutOfMemory PermGen space problem

If you get the exception "java.lang.OutOfMemoryError: PermGen space", please check, if PermSize is specified in the configuration file.

Windows, Linux OS, Mac OS X (not applicable for IBM JVM)

In the magicdraw.properties file, the JAVA_ARGS line should look like:
JAVA_ARGS=-Xmx400M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M

If PermSize is specified in the magicdraw.properties file and the same problem still appears, MaxPermSize should be increased. PermSize is a part of heap size, so MaxPermSize should always be smaller than the heap size specified with the Xmx parameter.

For example:
JAVA_ARGS=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=200M

NOTE: Integrated MagicDraw runs on the JVM, specified by the IDE. If you are running MagicDraw, integrated with the IDE, you will need to modify startup properties for the appropriate IDE.


StackOverflow problem

Sometimes when running the program, StackOverflowError occurs.

Windows, Linux OS, Mac OS X

If you are running the Sun's, IBM JVM, set the following java properties in your magicdraw.properties file to avoid the above problem:
to the line JAVA_ARGS=-Xmx600M, append the string -Xss<stack size>.

For example:
JAVA_ARGS=-Xmx600M -Xss2M

This sets the java stack size to 2 megabytes.

NOTE: Integrated MagicDraw runs on the JVM, specified by the IDE. If you are running MagicDraw, integrated with the IDE, you will need to modify startup properties for the appropriate IDE.


Computer freezes or reboots while exiting MagicDraw or repaint problems occur

This may happen because of JDK SDK and the Windows direct draw incompatibility. We would suggest you to turn off the direct draw for the MagicDraw application.
In the <MagicDraw installation directory>/bin/magicdraw.properties file to the line'JAVA_ARGS=' append the additional part
-Dsun.java2d.noddraw.

NOTE: Integrated MagicDraw runs on the JVM, specified by the IDE. If you are running MagicDraw, integrated with the IDE, you will need to modify startup properties for the appropriate IDE.


After the install, MagicDraw cannot be launched or it just appears on the screen and vanishes

Try the following solution:

  1. Start MagicDraw with the system property no.printer.lookup=true.
  2. In the <MagicDraw installation directory>/bin/magicdraw.properties file to the line'JAVA_ARGS=' append the additional part
    -Dno.printer.lookup=true

NOTE: Integrated MagicDraw runs on the JVM, specified by the IDE. If you are running MagicDraw, integrated with the IDE, you will need to modify startup properties for the appropriate IDE.

 

MagicDraw installer is not started or MagicDraw is not started on Linux OS

The MagicDraw installer may not be started or MagicDraw itself may not be started, because of changes in the default system Java. In this case when starting the installer or MagicDraw, no GUI appears or when starting from the command line the following message is displayed:
Configuring the installer for this system's environment... No Java virtual machine could be found from your PATH environment variable. You must install a VM prior to running this program.
We would suggest the following solution:


magicdraw.log file location

If MagicDraw is running, you can open the magicdraw.log file directly from the application. Do the following:
  1. On the main menu, click Help > About MagicDraw.
  2. Open the Environment tab.
  3. Click the Log File hyperlink.

If for some reasons MagicDraw cannot be started, look for the magicdraw.log file in configuration files directory. For more information about configuration files location, see section Changing the location for configuration files storage.

Frequently Asked Questions and Forum

If you cannot find the answer to your problem in the list above, please visit our website for FAQ at http://www.nomagic.com/support/faq.html or  discuss and get answers about No Magic products in No Magic Community Forum