File Objects

You can embed any application file in your model or provide a link to it. For example you could include a detailed description of your problematic by pointing to a text or Word file from your model. The file itself can be embedded in the model or referenced by it.

To create a file, drag the File tool and drop it in empty space.

The following properties are available on the Info tab in the General category:

Property

Description

Name/Code/Comment

Identify the object. The name should clearly convey the object's purpose to non-technical users, while the code, which is used for generating code or scripts, may be abbreviated, and should not normally include spaces. You can optionally add a comment to provide more detailed information about the object. By default the code is synchronized with the name. To decouple name-code synchronization, enter a new code in the Code field.

Location type

Specifies the nature of the file object. You can choose from the following:
  • Embedded file – the file is stored within the model and is saved when you save the model. If you subsequently change the type to external, you will be warned that the existing contents will be lost.

  • URL – the file is on the web and you must enter its URL in the Location field

Location

Specifies the path or URL to the file.

Extension

Specifies the extension of the file object. By default, the extension is set to txt.

Generate

Specifies to generate the file object when you generate the model to another model.

Artifact

Specifies that the file object is not a piece of documentation, but rather forms an integral part of the application.

The following tabs contain additional information:
  • Dependencies - Lists objects that the file depends on or impacts.