Book a Demo
Prev Next

Working with Maintenance Items

Creating, viewing and modifying the Maintenance items - changes, issues, defects, tasks, feature and documents - associated with a particular model element is quick and convenient, using the  Maintenance window. If the Maintenance window is open, when you select an element in a diagram or in the Browser window, the appropriate maintenance items for that element are immediately listed in the window, and you can select them there to modify. The Maintenance window provides several facilities for managing the maintenance items.

You can include the maintenance items in the document and web reports generated on your model. The 'Document Setup' dialog has checkboxes to show or hide element maintenance items.

Access

Click on an element in the Browser window or diagram and select the appropriate option.

Ribbon

Construct > Change Management and:

  • > Features > Show Features Window
  • > Changes > Show Changes Window
  • > Documents > Show Documents Window
  • > Issues > Show Issues Window
  • > Tasks > Show Tasks Window
  • > Defects > Show Defects Window

Keyboard Shortcuts

Ctrl+8 | <Required tab>

Select any of the items on a diagram or the 'Details' tab of the Inspector window, then use Shift+Enter

Facilities

Facility

Detail

See also

Maintenance Item Types

The six types of Maintenance Item you can create records for are each listed on a separate tab of the Maintenance window:

  • Defects - each recording a failure to meet a requirement for the current model element
  • Changes - each recording a change in requirement for the current model element
  • Issues - each recording a risk factor that might affect the project, associated with the current model element
  • Tasks - each recording work in progress and work outstanding for the current model element
  • Features - each recording a feature in requirement for the current model element
  • Documents - each recording the supporting documentation such as Help, release notes and user comments

There is also a 'Maintenance Overview' tab that displays a read-only list of all the Maintenance items on the element, grouped by type. If you double-click on an item in this list, the appropriate tab displays with the item highlighted.

Adding New Items

To add new items, right-click on the main panel of the Maintenance window and select the 'Add New' option. The appropriate fields for the item type are displayed on the '<Maintenance Item Type> details for <element>' dialog, where you create the item.

The fields you complete for each type of maintenance item are very similar.

Create Maintenance Items

Applying Automatic Naming/Numbering

On the '<Maintenance Item Type> details for <element>' dialog, you can apply an automatic naming/numbering convention that you have previously defined, to each new item record. To do this, simply click on the Auto button next to the 'Detail' field.

If you already have some text in the 'Detail' field, it is over-written by the auto-counter text.

Set Auto Naming and Auto Counters

Details tab

You can also use the 'Details' tab of the Inspector window to create, select and display specific items on the '<Maintenance Item Type> details for <element>' dialog. Select the 'Start > Application > Design > Inspector' ribbon option to open the Inspector window, select the 'Details' tab and the 'Maintenance > <maintenance type>' list, and either:

  • Double-click on an existing item to show and - if necessary - change the details, or
  • Right-click on the appropriate '<maintenance type>' folder name and select the 'New <item type>' option to create a new item
Inspector - Details

Move items between elements

You might have a maintenance item on one element that can be usefully moved on to another element. You can move the item very simply, by dragging it from the Maintenance window or 'Details' tab onto the target element on a diagram.

Move Maintenance Items Between Elements

Notes

  • Columns in the item list can be reorganized, added, removed, grouped, filtered and sorted using the options provided in the List Header facilities

Learn more