Cameo Systems Modeler™ 18.0 SP1 
 Readme 

(Build ID: 174616)


Introduction System requirements Installation Recommendations Configuration More information and support Troubleshooting Demo limitation 3rd party libraries

    

Introduction


Top

Cameo Systems Modeler™ software provides a solution for modeling and analyzing systems. The product allows you to represent and analyze systems by using the Systems Modeling Language (SysML 1.3) standard. Cameo Systems Modeler provides systems modeling specific concepts, artifacts, new project templates, samples, and systems modeling specific usability features.

    

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

3 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 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 7 or later compatible operating system, i.e., Windows XP/ Vista/ 7/ 8, Linux, Mac OS X (most testing procedures and debugging have been performed on these operating systems).

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

Java Virtual Machine:

http://www.nomagic.com/support/jvm-list.html


    

Installation


Top

First, obtain the Cameo Systems Modeler installation files. You can download the latest version from the Cameo Systems Modeler homepage http://www.nomagic.com/products/cameo-systems-modeler.html

If you are going to install Cameo Systems Modeler 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 Cameo Systems Modeler from the no-install package (see section Using no-install package).

Using the 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 Cameo Systems Modeler.

  6. NOTES:

Unix

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

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

Mac OS X

IMPORTANT! Be sure you have installed JVM. 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 Cameo_Systems_Modeler_<version number>_mac.dmg.

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

  3. Double-click the installer.

  4. Drag the Cameo Systems Modeler folder to the Applications/Cameo Systems Modeler <version number> or some other folder.

Using no-install package

Download the no-install package to run Cameo Systems Modeler on any operating system.

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

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

  2. Extract the file.

  3. Open the bin directory and run csm.exe to start Cameo Systems Modeler.

Unix

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

  2. Extract the file.

  3. Open the bin directory and run csm to start Cameo Systems Modeler.
    IMPORTANT!
    Be sure you have installed JVM.

Mac OS X

IMPORTANT! Be sure you have installed JVM. 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 Cameo_Systems_Modeler_<version number>_no_install.zip.

  2. Extract the file.

  3. Open the root directory and double-click Cameo Systems Modeler <version number>.app to start Cameo Systems Modeler.


   

Recommendations


Top

To use the Cameo Systems Modeler's release that contains no Java Virtual Machine (JVM), you should have the JVM installed on your computer. JVM is an application that provides the interpretation of the bytecode Java class files. Different operating systems may have different JVM implementations, thus some bugs may be specific to the operating system or JVM.

Cameo Systems Modeler is a stable environment, if it is configured properly and if the stable JVM is used. USE RECOMMENDED JVM TO AVOID A LOT OF PROBLEMS. All recommendations are written below. As Cameo Systems Modeler is a Java application, most of the stability and performance depends on the JVM implementation. Refer to the JVM specification and problem descriptions, if you have problems on the specific OS.

JDK 1.1.x, 1.2.x, 1.3.x, 1.4.x, and 1.5.x is not supported.

To review your system and JVM information (in case you have already installed Cameo Systems Modeler) on the main menu click Help > About Cameo Systems Modeler and then in the opened dialog click the Environment tab. The JDK version can also be encountered from the command-line prompt by typing the command:

java -version

Attention for non-Windows users!
You have to start the application setup from the command-line prompt. Your system should have Java Virtual Machine (JVM) installed BEFORE running the Cameo Systems Modeler installer (preferred versions are mentioned above).

You can download the newest demo version of Cameo Systems Modeler from
http://www.nomagic.com/products/cameo-systems-modeler.html


    

Startup configuration


Top

Changing Java version

On all operating systems

In the csm.properties file, which is located in <Cameo Systems Modeler installation directory>\bin, add the value for the following parameter:

JAVA_HOME=<path to new JRE>

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

Changing the location for storing configuration files

Configuration files are by default stored in the following locations:

OS
Configuration files storage

Windows Vista/7/8

C:\Users\<username>\AppData\Local\.cameo.systems.modeler\<Cameo Systems Modeler version number>

Windows 2000/XP

C:\Documents and Settings\<username>\Local Settings\Application Data\.cameo.systems.modeler\<Cameo Systems Modeler version number>

Windows NT4

C:\WINNT\Profiles\<username>\Local Settings\Application Data\.cameo.systems.modeler\<Cameo Systems Modeler version number>

Other OS

<user.home>/.cameo.systems.modeler/<Cameo Systems Modeler version number>

If Cameo Systems Modeler is running, you can open this folder directly from the application. Do the following:

  1. On the main menu, click HelpAbout Cameo Systems Modeler.
  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 Cameo Systems Modeler installation directory:
  1. Open the csm.properties file, which is located in <Cameo Systems Modeler 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 in Cameo Systems Modeler installation directory.
