Book a Demo

Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Prev Next

Create Maintenance Items

When you need to create a new maintenance record for an element, you can do so by selecting the 'Add New' context menu option in the Maintenance window.

Access

Use one of the access paths outlined here to display first the Maintenance window at the appropriate tab for the type of maintenance item to create, then the '<Maintenance Item Type> details for <element type>' dialog for that item type.

Ribbon

Construct > Change Management > Features > Show Features Window > right-click | Add New

Construct > Change Management > Changes > Show Changes Window > right-click | Add New

Construct > Change Management > Documents > Show Documents Window > right-click | Add New

Construct > Change Management > Issues > Show Issues Window > right-click | Add New

Construct > Change Management > Defects > Show Defects Window > right-click | Add New

Construct > Change Management > Tasks > Show Tasks Window > right-click | Add New

Keyboard Shortcuts

Ctrl+8 > <required tab> | Right-click | Add New

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

Create Maintenance items on the Maintenance dialog

Option

Action

See also

Detail

Type the name or a short description of the feature, change, defect, task, issue or document.

Auto

As an alternative to typing in the name, click on this button to insert predefined auto-counter text.

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

Reported by / Requested by / Raised by

Click on the drop-down arrow and select the user name of the person who initiated the maintenance item.

Alternatively, start typing in the user name until the auto-complete facility fills in the rest of the name.

Date

Defaults to today's date as the date on which the maintenance item was raised; if necessary, change this by clicking on the drop-down arrow and selecting a different date.

Status

Click on the drop-down arrow and select the appropriate status of the maintenance item, such as 'New' or 'Complete'.

Priority

Click on the drop-down arrow and select the priority for completing the maintenance item.

Resolved by / Implemented by / Completed by

Click on the drop-down arrow and select the user name of the person who completed and closed the maintenance item.

Alternatively, start typing in the user name until the auto-complete facility fills in the rest of the name.

Date

Select the date on which the maintenance item was completed; click on the checkbox to select today's date or, if necessary, change the field by clicking on the drop-down arrow and selecting a different date.

Version / ID

Displays the version number assigned to this defect, change, task, issue or document.

If you want to refer to this maintenance item from another element or document, click on the Copy button to copy the ID to the clipboard, from where it can be pasted into the other text.

Description

Type a longer description of the maintenance item; you can format the text using the Notes toolbar at the top of the field.  The text you enter here is also displayed and can be edited in the Notes window.

The Notes Window

History

Over time, enter any notes on the actions concerning this maintenance item; you can format the text using the Notes toolbar at the top of the field. The text you enter here is also displayed and can be edited in the Notes window.

The Notes Window

Apply

Save

Click on this button to save the record data and keep the dialog open.

OK

Click on this button to save the record data and close the dialog.

Close

Click on this button to discard the unsaved record data and close the dialog.

New

Click on this button to clear the dialog fields ready to define a new maintenance item.

left chevron/right chevron

If there are existing items, click on these buttons to display the details of the previous item or next item in the sequence.

Create Maintenance Items on the Maintenance Window

An alternative method of creating simple Maintenance items is to display the Maintenance window as indicated in the Access section, but complete the fields on the window rather than go on to display the 'Maintenance' dialog. In this way you can quickly create a set of basic Maintenance items at once and then add more detail to individual items as necessary at a later time.

To create an item:

  1. Display the appropriate tab for the type of item.
  2. Double click on the Add new <item type> text and type in the name of the item.
  3. Tab to the 'Status' field; the 'Status', 'Priority' and 'Date Reported' fields display default values. If these are acceptable to you, the Maintenance item is created and available for future editing.
  4. If you want to change the field values, click once on the field and once on the drop-down arrow, and select the appropriate value.

Notes

  • To edit an item, double-click on it on the Maintenance window; the item details display in the '<Maintenance Item Type> details for <element type>' dialog for editing
  • To delete an item, right-click on it on the Maintenance window and select the 'Delete' option; in response to the confirmation prompt, click on the Yes button
  • A further possibility for editing and deleting items is to right-click on items in the 'Details' tab of the Inspector window and select menu options there; select the 'Start > All Windows > Design' ribbon option and then 'Explore > Inspector > Details > Maintenance > <maintenance type>'
  • To change the element for which to create or edit maintenance items, click on the new element on a diagram or in the 'Project' tab of the Browser window

Learn more