IBM Engineering Rhapsody Tip #101 - Transition Label toolbar tips and tricks

This is one for those Rhapsody cureos out there, as it is something that I only recently discovered (like this week!) and I think is genuinely useful, which is the ability to add a Transition Label tool to the activity diagram (which does not have it by default). The video first shows how the Transition Label tool works on statecharts (state machine diagrams) and then goes on to how it can be added to the default activity diagram toolbar. Arguably it's even more useful for the activity diagram as it removes clicks when adding guards to transitions coming out of a control flow. Anyway, I'll let you decide. Have fun.

Here's the transcript for those that need it:

I was recently documenting the drawing toolbars for some client docs, and my attention was drawn to the statechart's Transition Label tool (I've rarely used).

When you first draw a transition between states, you get a "first time" opportunity to type its text. Feature like Intellivisor (Ctrl+Space) are available.

If you don't type anything then you lose the opportunity.

Options are to right-click and use Select Trigger to select a trigger (which you can then edit). More commonly users will open the Features General tab for the transition to enter the information.

The Statechart's Transition Label tool enables you to get edit mode back on a transition with no text. When you click on a transition with no text, the Transition Label tool gives you the text editor back.

The Transition Label is a useful tool in the Statechart's armoury therefore, so why not make it a useful tool in the Activity Diagram toolbar as well?

One of the side effects of moving to online delivery of my training has been that I get to watch people's screens when they're using Rhapsody.

A common task in activity modeling is putting guards on control flows coming out of decision nodes using the Features window. It's a bit of a faff to be honest.

The Activity Diagram drawing toolbar does not have a Transition Label but why not add it, I thought?

As no other customizations are present, I'll quickly show it works by locally overriding the General::Graphics::ActivityDiagramToolbar property. Here it is! and it works!

Since I rarely use Rhapsody without customisations, I've just added it to the textual activity diagram toolbar in my ExecutableMBSEProfile. This diagram is based on a new term stereotype. Its toolbar is defined using different a different set of properties (I update these using a metamodel & associated profile nowadays).

I can complete the diagram without using the Features window now! How cool is that? ;-)

Interested in Rhapsody training/customizations then feel free to email me.

Update to create V13 of IBM Rhapsody UML/SysML training material

Having left IBM as technical specialist for Rhapsody in 2015, I have been creating and delivering my own training material specialising in Rhapsody. I've just worked my way through a update cycle to create a Version 13 of my material. Key updates were:

- Re-naming of labs to reflect the more common order I've been settling on for delivery. This involves making sure most valuable/popular labs are given focus in initial choices for a 3 day delivery.

