Working on Maintenance Items

Creating, viewing and modifying the Maintenance items - changes, issues, defects and tasks - associated with a particular model element is quick and convenient, using the Maintenance window or Workspace. If the Maintenance window is open, when you select an element in a diagram or in the Project Browser, the Maintenance Items for that element are immediately listed in the window ready for modification or addition. The window provides several facilities for creating and managing the Maintenance items.

You can include the maintenance items in the RTF documentation and HTML generated on your model. The RTF Setup dialog has checkboxes to show or hide element maintenance items.

Access    Element | Maintenance   (Alt+4)

Facilities

Facility

Detail

See also

Window Formats

The Maintenance window has two formats - Item mode and List mode.

Item mode provides a list on the left hand side from which you select a maintenance item, the details of which then display in the fields in the rest of the window; you can edit these fields directly
List mode consists of a list of maintenance items with summary data distributed across the columns; you cannot directly edit these fields
 

To toggle between the modes, click on the showhidetest (Show/Hide Properties) button in the window toolbar.

When you first open the window, in either mode, the oldest maintenance item of the type is shown at the top of the list and, in Item mode, in the data fields.

 

 

Adding New Items

To add new items, click on the New icon in the window toolbar. In:

Item mode, this clears the fields for new data
List mode, this displays the <item type> details for <element type> <element name> dialog, which you complete in the same way as the Maintenance window in Item mode
 

The fields you complete for each type of maintenance item are almost identical.

 

 

 

Create Maintenance Items

 

Applying Automatic Naming/Numbering

On the Maintenance window in Item mode, or on the item details 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 Name field.

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

 

Set Auto Naming and Auto Counters

Maintenance Item Types

The four types of Maintenance Item you can create records for are each managed on a separate tab of the 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
 

The Maintenance window opens at the Defects tab by default.

An asterisk on a tab indicates that the tab contains saved information; if there is no information for a type of item, or the information has not yet been saved, its tab has no asterisk.

You toggle the display for each tab between Item mode and List mode independently.

 

 

Element Browser

You can also use the Element Browser window to select and display specific items on the Maintenance window; click on the EBIcon icon in  the Maintenance window toolbar to display the Element Browser, open the Maintenance folder and select the required item.

In the folder, the 'page' icon against each item contains a:

C for Change items
D for Defect items
T for Task items, or
I for Issue items

 

Element Browser

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