To store Cameo Systems Modeler configuration files in Common Application Data location on Windows OS
  1. Open the csm.properties file, which is located in <Cameo Systems Modeler 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 cameoearedirect.
  3. In the file, type the absolute path to the folder, wherein Cameo Systems Modeler configuration files will be saved, e.g., C:\<directory name>.
Or:
  1. Open the csm.properties file , which is located in <Cameo Systems Modeler 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 Cameo Systems Modeler installation directory (see section To store configuration files in the Cameo Systems Modeler application installation directory), files will not be stored in the defined location.

Redirecting output info to console

Cameo Systems Modeler output information by default goes into the csm.log file. If there is a need, you can redirect the output to console.

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

On all operating systems

In the csm.properties file, which is located in <Cameo Systems Modeler installation directory>\bin, add the value for the following parameter:

APP_ARGS =-verbose
    

Where to find more information or support?


Top

Web page

To download the demo of this version and to get contact information or purchase details, please go to http://www.nomagic.com/products/cameo-systems-modeler.html

New features

For information on Cameo Systems Modeler new features, see New and Noteworthy at http://www.nomagic.com/news/news-noteworthy/cameo-systems-modeler-plugin-noteworthy.html

Forum

Discuss and get answers about No Magic products in No Magic Community Forum. With respect to the growing interest in No Magic products, we have expanded the capabilities that had been provided by our newsgroups and have moved the content to the online forum. You are welcome to post your comments and questions here.

NOTE: If you are interested in  old discussions from the newsgroups, you can find them in the Forum as well as in the newsgroups in a read-only mode.

Knowledgebase and new issue registration

We are awaiting your comments and suggestions. More than a half of the features of the current version added because our demo version users have requested them. Do not miss the chance to see your desired features in the future versions!

Documentation

Find out the useful information about working with Cameo Systems Modeler in the following types of documentation:

- For the generic information about using the application, see MagicDraw UserManual.pdf.
- For the specific information about modeling Systems processes using the SysML 1.3 standard, see Cameo Systems Modeler UserGuide.pdf.
To open Cameo Systems Modeler Help on the Help menu click Help Contents.

    

Troubleshooting


Top

Performance improvements

When you work with very large models or use a lot of diagrams at a time, the performance of Cameo Systems Modeler may become slow. To increase an efficiency of modeling, we suggest the following solutions:
  1. On the Option menu, click Environment. The Environment Options dialog opens.
  2. In the General option list, expand the Save / Load options group.
  3. To the Diagrams Lode Mode option, assign the Do not load diagrams value.
  4. Restart Cameo Systems Modeler.
Your projects will be opened over a shorter period of time without opening a diagram as well as use less memory.
  1. On the Option menu, click Environment. The Environment Options dialog opens.
  2. In the General option list, expand the Active Validation options group.
  3. Increase the Active Validation Period (seconds) value. IMPORTANT! Be aware about limits of the Active Validation Period size, as a long period may be an alternative of switching an active validation off.
  4. Restart Cameo Systems Modeler.
Reduced active validations using takes less memory.

OutOfMemory problem

Sometimes when running the program the OutOfMemory error occurs. The cause of an OutOfMemoryError is that you simply haven't got enough memory available for the workings of the application.

If during your work the out of memory Error dialog box appears, change the java heap size and/or MaxPermSize directly in this dialog box (change the option that is labeled with the red color).

NOTE: The java maximum heap should be set to less than the available physical RAM on the machine, that is the RAM minus the amount of memory taken by any other processes that will run concurrently. Otherwise your JVM process will likely swap and that will slow down the application.

If the out of memory Error dialog box does not appear or increasing the heap size does not help examine the full error message. In the exception message, further information is supplied after java.lang.OutOfMemoryError. Here are some common examples of what that additional information may be, what it may mean, and what to do about it:

You can change the java maximum heap size (-Xmx), permanent generation maximum size (-XX:MaxPermSize), thread stack size (-Xss) in your <Cameo Systems Modeler installation directory>/bin/csm.properties file, in the line:
JAVA_ARGS=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M -Xss512K

NOTE: Integrated Cameo Systems Modeler runs on JVM that is specified by the IDE. If you are running Cameo Systems Modeler integrated with the IDE you will need to modify startup properties for the appropriate IDE.

Application pause time problem

If you are having problems with pause times in your application, try to change the default garbage collector.

You can specify the desired garbage collector in your <Cameo Systems Modeler installation directory>/bin/csm.properties file (or the csm64.properties file on 64-bit Windows), to the line JAVA_ARGS= appending the required parameters.
E.g.:
JAVA_ARGS=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M -XX\:+UseConcMarkSweepGC -XX\:+CMSIncrementalMode -XX\:+CMSIncrementalPacing -XX\:CMSIncrementalDutyCycleMin\=0 -XX\:CMSIncrementalDutyCycle\=10
or
JAVA_ARGS=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M –XX\:+UseParallelOldGC
or
JAVA_ARGS=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M -XX\:+UseConcMarkSweepGC

