Artifact Toolbox, Enterprise Architect, Artifact element

Artifact (Base)

A Base Artifact defines the external artifacts used in a process and the internal artifacts generated in the process, such as model files, source files, database tables, development deliverables or support documents. The files represented by the Artifact are listed on the 'Files' tab of the Properties window for the element.

To open the files represented by the Artifact, click on the element on the diagram and press Ctrl+E. Each file is opened either on a separate tab in the Diagram View workspace (if the file can be opened within Enterprise Architect) or in the default Windows viewer/editor for the file type (if the file cannot be opened within Enterprise Architect).

Files can also be launched individually from the 'Files' tab (opening in the Windows default editor), as for elements of any other type that have associated files.

Toolbox Icon

Checklist Artifact

A Checklist Artifact provides the facility for generating a list of items, each with a checkbox, to be used as a checklist. You can set each checkbox to default to being selected or unselected, and set all selected options to be grayed out or struck through, so that the unselected options are more prominent. The end users can then work with the element to tick off items that have been obtained or activities that have been completed.

A version of this Artifact - the Requirements Checklist - is available in the 'Extended Requirements' Toolbox page. This automatically contains ten characteristics of a good Requirement, for a Requirement author to tick off as they check that their Requirement has been set up to show those characteristics.

Toolbox Icon

Document Artifact

A Document Artifact is an Artifact having a stereotype of «document». You create the Document Artifact using the Artifacts, Component, Documentation or Deployment pages of the Diagram Toolbox, and associate it with an RTF document or CSV file.

Double-click on the element to display the Linked Document Editor. When you have created the Linked Document, the Document Artifact element on the diagram shows an 'A' symbol in the bottom right corner.

Toolbox icon

Encrypted Document Artifact

An Encrypted Document Artifact is used to create and hold a Linked Document that is automatically encrypted, and that cannot be opened and automatically decrypted within Enterprise Architect without entering a password. You can therefore use the generated Artifact element to record sensitive information, which you protect from general access by assigning a password.

When you drag the 'Encrypted Document' icon onto the diagram from the 'Artifacts' page of the Toolbox, a prompt displays to type in a password. When you enter the password, you can create the Linked Document. Thereafter, if any user attempts to open the document, the same password prompt displays. If the user does not provide the password that you originally specified, the document will not open. If the correct password is provided, the document is decrypted and opened.

The Encrypted Document Artifact is indicated in the Toolbox page, diagram and Browser window by a red 'document' icon - .

Working Set Artifact

A Working Set Artifact defines a Working Set that opens various windows, diagrams and views, recreating a work environment that you frequently use.

• To create or modify the Working Set, right-click on the element and select the 'Edit Working Set' option
• To execute the Working Set to open the defined windows and views and execute any commands, double-click on the element

Toolbox icon

Executable StateMachine Artifact

An Executable StateMachine Artifact is the vehicle through which you can generate, build (compile) and execute - via simulation - code for a StateMachine or complex of StateMachines.

Each StateMachine is the child of a Class element; when you drag the Class from the Browser window onto the Artifact element, it is pasted inside the Artifact as a Part. You can paste several Classes - and, therefore, Parts - into a single Artifact.

Having set up the Executable StateMachine Artifact, you use simple context menu options on the Artifact to perform the code generation, build and execution operations on all StateMachines bound within the Artifact.

Toolbox icon

Matrix Specification Artifact

A Matrix Specification Artifact encapsulates a Relationship Matrix Profile definition. When you have created the element on the diagram, you double-click on it to display the 'Matrix Specification' dialog, in which you create the Profile definition. The Profile takes the name of the element. The profile defined in the Artifact is independent of the Package that contains the Artifact element, and therefore could specify source and target Packages other than parent Package.

After you create the Profile definition, each time you double-click on the Artifact element the Relationship Matrix displays with the Profile applied.

To edit the Profile, right-click on the Artifact and select the 'Documentation | Edit Matrix Profile' option.

Toolbox icon

Report Specification Artifact

A Report Specification Artifact encapsulates a report definition. When you have created the element on the diagram, you double-click on it to display the 'Generate Documentation' dialog, on which you enter the report parameters and, if required, generate the report.

After you create the Report Specification, each time you double-click on the Artifact element the 'Generate Documentation' dialog again displays with the same report parameters. You can continue to generate the same report, or alter the parameters if necessary. If you change the parameters, they are re-presented until such time as you change them again,

Toolbox icon

User Story Artifact

A User Story Artifact provides a means of documenting a business Use Case, in the context of Agile methodologies such as Extreme Programming (XP). In the Linked Document, you define the functions a business system must provide; it captures the 'who', 'what' and 'why' of a requirement in a simple, concise format. The User Story Artifact behaves as a Document Artifact, prompting you to select a Linked Document template to base the document on.

Toolbox icon

Standard Chart Artifact

A Standard Chart Artifact provides the facilities for generating a Pie Chart or Bar Chart on an aspect of the data in your model. It adds three 'Chart Details' tabs to the standard tabs of the element 'Properties' dialog.

After you have added the element to your diagram, double-click on it. The element 'Properties' dialog automatically opens at the 'Chart Details - Source' tab. Define the chart type and data source, then go on to define any filters you want to apply, and how the chart should display.

Once you have defined the chart, it automatically displays with the latest information whenever you open the parent diagram.

Toolbox icon

Model View Artifact

A Model View Artifact provides the facilities for generating a tabular Model View Chart on a segment of the data in your mode, extracted using a custom SQL search.

After you have added the element to your diagram, double-click on it. The element 'Properties' dialog automatically opens at the 'Chart Details - Source' tab. Define the SQL Search to extract and tabulate the information.

Once you have defined the chart, it automatically displays with the latest information whenever you open the parent diagram.

Toolbox icon

Time Series Chart Artifact

A Time Series Chart Artifact provides the facilities for generating a linear graph of a model property over time.

After you have added the element to your diagram, double-click on it. The element 'Properties' dialog automatically opens at the 'Chart Details - Source' tab. Define the Package from which the data is to be extracted, and the time interval over which the data is to be sampled. Then go on to define the appearance of the chart.

Once you have defined the chart, it automatically displays with the latest information whenever you open the parent diagram.

Toolbox icon