installing installing ibm rational rhapsody designer and architect for mbse

Installing IBM Rational Rhapsody Designer and Architect for MBSEDETAILED STEPS – PROVIDED BY MBSE TRAINING AND CONSULTING ([email protected])

22-MAY-2016 (V4)

INSTALLING RHAPSODY DESIGNER FOR SYSTEMS ENGINEERS 1

Editions vs. Versions

• IBM® Rational Rhapsody® is packaged (i.e. sold) as 4 Editions. Each edition uses a different core Rhapsody license:

• Developer for C/C++/Java (or Ada or C/C++/Java/Ada)◦ A Premium Edition for software and systems. Includes full behavioral and State Machine

(and other) code generation and a real-time framework (OxF) for deployment of code to Real-time Operating Systems.

◦ There is also an Ada only Developer Edition and a C/C++/Java/Ada Developer Edition package (i.e. 4 language licenced package).

• Architect for Software Engineers◦ A lower cost Edition. A stripped down version of Developer. Some code generation but

no real-time framework or state machines/RTOS support.

• Designer for Systems Engineers◦ A Premium Edition for systems engineering. Uses a subset of Developer features but

enforces Animation, i.e. can execute models but only for animation purposes.

• Architect for Systems Engineers◦ A lower cost Edition. Doesn’t have any model execution, i.e. it’s just the modelling tool

without any system simulation or code generation capabilities.


Things to know

• Things to know:

1. All Rhapsody Editions use the same installer to install.

2. All Rhapsody Editions use the same underlying file format.

3. They are the same tool with different features turned on and off.

4. The choice of Edition launched is based on a command-line option given to the rhapsody.exe.

5. The rhapsody.ini file in the installation direction specifies the Default Edition to launch when you click to open a Rhapsody model on the file-system.

6. If you install Developer then shortcuts to the other Editions are also installed (in the Start menu).

7. Rhapsody will try and consume the license for the Edition launched. If it can’t then it won’t open.

8. The SysML profile is not separately licensed. All Editions have the SysML profile and could be used for systems engineering.


Installing Developer

• For the reasons given on the previous page, the steps here install Developer and then give instructions on how to modify the installation. This means that the installation will have maximum flexibility and can be switched around between Editions (assuming licenses are available and necessary permissions).

• Selecting Developer Edition in the installer also makes it easier to verify compiler toolchain during the install. This is used for system simulation.

• Often a goal for a company may be to reduce the cost of licenses. Different strategies may be deployed for this. For example, installing the low cost Architect for Systems Engineers version for most users, and providing instructions on how to launch Designer shortcut from Start menu for those that need it. Some organizations will simply deploy the same Edition to all machines to make it simpler. For large organizations they may have a token license pool. The token pool would need to include the particular editions for them to be usable from the pool.

• Further advice should be sort when wanting to mix opening the same project with different software editions, e.g. using Developer in C with Designer, as Designer will assume models are C++ under the hood, or assume Animation settings.


64 vs 32 bit

• Rhapsody has both a 64 bit and 32 bit versions. Don’t be blasé about thinking that it is better to install the 64 bit. The main reason for not installing it is that a 64 bit application can’t call a 32 bit application. As such, many integrations will not work. For this reason, it may be recommended to park the 64 bit version out of site for the time being and install the 32 bit version until such a time that you have asserted that you don’t need these third party 32 bit integrations.

See: http://www-01.ibm.com/support/docview.wss?uid=swg27038779

• Note: Windows XP is not a supported platform for Rhapsody. Some small stability issues have been reported. Supported OS are available in the System Requirements tab here:

http://www-03.ibm.com/software/products/en/ratirhap/

or:

http://www-01.ibm.com/support/knowledgecenter/SSB2MU_8.1.3/com.ibm.rhp.installing.doc/topics/rhp_r_iu_software_requirements.html


http://www-01.ibm.com/support/docview.wss?uid=swg27038779

http://www-03.ibm.com/software/products/en/ratirhap/

http://www-01.ibm.com/support/knowledgecenter/SSB2MU_8.1.3/com.ibm.rhp.installing.doc/topics/rhp_r_iu_software_requirements.html

Things to be installed

• These instructions provide guidance on installing:

