This User Guide provides instruction for publishing, monitoring the progress, about the publisher, general logging, compatibility and modeling guidelines.
Note: Please ensure that only a single version of Rhapsody is installed on the machine and a single instance is running while publishing.
For definition of user configuration of display settings please refer to the section for Silent Mode.
The publisher provides user indication of progress during the publish. The lower right corner of the GUI shows a status bar while there is also a more detailed view accessed via the "Window" menu item.
The publisher application has menu selections for additional information about the software. The first is the About as shown in the figure below.Accessing the information about the publisher is done by selecting Help ->About MagicDraw SysML Publisher for Rhapsody as shown in the figure below
The GUI For about the publisher shows the legal statements and software version. Additional information aboout the installation is accessed bt the Installation Details button on the GUI as shown below
The Installation Details GUI provides additional information about the following:
Logs are captured during the publish event. These logs are located C:\Users\"user name"\.rhp2md\com.sodius.mdw.interop.rhp_md_sysml\logs
Two log files are generated during a publish.
In order for the publisher to function, the configurations of the tools must match. I.e. 32-bit for Rhapsody, Java, and MagicDraw or they all must be 64-bit configurations.
Rhapsody must be open to automatically populate the user interface. Missing preferences or profiles may cause issues with the transformation.
The MagicDraw SysML Publisher for Rhapsody is available for the following versions:
|Compatibility Matrix||Rhapsody Version 8.2.1||Rhapsody Version 8.3.1|
|MagicDraw Version 18.5|
|MagicDraw Version 19|
The publisher works to create comparable SYSML diagrams in a MagicDraw project. There are differences in how the tools use and display information associated with their respective SYSML profiles. Therefore the following transformation requirements and rules apply for each element as defined below.
|To display or not to display||It is impossible to map all display options one for one between the tools. Therefore, defaults are set to show information on the elements of diagrams, these options are set focusing on preserving spacing and alignment or based on customer feedback. (General Readability) Sodius-Willert provides a service to modify these settings for our customers until we have an implementation that allows the user to define their own styling.|
|General Shapes and Colors||The transformation does not include colors assigned to element or general diagram shapes that are not contextually linked to the model (i.e. boxes, ovals, text boxes, etc)|
|Pictures/Images||The publisher does not transform pictures or images used in diagrams in place of the profile notation. Use the features of the profile to define the capability.|
|Hyperlinks||The publisher converts hyperlinks to text instead of active links. This capability is planned for a future release.|
|Tables/Matrices||Tables and Matrices are not implemented in the publish. These will need to be exported and imported into the resulting model using existing features in MagicDraw|
|Panel Diagrams||Panel Diagrams are not defined by the SysML standard and are not transformed|
|Automatic Resizing||For most element types we can select to turn off automatic resizing when we publish to ensure that sizing is comparable on the publish but it is best to ensure the text displayed on elements is not cut and spacing is not showing overlapping elements in the source model.|
|Diagram Frame Automatic Resizing||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.|
|Diagram Frame Settings||When the "Show Diagram Frame" property is set to true, the following guidelines and information pertain to each diagram type as defined below:
|Unassociated Constraints||In Rhapsody you can display a constraint that is not tied to an element in anyway. This is not allowed in MagicDraw. Transformation of this constraint converts the constraint to a note.|
|Actors with attributes||MagicDraw doesn’t allow attributes to be defined for Actors. Therefore those elements in Rhapsody convert to Blocks in MagicDraw in order to retain the information through the publish.|
|Connectors and Proxy Ports||You cannot have a connector connecting two proxy ports withinthe same block. Proxy ports define external interfaces for blocks|
|Line Jumps||Rhapsody doesn’t have an option for line jumps displaying when lines cross on the diagram. MagicDraw has this option|
|Diagram Connectors become Merged Nodes||Diagram connectors are a feature not available in MagicDraw. The connector is used to route lines across the diagram by creating wormholes to another location on the diagram. These are currently transformed to a Merged Node.|
|Include/Extend relationships||These display differently between the tools: In MagicDraw there isn’t the label on the line for Include or Extend, it is a specific line type. The tool transforms the content as needed for MagicDraw but in order to display these labels on the diagram we create a rhapsody stereotype and display that.|
|Directed Associations:Use Case to Actor||You can modify an association in Rhapsody from a Use Case to an Actor (One End). MagicDraw requires the relationship defined at both ends. The publisher has a fix to identify these relationships and transform them appropriately.|
|SendAction/Send Signal Action Tool Difference||
|Destruction Events||MagicDraw does not have destruction events in Sequence Diagrams in SysML. The publisher converts these to the closest approximation which is a delete message. But the delete message cannot be put into an operand the same way a destruction event would. Recommendation is to create to different sequence diagrams for the operand conditions and to use delete messages in magicdraw where needed|
|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.|
|State Machine Diagram Transition Behaviour||There is different content that can be displayed depending on user preference.|
|Graphically added property/part owner||
|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.|
|IBD owned by a Use Case results in empty IBD||Rhapsody allows definition of an IBD owned by a Use case. These IBDs transform to empty because the diagram does not have any “context” when the IBD is owned by a Use Case - and an IBD can only be owned by a Block|
|Pakage Diagram Display option Defaults set||Containment lines are defaulted to on.|
|Paramentric Diagram Property/Part owner is graphically added|
|Notes on Performance||It is important to only run a single publish at a time from an 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 FOQ sections of the Administration Guide.|