Creating hyperlinks

IBM® Engineering Systems Design Rhapsody® supports both internal hyperlinks, which point to Rhapsody model elements, and external hyperlinks, which point to a URL or file.

Procedure

  1. In the model browser, right-click the element to which you want to add the hyperlink, and select Add New > Relations > Hyperlink.
  2. Select the new hyperlink and use the pop-up menu to open the Features window.
    Note: You cannot open the Features window by double-clicking the hyperlink. Double-clicking takes you to the target of the hyperlink.
  3. Specify the target for the hyperlink.
    Note: You can use a relative path as the hyperlink target. If you use a relative path, the base directory is the one where the .rpy file for the project is located.
  4. Specify the text to display for the hyperlink.
    Note: If the target of the hyperlink is a tag element, you have an additional option of using the value of the tag as the display text.
  5. Specify any stereotypes that you want to apply to the hyperlink.
  6. Use the Description tab to provide a description for the hyperlink.
  7. Click OK.

Results

The hyperlink is added to the Hyperlinks category under the owner element. The icon that is displayed for the hyperlink reflects the type of target selected.
Browser showing hyperlinks
Note: You cannot rename a hyperlink in the browser. You must open the Features window to do so.

Creating hyperlinks inside element descriptions

You can create hyperlinks inside the description of an element. Hyperlinks created in an element description are not model elements and cannot be viewed in the browser or accessed by the Rhapsody API.

Procedure

  1. Open the Features window for the element.
  2. On the Description tab, right-click in the text field and select Hyperlink....
    The Hyperlink window is displayed.
  3. Enter the target for the hyperlink.
  4. Enter the text to display for the hyperlink.
  5. Click OK.
    Note: You can later edit the hyperlink by right-clicking on it and selecting Edit Hyperlink....