• Rhapsody Designer for Systems Engineers Edition (32 bit) with simulation support for animating and executing systems models using the Cygwin gcccompiler toolchain (to support system simulation). Also installed are a number of key Add-Ons. In particular the Gateway Add On which provides synchronization of requirements with Rational DOORS, Word and Excel documents.

• The Rhapsody version assumed here is 8.1.3.

• Cygwin gcc is a set of Open Source tools. It is not provided by IBM or part of the IBM toolset, rather it is one of the compilers that Rhapsody supports. Microsoft Visual Studio is also supported. Cygwin delivers the open source standard Red Hat GNU gcc compiler and gdb debugger on Windows.


Download Rhapsody 8.1.3

• http://www-03.ibm.com/software/products/en/ratirhap/

Rhapsody_eval_8.1.3_Windows_32.zip (1334 MB)Rhapsody_Eval_Key.dat (12 KB) - To Test Install


Further help on installation

• You should not need this is you follow these instructions but for the record:

• http://www-01.ibm.com/support/knowledgecenter/SSB2MU_8.1.3/com.ibm.rhp.installing.doc/topics/rhp_c_iu_rational_rhp_installation.html


http://www-01.ibm.com/support/knowledgecenter/SSB2MU_8.1.3/com.ibm.rhp.installing.doc/topics/rhp_c_iu_rational_rhp_installation.html

Downloading the Cygwin gcccompiler installation filesINSTRUCTIONS TO GET FILES NEEDED


Cygwin

• Locate the Cygwin home page: https://www.cygwin.com/


https://www.cygwin.com/

Download setup.exe

• Download and run the setup-x86.exe. Choose the 32-bit installer

• Click Next >


Choose a download source

• Choose Download Without Installing

• Click Next >


Select local package directory

• Choose a location for the installation files (your choice)

• Click Next >


Select your internet connection

• Click Next >


Choose a download site

• Choose a mirror site (probably doesn’t matter which one but a UK site may feel better)

• Click Next >


• Expand the Developer tools tree. We need to select the specific components we want. Toggle to install the following:

• 1. gcc-g++: GNU Compiler Collection (C++)

• 2. gdb: The GNU Debugger

• 3. make: The GNU version of the ‘make’ utility

• Click Next >

Select packages


Resolving dependencies

• Cygwin will identify the dependent components automatically

• Click Next >


Progress

• The download will start. Wait for it to complete


Installation complete

• Click Finish when download is complete


Locate the download files

• The files will have been copied locally. If you want to use these to install on multiple machines then this folder hierarchy can be transferred. You will also need the setup-x86.exe installation tool, hence you could copy this also to the machines that need it


Installing Cygwin gcc compiler using the setup-x86.exeINSTALLING USING DOWNLOADED FILES


• Double-click to launch the setup-x86.exe again

• Click Next >

Cygwin Setup


Choose a download source

• Click Install from Local Directory

• Click Next >


Select root install directory

• Keep the default C:\cygwin root folder

• Click Next >


Select local package directory

• Now browse to the folder where you downloaded the Cygwin files to in the previous section (it should remember)

• Click Next >


Click packages to install

• Select gcc-g++: GNU Compiler Collection (C++), gdb: The GNU Debugger, and make: The GNU version of the ‘make’ utility (as before)

• Click Next >


Cygwin Setup – Resolving Dependencies

• Click Next >


Progress

• Installation will commence


Installation complete

• Click Finish


Optional: Testing gcc and make are installed

• Launch a Command Prompt and browse to the C:\cygwin\bin folder

• Type gcc followed by return. A “no input files” message should appear

• Type make followed by a return. A “No targets specified… “ message should appear


Installing RhapsodyRUNNING THE INSTALLATION WIZARD


Extract the files

• The Rhapsody installer is packaged as a compressed file: Rhapsody_eval_8.1.3_Window_32.zip

• Unzip the file to a local folder by right-clicking and choose Extract All…


Run setup.exe

• Double-click the setup.exe file to start the installation wizard

• Choose language and click OK


Welcome to the wizard

• Click Next >


Software license agreement

• Assuming you do, click I accept the terms in the license agreement

• Click Next >


Choose Edition

• Ensure IBM Rational Rhapsody Developer is selected (even if you’re going to use one of the other Editions – this will install all the Editions in the Start menu)

• Click Next >


Choose languages

• Select C++ and C (the assumption is that we are installing for systems engineering purposes only (C++) but since the Cygwin compiler includes C we may as well check the box)

