Prev Next

Hyperlink From Linked Document

Within the text of a Linked Document, you have several options for creating hyperlinks to other objects in the model, and to web pages, Help files, Model Searches and Team Library documents. You can also create links that generate RTF reports or diagram images, so that updates to the linked material can be quickly merged into the Linked Document as a Custom Report.

When you have saved the Linked Document, you can click on the hyperlink to open the linked files or to locate and highlight the object in the Browser window. You can perform all normal operations on the object, including opening any Linked Document that element might have. You can also, within the Linked Document, select a context menu option to update any linked-in reports and diagram images.

Using the Document Drop Action dialog

The 'Document Drop Action' dialog displays when you drag an object from the Browser window onto the Linked Document. This versatile dialog helps you add a number of features to your document, as explained in this table.

If you are creating a number of links of the same type, after you create the first link you can simply press the Ctrl key as you drag the next object onto the document without displaying the dialog. The system creates further links of the same type, until you display the dialog again and change the 'Drop as' option.

Task

Action

See also

Create Hyperlinks to Model Objects

In the Browser window, click on the object (of any type, including a diagram or Package) and drag the object into the Linked Document to the position at which to create the hyperlink.

On the 'Document Drop Action' dialog (if necessary) click on the 'Drop as' drop-down arrow and select 'Insert as Hyperlink(s)'.

Click on the OK button. The system creates the hyperlink, using the object name as the hyperlink text. You can edit this text if you prefer.

Insert an RTF Report on a Model Object

In the Browser window, click on the required element, diagram or Package and drag the object into the Linked Document to the position at which to insert the report text.

On the 'Document Drop Action' dialog, click on the 'Drop as' drop-down arrow and select 'Render as RTF'.

Click on the appropriate radio button ('All', 'User', 'System' or 'Technology') to display the selection of RTF templates you want to choose from, and click on the required template.

Click on the OK button. The system generates the RTF report according to the template, and inserts it at the cursor location.

At any later point, you or another user can refresh the RTF reports in the Linked Document by right-clicking in the document and selecting the 'Update Dynamic Report Elements' menu option. Note that this option will reinstate any text you might have deleted from the inserted reports.

Insert a Diagram Image

In the Browser window, click on the required diagram and drag the diagram into the Linked Document to the position at which to insert the diagram image.

On the 'Document Drop Action' dialog, click on the 'Drop as' drop-down arrow and select 'Insert as Diagram Image'.

Click on the OK button. The system generates the diagram image and inserts it at the cursor location.

At any later point, you or another user can refresh the image in the Linked Document by right-clicking in the document and selecting the 'Update Dynamic Report Elements' menu option.

Using the Linked Document Context Menu

You can also create hyperlinks to model objects within a Linked Document using the context menu. You first select a text string in the document to act as the link text and, in the case of a new object, to act as the name of the element.

Option

Action

See also

Link to an Existing Element

Highlight the link text in the Linked Document, right-click on it and select the 'Create | Link to Existing Element' option. The 'Select Element' dialog displays, through which you browse or search for and select the element to link to.

Select Dialog

Link to a New Element or Diagram

Highlight the link text in the Linked Document, right-click on it and select the 'Create | New' option. A short submenu displays from which to select a specific type of element to create, or a diagram. When you click on an element type, a new element of that type is created.

If you select the 'Create | New | Diagram' option, the 'New Diagram' dialog displays and you can select the type of diagram to create.

If the element type you require is not presented in the short list, click on the 'Other' option to display the 'New Element' dialog, from which you can select the toolset containing the element type to create, and the element type itself.

In each case, the new element or diagram is added to the Package that contains the parent element of this Linked Document. The link text becomes the name of the new object, and in the Linked Document is the hyperlink to that new object.

Create New Elements Add New Diagrams

Link to an Object or Document in the Model

Highlight an appropriate text string to act as the link text, right-click on it and select the 'Create | Hyperlink' context menu option.

The 'Hyperlink Details' dialog displays, through which you specify the type of document or object to link to. Depending on what object or document type you select in the 'Type' field, a small dialog displays to help you locate and select the target. For the location, you can use either full paths or local (path substitution) paths.

In some cases you might not want to have normal text as the hyperlink, but the text of the link itself. In this case, do not highlight any text or, in the 'Hyperlink Details' dialog, type any link text in. The system then inserts the address path or the provided text as the link text.

Hyperlink Target Objects Hyperlink

Using the Ribbon Option

You can also insert a Hyperlink in your document to link to a web page, Help topic or external file.

Click on the point in the document to insert the hyperlink and select the 'Document-Edit > Edit > Insert Hyperlink' ribbon option.

The simple 'Insert Hyperlink' dialog displays, in which you specify the type of document to link to, and the location of the document file. See the Insert Hyperlinks Help topic.

Learn more