StackOverflow problem

Sometimes when running the program, the StackOverflowError occurs.

If you are running the Sun's, IBM JVM, set the following java properties in your <Cameo Systems Modeler installation directory>/bin/csm.properties file to avoid the above problem:
to the line JAVA_ARGS=-Xmx800M, append the string -Xss<stack size>.
For example:
JAVA_ARGS=-Xmx800M -Xss2M
This sets the java stack size to 2 megabytes.

NOTE: Integrated Cameo Systems Modeler runs on JVM that is specified by the IDE. If you are running Cameo Systems Modeler integrated with the IDE you will need to modify startup properties for the appropriate IDE.

Computer freezes or reboots while exiting Cameo Systems Modeler or repaint problems occur

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

NOTE: Integrated Cameo Systems Modeler runs on JVM that is specified by the IDE. If you are running Cameo Systems Modeler integrated with the IDE you will need to modify startup properties for the appropriate IDE.

Java Virtual Machine could not be started

Open the <Cameo System Modeler installation directory>/bin/csm.properties file for editing and comment the lines defining default memory settings. These lines should look like this:

# DEFAULT_MEMORY_SETTINGS_64=-Xmx2400M -XX\:PermSize\=60M -XX\:MaxPermSize\=200M -Xss1024K
# DEFAULT_MEMORY_SETTINGS_32=-Xmx800M -XX\:PermSize\=40M -XX\:MaxPermSize\=150M -Xss640K

After the install, Cameo Systems Modeler cannot be launched or it just appears on the screen and vanishes

Please try one of the following solutions:

NOTE: Integrated Cameo Systems Modeler runs on JVM that is specified by the IDE. If you are running Cameo Systems Modeler integrated with the IDE you will need to modify startup properties for the appropriate IDE.

Cameo Systems Modeler cannot be started on Windows Vista

If you are using the recommended java version and Cameo Systems Modeler can be started only under Administrator privilegies, the possible reason can be the Windows Vista User Access Control (UAC) restrictions. You can try to turn off the UAC and then to start Cameo Systems Modeler.
For more information about turning off the UAC, see the Microsoft Windows website: http://windowshelp.microsoft.com/Windows/en-US/Help/58b3b879-924d-4e08-9358-c316055d3eae1033.mspx.

Cameo Systems Modeler cannot be started on Mac OS X Mountain Lion

If Cameo Systems Modeler cannot be started on Mac OS X Mountain Lion, it can be that you need to exempt Cameo Systems Modeler from Gatekeeper. To do this, in the Security Preferences > Security and Privacy dialog, select the Anywhere option.
For more information about Gatekeeper on Mac OS X Mountain Lion, see http://support.apple.com/kb/HT5290.

Cameo Systems Modeler installer cannot be started or Cameo Systems Modeler cannot be started on Linux OS

The Cameo Systems Modeler installer cannot be started or Cameo Systems Modeler itself cannot be started, because of changes in the default system Java. In this case when starting the installer or Cameo Systems Modeler, 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:

Sometimes Cameo Systems Modeler becomes unpredictable

To start Cameo Systems Modeler normally, perform the following steps:
  1. Open the <user home directory>\.cameosystemsmodeler\<version number> folder and delete all cache folders.
  2. Restart Cameo Systems Modeler.

csm.log file location

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

If for some reasons Cameo Systems Modeler cannot be started, look for the csm.log file in one of the following locations:

Frequently Asked Questions

If you cannot find the answer to your problem in the list above, please visit our website for FAQ in http://www.nomagic.com/support/faq.html

Example files

After you have installed Cameo Systems Modeler, you can open an example of a diagram. These files are in the samples directory.


    

Demo version limitation


Top

The DEMO version of the Cameo Systems Modeler allows saving a project with 25 actions, 25 blocks, 25 business requirements, 20 classes, 25 components, 25 constraint blocks, 25 design constraints, 25 domains, 25 extended requirements, 25 externals, 25 functional requirements, 25 interface specifications, 25 interface blocks, 25 interface requirements, 25 lifelines, 25 nodes, 25 performance requirements, 25 lifelines, 25 nodes, 25 performance requirements, 25 physical requirements, 25 quantityKinds, 25 report data, 25 requirements, 25 states, 25 subsystems, 25 systems, 25 system contexts, 25 units, 25 usability requirements, 25useCases and 25 viewpoints, although it can read and print projects of any size.

The DEMO version expiration date is limited. The exact expiration date is provided in the email containing demo license key.

    

Third party libraries


Top

This product includes software developed by the Apache Software Foundation (http://www.apache.org/) and JIDE Software (http://www.jidesoft.com).