Document Detail Window Menus
The Document Detail window shows the values of each of the attributes
for this document entry as stored in the database.
Select the "File" menu item to perform operations on the document as
described below:
- Save
- Select this item to save any changes you have made to any fields in this window. If no changes have been made, you will be notified that a save is not needed.
- Download Copy...
- Select this item to copy the source file for the document into a directory on your machine or a directory you own on a remote machine. You will have a choice of the format copied. If you are not on the notification list and obtain a physical copy of the document, you will be asked if you want to be automatically added to the list.
- Print...
- Select this item to print the document on a printer. If you are not on the notification list and obtain a physical copy of the document, you will be asked if you want to be automatically added to the list.
- Create New MR...
- Select this item to enter an MR against the document. Follow this reference for more information regarding creation of new MRs.
- Create Inspection...
- Select this option to schedule a new inspection for the document or code entry.
- Create Review...
- Select this item to schedule a new review for the document.
- Version...
- Select this item to do the following:
o Remove Old versions if you are the owner.
o List Dates of each document version.
o Print a diffmark copy of two versions.
o Browse the output of diff for two versions.
o Turn Off version control if you are the owner.
All versions except the latest will be removed.
Also, the value of the field "Controlled" is set
to "no".
o Copy a version of the document to your directory.
o Print a version of the document to your printer.
- Notify...
- Select this item to do the following:
o Browse the notification list.
o Edit the notification list (owner only).
If the notification list does not exist,
it will be created and the document owner
will be added as the first entry as an
example of how to format an entry in the file.
o Add yourself to the notification list.
o Remove yourself from the notification list.
- The notification list is used to send email to people each time a new version of the document is delivered to COMPAS. If you are not on the notification list and you print or copy this document, you will be asked if you want to be automatically added to the list.
- Delete
- Select this item if you are the owner and you want to remove the document and associated data from the COMPAS database.
- Close
- Select this item to close the Document Detail window.
Select the "Edit" menu item to perform operations on the document as
described below:
- Documents
- Select this item if you are the owner of the document to edit the text source file in COMPAS. You will be placed into a window with your favorite editor;
as you specified in the COMPAS Main Window Edit Preferences - Helper Applications screen. As in the Replace Doc item below, controlled documents may not be edited in every document status. You will be asked if you want to notify the users on the notification list at the end of the editing session.
- Add/Replace Doc...
- Select this item (if you are the owner of the doc) to replace the document text with a new version. If the document is controlled, then a replace is not allowed unless the document is either in the draft or rework status. Replace is also allowed in the chg_ctl status if there is an approved MR. You will be prompted for the path to the new document text. You will also be asked if you would like to notify all users on the notification list of the change.
- Document Links...
- Select this item to add or remove links to other documents from this document. You just enter the IDs of the documents you want to link to this document. They will then be displayed when you browse the links for this document. To remove a displayed document link, highlight the document link and click the "Remove" control button.
- Projects...
- Select this item to edit the secondary projects that this document is assigned to. A document can have only one primary project that owns the document but can have many secondary projects that use the document. Attach secondary projects if you want other projects that query for documents for their project to see this document.
- Change Status...
- Select this item to change the document status. Depending on the status of the document and if the document is controlled, some status items may not be selectable or "dimmed".
Select the "Browse" menu item to perform operations on the document as
described below:
- Document...
- Select this item to browse the formatted document. A new window will be displayed with the document text.
- Child Links...
- Select this item to view the list of documents related to this document via child links. They can be browsed, printed, etc from the related document links list window.
- Parent Links...
- Select this item to view the list of documents related to this document via parent links. They can be browsed, printed, etc from the related document links list window.
- Project Links...
- Select this item to see a list of all the projects that own this document entry. There will be only one primary project ownership and multiple "secondary" project ownerships.
Select the "Control Draft" Menu to perform operations on a Change Controlled
document that is in the Document Status of chg_ctl as described below:
The "Control Draft" function allows a document owner to submit a new Draft copy
of a document for examination by an MR Originator for suitability to the MR
requirements - while retaining the previously established official version
of the document. Then, if the Draft version of the controlled document is suitable
to satisfy the MR Originator,
the Draft Version may be made to be the offical version of the
document by use of the Deliver option on the Control Draft menu.
- Add/Replace
- Select this item to submit a Draft copy of a Change Controlled document
that is in the Document Status of chg_ctl.
- Browse
- Browse the Draft version of the document.
- Print
- Print the Draft version of the document.
- Copy
- Download the source file of the Draft version of the document.
- Delete
- Delete the Draft version of the document.
- Deliver
- Convert the Draft version of the document to the official version of
the document by designating the appropriate Approved Status MRs.
Select the "Go" menu item to perform operations on the document as
described below:
- Reviews
- Select this item to browse the latest review info.
- Open MRs
- Select this item to browse all open MRs for this document entry.
- Inspections
- Select this item to browse the latest inspection info.
Select "Help" from the main menu to learn how to navigate forms and menus
and also how to select items with the mouse.