Using the Specification Manager

When you begin working in the Specification Manager, there are three general areas of activity you work through:

Setting up the Specification Manager to suit your work requirements
Creating and/or organizing the elements in the View
Performing whatever work you need to do on the elements
 

The Specification Manager is extremely versatile, and you can use it very simply to create a set of basic elements or at varying levels of complexity to develop and manage those elements in your project, as you need.

Initial tasks

Task

Action

See also

Specify the type of element to work on

Either:

Work with the default (all element types) or
Select a specific type of element
 

You specify the element type first because when you come to browse for or select the Specification Package, if you have specified a particular element type the system automatically filters the Package selection to only those that contain elements of that type.

 

Select Specification Type

Select the Package to work in

Either:

Work with the default Package
Select another existing Package in the model, or
Create a new Package in the model
 

Select Specification Package

Set up List Header and Filter bars

Use the Field Chooser dialog to organize the columns that contain the type of information you want to work with.

Some of the columns contain indicators that represent records and documents associated with an element. You can access the item represented by an indicator, by clicking on it.

 

Customize Columns

 

Indicator Columns

Configure the display

As you begin, or at any other time in your use of the Specification Manager, you can change the appearance of the display to, for example, display any hierarchy of Packages under the selected Package in a separate panel, use smaller or larger text font, partially or totally hide Notes text, or show the element names in bold.

You can further configure the display and the element definition by including level numbering, automatic naming and Project Glossary entries, and by applying customized properties such as additional Requirement Types and Tagged Value Types.

 

Specification Manager Configuration

Organize elements

Task

Action

See also

Add new elements

Create new elements in the model as direct members of the Package or as child elements of those members.

 

Adding Elements

Delete elements

You can filter out elements from the display by type or according to the value of various properties. However, if an element does not belong in the Package and model, you can delete it completely.

 

Deleting Elements

Reorganize elements

The Specification Manager reflects the sequence of elements in the Package as shown in the Project Browser.

To put the elements in the Specification Manager in a different order, move them in the Project Browser.

 

Move Objects Within a Package

Review the elements

Task

Action

See also

Create and Review Relationships

You can examine existing relationships and create new ones using the Relationship Matrix, creating and using specific Matrix Profiles.

You can also review existing relationships by opening the Traceability window, either from the Toolbar or by double-clicking on the blue arrow displayed in the Relationship and All Indicators columns. If the element has no relationships, the blue arrow is not shown.

 

Create Matrix Profile

Open Relationship Matrix

Traceability

Discuss and review elements amongst project members

It is possible to create review documents and have recorded text message discussions on the development of your elements, using the Team Review, Element Discussion and Model Mail facilities.

If an element has an existing Element Discussion, this is represented by a 'speech bubble' icon in the Discussion and All Indicators columns. You can open the discussion by double-clicking on that icon.

 

Reviewing Elements

Create Review Document

View Review Document

Make, Review and Manage Changes

You can easily view and edit elements directly in the Specification Manager or by displaying the appropriate window such as the Properties window or Tagged Values window.

You can also monitor changes to the selected Package or element made anywhere in the system, using the Baselines and Auditing Facilities.

Further, you can manage changes made by other users, opening the Project Management window to quickly assign resources and risks to the work on the element. You can review work on the elements in the Package by displaying the Specification Manager in another tab in the form of the Project Gantt chart.

Maintenance and Testing are integrated and easily available to help improve software quality from the beginning of your project.

Existing records of these items are indicated by icons in the corresponding column, and can be quickly opened by double-clicking on the icon.

 

Editing Elements

 

 

 

 

Managing Changes

 

 

 

Indicator Columns

Print the list of entries

A print-out of the Specification Manager element list is a document containing a simplified version of the screen display:

All elements are included, both parent and child elements
The columns are narrowed to fit the page width (if necessary)
The indicator icons are not printed
The font size and type face are uniform across the report
The document begins with a Table of Contents
 

To generate the print-out:

1.Click on the Print as List icon in the Toolbar and, in the Print dialog, specify the printer settings you require. (The Generate Documentation dialog might briefly display before being replaced by the Print dialog.)
 
2.Click on the Print button to print the list.
 
 

 

Generate reports

If you should need to extract and/or publish the information in the Specification Manager, you can do so in a range of forms such as:

Generating standard or customized document reports in RTF, DOCX or PDF format
Publishing on the web in HTML, or
Exporting to a spreadsheet tool in CSV format

 

Reporting

Notes

As you work on the information on the Specification Manager, periodically press F5 to refresh the view to include any updates performed by other users elsewhere in the system
In the Corporate and extended editions of Enterprise Architect, a User Security system can be applied that restricts or enables access to a range of operations and functions; if you cannot access a function in the Specification Manager, check with your System Administrator or Security Administrator to see if you have access permissions to work with that function