- Added a bit more differentiation to the Rhapsody Gateway labs with DOORS and Microsoft Word by making customisation of the Gateway Type an extension exercise at the end (i.e. still got expert tips and tricks but can also be used with simple users who don't need the expert bit).

- I simplified / shortened the sequence diagramming to make it shorter but retain the core knowledge (as the latter can be a bit heavy going for users completely new to SysML/UML).

- Added more differentiation to the ports and interfaces lab to make the conversion to proxy ports an extension exercise at the end (i.e. still got expert tips and tricks but can also be used with simple users who don't need the expert bit).

- Validate the material against IBM Engineering System Design Rhapsody Version 9.0.1 Editions with Jazz 7.0.2 server / DOORS 9.7.

The following is an example of a 5 day delivery for software engineers (and systems):

Mastering IBM Engineering Rhapsody in C++ - Sample Agenda V13 - 5 day (incl. Test Conductor)

Day	Description
Day 1 (Core)	Rhapsody user interface essentials and advanced ·         Focused understanding on controlling Rhapsody user interface. ·         Understand how projects are stored and how to open them. ·         Controlling the user interface to navigate around projects ·         Moving around and zooming in and out of diagrams, incl. full screen. ·         Navigating between elements, e.g., structural to behavioural. ·         Appreciation of delete from model vs delete from diagram. ·         Appreciation of how set-up effectively with profiles and properties.   Use Cases and requirements ·         Creating a model from scratch, including properties and profiles.	Practical Labs: Lab A1: Controlling the Workspace Lab A2: Controlling the browser Lab A3: Creating a use case diagram Lab A4: Use case activity modeling Lab A5: Features and Zoom toolbar (ext)
Day 2 (Core)	Requirements and tables/metrics ·         Understand Rhapsody’s integrations with requirements managed via Gateway synchronizer (Word, Excel, “classic” DOORS) and/or ·         Overview of IBM Jazz platform and remote requirements (demo); OSLC links to Jazz, RTC Eclipse, accessing models by web-client for review purposes etc. ·         Requirement traceability essentials. ·         Appreciation of tables and matrices and what they are used for.   Composite structures ·         Understanding relations in UML/SysML: composition, association, generalization, aggregation, dependencies. ·         Controlling compartments and associated display options. ·         Tips for getting diagrams out of Rhapsody quickly and printing. ·         Linking elements with hyperlinks and enabling quick navigation. ·         Searching projects and using queries to filter the browser.	Practical Labs: Lab B1: Rhapsody Gateway with Word Lab B2: Rhapsody Gateway with DOORS Demo: DNG/Jazz demo. Lab B3: Properties and Profiles Lab B4: Requirement tables and matrices Lab C1: Modeling structure Lab D3: Searching and Linking (ext)
Day 3 (Core)	White-box and architectural modeling ·         Understanding use of composite structure for hierarchical decomposition of systems, including ports, parts, and connectors. ·         Sequence diagram modeling for defining interfaces. ·         State-machine modeling and animated sequence diagrams. ·         Understanding state-chart syntax: Nested/Parallel states and patterns for usage. ·         Understanding difference between port types, pros and cons.	Practical Labs: Lab C2: Interaction modeling Lab C3: State machine modeling Lab C4: Ports and Interfaces Lab D1: Elaboration Use Cases Lab D2: Executing System Behavior
Day 4 (C++ Case Study)	Code generation workshop in C++ ·         Understanding model-driven development with code generation by building up a working example in C++. ·         Using Rhapsody Model Manager / DOORS NG. ·         Appreciation of dynamic-model code associativity. ·         Appreciation of requirements capture and traceability. ·         Appreciation of Object Execution Framework and state-charts.	Practical Labs: Lab S1-17: Building a model
Day 5 (C++ Case Study)	Test Conductor ·         Workshop using TestConductor with a model. Catch-up/overflow topics: ·         An of how projects can reference other projects. ·         An appreciation of how project units work in conjunction with Model Manager, role of Rhapsody DiffMerge etc. ·         An appreciation for options for document generation and html output.	Practical Labs: Labs S18-S20: Test Conductor workshop Lab U1: Navigating Rhapsody Units Lab U3: Referencing External Units Lab U4: Handling Unresolved References Lab U5: Rhapsody DiffMerge

 

Changes logs for SysMLHelper profile V4.0.b-V4.0.m now listed

For the last year, I've been re-writing the SysMLHelper to move functionality to the newer ExecutableMBSE profile model structuring method (using new term packages). I've just posted the enhancement list to my other blog, in case you're interested:

Making Executable MBSE fun with IBM Rational Rhapsody

It is a fairly big re-write, particularly with the way that the profile is architected, including the inclusion of a metamodeling profile that I created, and improved protection when using multiple Rhapsody instances and avoidance of passing Rhapsody elements between Java threads.

Current version is 4.0.m. However, I've held off posting profile to Github; choosing instead to work with clients and contacts directly so that I can improve it with a real focus on usage. 

Model Based Risk Analysis with RAAML in IBM Engineering Systems Design Rhapsody

This looks interesting. Basically Andy L has developed a Risk Analysis and Assessment Modeling language (RAAML) profile for Rhapsody based on an OMG spec that supports:

• FMEA (Failure Modes and Effects Analysis)
• FTA (Fault Tree Analysis)
• GSN (Goal Structuring Notation)
• ISO26262

It's hot off the press, and I've not had chance to look in detail myself, but things Andy does are usually good, so it may be worth investigating if you're in that way inclined:

https://jazz.net/blog/index.php/2021/10/20/model-based-risk-analysis-with-raaml-in-ibm-engineering-systems-design-rhapsody/

IBM Engineering Rhapsody Tip #100 - An example of a general belly tickle problem

This is another one of my short, and silent, IBM Rhapsody tips and tricks videos. It actually came up in my tool training this week, as creating generalizations between the use cases and finding them in the browser, is part of one of my labs. The problem is sort of a user error, in that new users often press Delete on a diagram, and forget that a relation still exists in the model. When you do this because you've drawn an OO generalization relation the wrong way around, and then attempt to draw the generalization in the correct direction, then you get an error message from Rhapsody saying that you can't add a relation as it will create a cyclical relation in the inheritance structure. To fix the issue you can complete relations to populate the relation on the diagram and then properly delete it from the model, before redrawing.

Here's the transcript:

This is one of my "quickie" quick tips for IBM Rhapsody. The issue came up in my tool training delivery again this week, hence I've turned it into my video tip #100!

It's silent so you have to reeead tttthhhhe teeeext!

This "user error" basically relates to Rhapsody cleverly detecting that you're trying to add a cyclical generalization relation.

To demonstrate, I'll first add a couple of use cases and a generalization relation between them.

What I want to say is that "Give a belly tickle" is a specialization of a more general "Give a tickle" use case. 

Oops, I've drawn it the wrong way around! I'll press Delete so that I can draw it again.

Rhapsody stops me from doing this as it detects that this would create a cycle in the inheritance structure (which is illegal and would cause nasty issues).

Well, we all know why, of course? 

On a diagram, pressing Delete removes from view, it doesn't delete from model (so the relation still exists).

Tip: If we want to know if there are relations in the model not populated on a diagram then you can use the Layout > Complete Relations menu.

This will populate relations that exist but not shown. It's a good way to check for unexpected relations.

To really delete then we should choose Delete from Model from the right-click menu and we can then draw the relationship the correct way around, i.e., Give belly tickle "is a" Give a tickle use case ;-)

Tip #2: If you hold down Ctrl key and press Delete on the diagram, then it will Delete from model. When you Delete from model then you get a confirmation dialog. This is good way of knowing that you really are deleting.

Aggregated feedback from most recent Rhapsody training

The following is the feedback from my last IBM Engineering Rhapsody training using V12 of my material (mainly to software engineers + some systems/research), where 5 = Strongly agree, 4 = Agree, 3 = Neutral, 2 = Disagree, and 1 = Strongly disagree.

What did you like most about the training/other feedback?

• Drilling the concepts through "labs"
• Technically involving course. Fraser is very knowledgeable on the topics and is happy/ready to answer and help with any questions.
• Really good & detailed resources, instructor very knowledgeable, easy to follow exercises
• Practical labs and engagement were good.
• Lab work
• Hands on experimenting on Skytap virtual machine very useful. Having a cleanly setup environment with all the notes and lessons ready is great.
• Doing the labs
• Thank you.  As a last minute addition to the course, with no prior knowledge or expectation, it was clear and all very interesting.
• It was a great course

Aligning IBM Engineering Rhapsody client with your Jazz server for Rhapsody Model Manager usage

Generally, it's important to align your IBM Engineering Rhapsody client with your Jazz server for Rhapsody Model Manager usage. This is a useful link to an IBM page that says which Rhapsody version aligns with which Jazz product:

Rhapsody and Rhapsody Model Manager integration (ibm.com)