• Choose Development environment and RTOS setting and click Next >


Destination Folder

• A number of options are now possible that may depend on your admin rights and Windows User Access Control (UAC). Fundamentally, Rhapsody wants to install some installation folders in an area that has read-write access


Destination folder

• Click Next > to accept the default settings

This is generally the safest option as it is more likely to comply with your IT guidelines. It will result in the read-only installation files going under the Program Files (x86) area and the read-write files being placed in a C:\Users\<username>\IBM… folder


Development environment paths

• Rhapsody will now check your registry to see what compilers are installed.

• Click Next >


Development environment paths

• Rhapsody should’ve automatically found the C:\Cygwin\ compiler folder and marked it with a green tick (if not, you may have a problem)

• Click Next >


Add-on installation

• A number of add-ons we need are not installed by default. Select and deselect Add-Ons to match the following screenshot

• For example, click This feature will be installed on local hard drive for the Rational Rhapsody Gateway Add On


Notes on Add Ons

• Important: Some of these add-on products require separately purchased licenses. In case you’re interested:

• Rational Rhapsody Gateway Add On - Requirements Traceability connects Rational Rhapsody to IBM Rational DOORS®, IBM Rational RequisitePro®, and other requirements authoring tools provided by other vendors for requirements traceability throughout the lifetime of a project, and to navigate online between the design and the requirements. Basic export to Rational DOORS and Rational RequisitePro is included in base products. Advanced bidirectional Rational DOORS and Rational RequisitePro synchronization, impact analysis, coverage analysis, and integration with other authoring tools is included with the IBM Rational Rhapsody Tools and Utilities Add On.

• Rational Rhapsody XMI Toolkit - XML Metadata Interchange imports and exports model information to or from other tools and is part of the Rational Rhapsody Tools and Utilities Add On.

• Systems Engineering Add On provides functions to assist in the development of SysML and Harmony profile projects.


Notes on Add Ons

• Rational Rhapsody TestConductor Add On provides model-driven testing to automate testing tasks; defines tests with code and graphically with sequence diagrams, statecharts, activity diagrams, and flowcharts; and runs the tests interactively or in batch mode.

• Rational Rhapsody Automatic Test Generation Add On is the engine in the Rational Rhapsody Testing Environment that verifies the functionality of the system. It uses the UML model information and the generated source code as the basis for analysis and to create executable test cases.

• Automotive, AUTOSAR system authoring and behavioral design and AutomotiveC profile provides support for development of applications including behavior for AUTOSAR with Rational Rhapsody Developer for C and includes the AutomotiveC, AUTOSAR, and FixedPoint profiles.

• Automotive, AUTOSAR system authoring includes the AUTOSAR profiles for designing AUTOSAR with Rational Rhapsody Architect for Software in the C and C++ languages, and Rational Rhapsody Architect for Systems Engineers and Rational Rhapsody Designer for Systems Engineers.


Specify license path

• If you already have DOORS installed and are using the same FlexLM server to host Rhapsody then select I will supply license information later. If this is a fresh install on stand-alone machine then you may need to use the evaluation license to test the install so browse to this file instead

• Click Next > when ready


Any folders or license servers you specify here will be added to the TELELOGIC_LICENSE_PATH environment variable. If you have any subsequent issues getting a license then this is usually the first place to look

Ready to install the program

• We won’t select a desktop shortcut because we want to launch Designer not Developer. Ensure this is deselected

• Click Install


InstallShield Wizard completed

• Installation will commence and complete (circa 5 mins)

• Click Finish when done (alas, we are not yet finished!)


Post installation changesTHESE STEPS ARE IMPORTANT


Locate the rhapsody.ini file

• Locate the rhapsody.ini file in the Rhapsody installation folder


Locate the rhapsody.ini file

• Click to Edit in Notepad (Note: don’t Edit the ini file while Rhapsody is running and the rhapsody.exe will try and write to it, and you don’t want to corrupt it)


Change the DefaultEdition

• Locate the DefaultEdition property and change it from Developer to SystemDesigner. The DefaultEdition is the edition that is launched when you double-click on a project (.rpy) file in Windows, as opposed to opening a project from Rhapsody

• Exit Notepad and Save the changes to the .ini file


Test the default edition setting

