Skip to end of metadata
Go to start of metadata

The link editor is used when creating references in documentation fields and profiles and hyperlinks in diagrams and views. The details of the reference are specified in this window. 

You can create references to websites, external files, and other elements in the model package, but it is also possible to create links to send an e-mail message.


The link editor


The Link denotes information on the link itself, like the address of the web page, location, and name of the file, model object number, or "mailto" address. The Name denotes what users will see as a description in the hyperlink object in the diagram or view, in the documentation field, or in the profile reference.

You can either type the reference details manually or use the reference buttons in the editor to add a specific reference.

Reference maintenance

All links created with the link editor can be viewed and maintained easily using the Link table.


On this page:


Create a reference to a file

Click the File button to create a reference to a locally stored file or file on the network. You can basically link to any file format. After clicking the button, navigate to the file and open it. The Link box is filled with the location and name of the selected file, Name is filled with the name of the file.


Example of a reference to a file

Reference to a graphical file

If the file is of a graphical format, you can choose to embed the file in an RTF or InSite Lite report by selecting the Embed target in reports check box. If embedded, the actual picture instead of the link will be included in the report when you create the report of the model. The following graphical file formats are supported to include:


InSite Lite report:

BMP, JPG, JPEG, GIF, PNG, WMF, EMF

RTF report:

BMP, JPG, JPEG, GIF, PNG, WMF, EMF, PCX, TIF, TIFF

Reference to document bookmark

You can also refer to locations or bookmarks within a document. Insert bookmarks within your document and add the name of the bookmark to the URL, preceded by a #. Example:


Q:/public/data/instructions/scanning.doc#namebookmark

Create a reference to a web page

Click the Web Page button to create a reference to a web page. After clicking the button your web browser is opened. Navigate to the desired web page. The Link box of the link editor will be filled with the selected web page, Name will be filled with the title of the file.

Alternatively, you can just directly enter the name and de URL of the website in Name and Link.

When working with Enterprise Studio Online (the cloud solution), creating a reference to a web page is only possible by directly entering the name and URL.


Example of a reference to a web page

Create a reference to a model object

Click the Model Object button to create a reference to an object in the model package. Such hyperlinks can be added to almost all graphical objects in the tool. If you want, you can add more than one hyperlink to objects.

After clicking the button, search the object in the object selector, and select it. After selection, the Link box of the link editor is filled with the internal number of the selected object, and Name is filled with the title of the file.


Example of a reference to a model object

Create a reference to send an e-mail message

Click the E-mail Link button to create a reference to send an e-mail message. After clicking the button, the E-mail Link window appears in which you set up the e-mail message that must be generated. Enter the desired details of the e-mail message, like the recipient's e-mail address, a subject, and message body text.



When you are finished, the Link box of the link editor is filled with the "mailto" address. You still need to add a description in the Name box.


Example of a reference to send an e-mail