Design Element

What are Design Elements?

A Design Element is an individual component of the solution design.

Design Elements can reference Requirement Elements and an Ensure Traceability Tool exists within the Design Phase of the Phase Progression to help highlight omissions and fix any missing references.

Design Element Properties

Name Description Possible Values
ID Unique Element reference number. Number - Generated by the application.
Solution Description Full description of the Design Element. Text.
Requirement References Traceability links to Requirement Element's of the Requirements Specification. Selection of Requirement Elements references.
Attachments Files in support of the Design Element. List of Attachments.

Locating Design Elements

Design Elements can be located in the following Documents:

Document Can Manage
Design Specification
Build Approach Plan
Test Approach Plan
Implementation Approach Plan

Managing

Design Elements may be edited directly in the TreeList. Single-clicking on a cell of the currently selected item will put that cell into "Edit Mode". Double-clicking a cell of an item that is not currently selected will achieve the same result (first click selects item, second click enables edit mode).

Because the TreeList features "Inline Editing", changes are not saved directly after they have been made like most of the application, they must be managed by the use of the Document Save and Document Cancel features located at the bottom right of the Document.

The Document Save feature can be used to save any changes to the Design Elements. Navigating to different tabs or triggering a child window to open will also trigger a save for any changes made.

The Document Cancel feature can be used to cancel any changes to the Design Elements, this includes rejecting any changes to elements that have yet to be saved, reinserting removed elements and removing newly created ones.

Upon successful completion of saving changes a success message will display at the bottom of the application.

Creating a new Design Element

Clicking on the New button will create a new Design Element directly underneth the current selection.

Indenting Design Elements

Selecting a Design Element and clicking on the Indent button will indent that Design Element making it a child of the element above it.

In order to indent the selected Design Element there must be a element directly above it that is not already the parent.

The same can be achived by using the drag-drop feature of the Treelist, see Reordering.

Outdenting Design Elements

Selecting a Design Element and clicking on the Outdent button will outdent that Design Element removing it from the child collection of the parent element above it.

The currently selected Design Element must be a child of another element in order to outdent.

The same can be achived by using the drag-drop feature of the Treelist, see Reordering.

Reordering Design Elements

Design Elements can be reodered in the list using the drag-drop feature of the Treelist.

Dragging a Design Element over the others in the list will display a small overlay underneth the cursor that will indicate where to "drop" the element. There are 3 options displayed depending on the position of the cursor against the row it is hovering over:

  • Before - drops the element before the element the cursor is hovering over.
  • Inside - drops the element inside, making it a child of the element the cursor is hovering over.
  • After - drops the element after the element the cursor is hovering over.

Removing Design Elements

Selecting the Design Element to remove and clicking on the Remove button will display a removal confirmation window. If Cancel is clicked the confirmation window will close and the Design Element will not be removed. If Yes is clicked the selected Design Element will be removed from the TreeList.

Managing Attachments

Clicking on the Manage button will display the Manage Design Element Attachments child window for the currently selected Design Element. From here new files can be attached and existing Attachments can be downloaded or removed. See Attachment for features.

Managing Design References

Selecting a Requirement Element and clicking on the Manage button will display the Manage Design Element References child window.

The Manage Design Element References child window will display a DataGrid listing the current Project's Design Elements with an extra Reference column.

Referencing a Requirement Element can be achieved by checking the corresponding checkbox in the Reference column.

Once all references are set, the Close button can be clicked to close the child window.

If any Design Elements are referenced using this feature the Design Element will count as being edited.

Importing Design Elements

The Design Specification has the ability to import Design Elements from other Projects via the Import feature of the Document.

Clicking the Import button will display the Import Document child window.

In order to view and import Design Elements from another Project, a Project must be selected from the "Import from Project" drop-down at the top. The drop-down is populated with any other Projects in the application.

From the import button there are two options for importing Design Elements within the Design Specification:

Import Current Tab - Imports all data on the currently selected tab. If the intention is to import Design Elements, the selected tab must be the Solution Design tab.

Import All - Imports all Document data, including any Design Elements identified on the Solution Design tab.

Upon successful import the Import Document child window will close, a success message will be displayed at the bottom of the application and the last of the newly imported Design Elements will be selected.