Model-base artifact reference
References allow you to add resources include files and URLs that you want to associated with a model. After you have added the references, you can open them in the tool with the default application/web browser whenever you need them.
Opening References
To open references, open the open specification dialog box of the model, select the References page.
Select one or more references in the table and click on the
Open... button.
Alternatively, click on the
References resource of a shape and select a reference from the popup menu.
The selected references will be opened by the default applications or web browser.
Adding Referenced File
To add a referenced file, open the open specification dialog box of the model, select the
References page and click the
Add File... button.
Alternatively, click on the
References resource of a shape (located at the lower left corner of the shape, with a shortcut arrow icon) and select
Add File... from the popup menu.
Using either method, the reference details pane will be shown. Specify the file path in
Path or browse by clicking the
... button. You may optionally provide a description for the reference in
Description.
Adding Referenced URL
To add a referenced
URL, open the open specification dialog box of the model, select the
References page and click the
Add URL... button.
Alternatively, click on the
References resource of a shape (located at the lower left corner of the shape, with a shortcut arrow icon) and select
Add URL... from the popup menu.
Using either method, the reference details pane will be shown. Specify the
URL path in
Path and you may optionally provide a description for the reference in
Description.
User Path
A user path is a variable that refers to a base path in user’s computer. You can add a reference to local file using user path so that the reference refers to a file relative to a user path, instead of an absolute path. This means you can move references files to a different location, or even to a different computer, and can still open them as long as the user path value is up-to-date.
To configure user paths, select menu
Tools >
Options.... Select the
User Path category in the
Options dialog box.
To add a user path, click
Add..., and then enter the name and path in the
Add User Path dialog box.
To edit a user path, select it in the table and click Edit..., and then edit the name and path in the Edit User Path dialog box.
To remove user paths, select unwanted user paths in the table and click Remove.
Show user path – Select to show user paths in references, instead of displaying resolved absolute paths. A user path is displayed with its name enclosed by ${ }.
Prompt to specify user path – Select to enable prompt for user path after adding a reference to file whose base path is not defined as a user path.
Resources