General Modeling Guidelines
For the general cases not specific to a single diagram type the following general guidelines apply to all diagram types
- The publisher does the best approximation with the differences in the default structure and logical grouping between the tools.
- Consistent Identification
- The publisher maintains consistent identifiers through publish event. This means that the user can compare two publishes of the same model and identify the differences in the target tool. However, there are several Elements where the order is not guaranteed on the interface when exported by the source tool. The publisher can not resolve those differences for these Elements.
- SodiusWillert License Manager requires a Windows operating system. Other operating systems are not supported. This is due to the FlexNet licensing schema.
- Only one version and instance of the source tool should be installed and running on the publishing machine. This ensure no conflict on the interface.
- Notes on Performance
- It is important to only run a single publish at a time from a single open Rhapsody project.
- If the cancel is selected in the middle of a publish, ensure the cancel request is completed before starting a new publisher.
- For memory allocation adjustments please refer to the troubleshooting or FAQ sections of the Administration Guide.
- Diagram Connectors
- Diagram connectors are a capability only of the source tool and are not available in the destination tool. Diagram connectors are transformed to a Merged Node. Recommendation is to remove diagram connectors prior to publish.
- Diagram Resizing and Distortion
- Restrictions exist for how close items can be together in the target model as well as automatic resizing and spacing are applied. Defaults available for modification are set using the
Defaults have been set to mitigate the distortion to the relative size and placement of the elements
- On certain diagram types, we have defaulted the Diagram Frame to off to avoid sizing distortion and justification issues in the published canvass. This can easily be turned back on after publish. (right click on the diagram and select Show Diagram Frame in MagicDraw.
- When an Element is displayed on a diagram and the text within that Element requires more space than available in the element size, the target tool resizes the element on the display to show all text.
Version 19, service pack 3 provides a property where the publisher can negate the automatic resizing.
When set, the Element in the target tool with maintain sizing and crop the text. When the text is cropped the target tool places a dashed blue line around the Element as shown in the figure below.
- Display Options
- There are millions of possible ways the user can select to display elements on diagrams both in the source and destination tools. Some of this information is available on the interface and other is not. Therefore the publisher provides a properties.ini file located the installation directory where the user can adjust the default settings. We are constantly adding more capabilities to the properties.ini file allowing the user more flexibility with the resultant display.
- Free Shapes, Colors, Fonts
- Colors and FontsThe publisher does not map colors or fonts. This is a future enhancement planned on the development road map.
Free ShapesThe publisher does not publish free shapes because the source tool does not provide this information on the interface.
- Hyper links
- Implementation of hyper links in the source and destination tool differ. Additional enhancements are in progress for hyper link functionality.
- The publisher will not publish pictures or images used in diagrams in place of the profile defined notation.
- Line Jumps
- The destination tool provides the capability to display line jump notation when line crossing indicating no interaction in that crossing. The source tools does not have this feature.
- Names and Labels
- Having a Name and Label is not an option in the target tool.
The user interface provides the following selection to change the name of the Element to its Label:
- Keep element name where the Label will become a Tagged Value, or
- Change element name to label value, which overwrites the Name with the Label.
- Panel Diagram
- Panel diagrams are a capability of the source tool and not published.
- Red Connector Lines
- When red connector lines are shown in the published model you can right click on the “x” and select “Update Connector Ends” from the menu. The connection errors may also exist in Rhapsody prior to publish. Ensure the connectors have defined ends prior to publish.
- Round Tripping
- The publisher off-the-shelf supports the transformation/publish one way.
Round-tripping is a difficult case to support as there are multiple Interpretations of capability for SysML/UML between the tools.
Also, what is provided on the API is not the same or complete between the tools. Moreover, customer style and preference are hard to capture consistently with a common standard mapping. There are detailed modeling guidelines in the User guide because of the differences.
Please let us know if round-tripping is a critical use-case to make your team successful.
- The publisher does not publish tables or matrices. The source and target tool provide capabilities to export and import tables and matrices.
- For Local Tags, a new Profile called
packagename_TAGS is created
The element having the Local Tag is stereotyped
A tagged value called
localtag is attached to the Stereotype
- Un-associated Constraints
- In the source tool you can display a Constraint that is not tied to an Element in anyway. This is
not allowed in the target. The publisher transforms these Constraints to Notes.
- Virtual Operations/Functions
- Rhapsody provides a means to define an operation as
virtual This is a carry over from
UML where you would define a virtual function that the inherited classes would utilize but
with different parameters (usually in a table). Since this concept doesn’t necessarily apply
to system level context it is not available in MagicDraw.