• Browse to the ..\Samples\SystemSamples\TollRoad folder. Double-click the TollRoad.rpy file to open the project in Rhapsody

• Verify from the title bar that Designer for Systems Engineers launches as the default edition (not Developer)


• If your DOORS server performance is poor, you may want to optimize Rhapsody Gateway to speed things up. This requires admin rights to the Program Files (x86 folder).

• For more info see:http://www-01.ibm.com/support/docview.wss?uid=swg21605891

• In order to save to the Program Files run Notepad as an Administrator:

Optimize the Gateway for DOORS


http://www-01.ibm.com/support/docview.wss?uid=swg21605891

• Browse to C:\Program Files (x86)\IBM\Rational\Rhapsody\8.1.3\Gateway\bin.w32

• Open the rg.ini file in Notepad and add the text:

[DOORS]

ProgressiveHierarchyLoading=1

Optimize the Gateway for DOORS

Note: These steps may not be required. However, it is recommended to make them now to avoid known issues.

For more info see:http://www-01.ibm.com/support/docview.wss?uid=swg21605891


Test launching the Gateway

• Save and close the rg.ini file

• Return to the Rhapsody project, right-click in the browser and choose Rational Rhapsody Gateway > Open


IBM Rational Rhapsody Gateway launches

• The Rhapsody Gateway user interface should launch. This is a good test that it is installed and licensed

• Select File > Exit to close it (or click the X in top right to close the Window)


Open the Features for the DefaultConfig

• Return to the Rhapsody TollRoad project and expand the Component category to locate the DefaultConfig configuration nested under the DefaultComponent

• Right-click the DefaultConfig and choose Features

• Click on the Settings tab


Change the Environment setting to Cygwin

• Scroll down to the locate the Environment setting. Change the setting from MVSC to Cygwin

• Click OK

• Locate the simulation tools menu bar. Click the Smart Build icon to invoke the compiler and start the build


Create a new folder

• Click Yes when asked whether to create a folder for the build

• The build should start (you can ignore warnings about animation library that are raised by the linker)


Verify animation toolbar appears

• A console window should appear (don’t close it). Return to Rhapsody and an animation toolbar will have appeared. This indicates the installation is good to go

• Click the red button in the Animation toolbar to close the simulation. The console window should disappear


Duplicate section warnings from compiler

• Removing duplicate section warnings

• When the application builds Rhapsody will link with a library installed. This will work but if there is a mismatch between the compiler used you may get duplicate section linker warnings.


Create Execution Environment

• To remove the warnings you need to recompile the framework with your installed Cygwin compiler version

• To do this choose Simulation > Create Execution Environment


Check that warnings are removed

• Wait for the environment to rebuild itself

• Choose Full Build to rebuilt the TollRoad DefaultConfig

• The Linker warnings are removed because the framework has been compiled with exactly the same settings

• Click the red button in the Animation toolbar to close the simulation. The console window should disappear


Close Rhapsody

• Close Rhapsody (and Save the changes)


Browse to the 8.1.3 start menu

• Open a File Explorer and browse to the Start Menu for Rhapsody 8.1.3

• C:\ProgramData\Microsoft\Windows\Start Menu\Programs\IBM Rational\IBM Rational Tools\IBM Rational Rhapsody 8.1.3

• A number of shortcuts are provided here. For the useful shortcuts we’re going to create a copy on the Desktop and pin to the taskbar to make them easy to launch


Create a desktop shortcut for Rhapsody DiffMerge

• Create shortcut for DiffMerge. Right-click Rational Rhapsody DiffMerge and choose Send to > Desktop (create shortcut)


Create shortcut for Designer Edition

• Locate the Rhapsody shortcut in the 8.1.3 > Rational Rhapsody Designer for Systems Engineers folder

• Right-click the Rhapsody shortcut (in the correct folder!) and choose Send to > Desktop (create shortcut)


Rename shortcut

• Press [Window+D] to switch to the Desktop

• Rename the Rhapsody shortcut to Rhapsody Designer for Systems Engineers

• Right-click and choose Pin to Taskbar


Finally, test the shortcut

• Launch the shortcut your going to use from taskbar to ensure that the Designer for Systems Engineers Edition is launched

• Phew, we’re done. Have a cup of tea ;-)

• Note: Shortcut for launching Designer is –system_designer –lang=cpp
