Download Installation instructions

SaveUML
Installation instructions
Version 1.0
SaveUML
Installation instructions
Version:
1.0
Date: 2008-01-22
Revision History
Date
Version
Description
Author
2008-01-21
0.01
Initial Draft
Luka Lednicki
2008-01-22
0.02
Corrected some spelling
AP
Doc. No.:
Page 2
SaveUML
Installation instructions
Version:
1.0
Date: 2008-01-22
1.Introduction
1.1Purpose of this document
The purpose of this document is to give installation instructions to users of SaveUML package.
1.2Document organization
The document is organized as follows:




Section 1, Introduction, describes contents of this guide etc.
Section 2, Requirements.
Section 3, Installing SaveUML package.
Section 4, Uninstalling SaveUML.
1.3Intended Audience
The intended audience is:
 Users of the SaveUML package.
1.4Scope
The document describes how to install SaveUML package on a computer and how to install SaveUML plug-in
in Rational Software Modeler.
1.5Definitions and acronyms
1.5.1Definitions
Keyword
SaveUML
Definitions
The Java package including transformation of UML 2.0 models to
SaveCCM models, transformation of SaveCCM models to UML
2.0 models and a custom profile for creating Save models using
UML 2.0
1.5.2Acronyms and abbreviations
Acronym or
abbreviation
RSM
IDE
JRE
SWT
Definitions
Rational Software Modeler,
modeling IDE
Integrated Developing Enviroment
Java Run-time Enviroment
Standard Widget Toolkit,
an open source framework for developing graphical user interfaces
in Java
Page 3
SaveUML
Installation instructions
Version:
1.0
Date: 2008-01-22
2.Requirements
2.1Java
SaveUML requires JRE 1.5 or higher.
SaveUML Transform, the stand-alone tool, also needs an SWT library. An SWT library for Windows XP is
already packed inside the tool and the tool will extract it if needed. As the SWT uses Java Native Interface, user
must provide the required library if a different operating system is used.
2.2Rational Software Modeler
SaveUML was generated for, and tested on, IBM's Rational Software Modeler version 7.0.0.
Transformations use UML models saved as RSM's .emx files. Any software that uses the same file format can
be used for UML modeling as long as it conforms to the same .emx format.
SaveUML plug-in is generated for RSM 7.0.0. There is no guarantee that the plug-in will work on other RSM
versions or distributions of Eclipse IDE.
2.3SAVE-IDE
For modeling Save models that SaveUML can transform, the user will need the SAVE-IDE plug-in for Eclipse.
The SAVE-IDE version used while developing SaveUML was v.0.5alpha
3.Installing SaveUML package
3.1Deployment of the SaveUML package
SaveUML is delivered in a Zip file containing SaveUML Java library, SaveUML Transform (a stand-alone tool
for transforming models and delivering the UML 2.0 profile), and SaveUML plug-in for RSM.
To use SaveUML, the user must unzip the SaveUML.zip file to a folder specified by the user. The generated
folder structure will be:
SaveUML/ - the main SaveUML folder
SaveUML/Java lib – Jar library containing Java classes for transformation
SaveUML/SaveUML Transform/ - the stand-alone tool for transformation
SaveUML/RSM Plugin/ - the plug-in for RSM
3.2SaveUML Transform – Stand-alone tool
SaveUML Transform is delivered as a Java Jar that contains everything needed for transforming models, and
can deploy the UML 2.0 profile file that is needed for creating Save models in UML. It needs no installation,
and can be copied into any folder and run with the command:
java -jar “SaveUMLTransform.jar”
The stand-alone tool uses the SWT library. SWT for Windows XP is already packed into the .jar and the tool
will extract and use it if none is found. On other operating systems, the user must provide the SWT library.
3.3Installing RSM plug-in
The RSM plug-in is deployed with unpacking of the SaveUML.zip. Installing the plug-in into RSM is done
using Eclipse Configuration manager.
Steps that need to be performed to install the plug-in:
1. Open RSM.
2. From the Help menu, choose Software Updates, and then Manage Configuration.
3. In the configuration tree, right click the Rational Software Modeler node.
4. From the context menu, choose Add, and then Extension Location...
5. In the Browse For Folder dialog, find the RSM Plugin folder of your SaveUML package and click Ok.
6. Restart RSM.
Page 4
SaveUML
Installation instructions
Version:
1.0
Date: 2008-01-22
4.Uninstalling SaveUML
To uninstall SaveUML, the user just needs to delete the folder generated when the SaveUML was deployed.
Page 5