The Op Doc Detail screen displays the Op Doc as it is intended for regular access / reading. The screen shot depicts a common view of the Op Doc Detail screen with all fields marked with call-out clouds, each of which is labeled numerically. Refer to the numbered clouds for reference throughout the following description. A bracketed number such as [12] indicates that one should look at the cloud labeled with the bracketed number, in this case cloud 12. Red clouds indicate actions that may be taken, whereas blue clouds indicate information-only items.
Traveling from the top to the bottom of the Op Doc Detail screen we first see the Op Doc Title and Number [1] in the menu area in addition to a stamp that indicates the status of the document, i.e., "In Place", "In Development", etc.
Directly below the menu area is a Quick Jump area [2] (which is described in more detail below) are two links, "Comments" and "Revisions" [3]. The comments link indicates the number of comments attached to the document while the revisions link indicates the number of revisions that exist for this operational document. If the currently displayed revision is not the newest revision, a small notice is visible below the revisions link which indicates "A newer version of this op doc exists". Clicking on the revisions link opens a list of all of the revisions which allows the user to navigate to other revisions or compare the current revision against other revisions.
Next we may optionally see a "Review Response" area [4]. This notice only appears when a user is assigned to review the current operational document or is responsible for approving a submitted review for the current operational document. For more details on handling reviews, please see the corresponding FAQ item as indicated in the "Related Links" below.
As we progress to the next section of the operational document detail screen, we see the Purpose of the document [5], followed by the main document area [6]. Within the content area, certain special links are provided for Op Doc references [7] which when clicked direct the browser to the most recent version of the referenced Op Doc. Additionally, if an exhibit / attachment has been inserted into the Op Doc, a special link [8] appears, which, when clicked, opens the attachment in a new window or browser tab.
Just after the document area is a Comments area [9]. This area is collapsed by default, but can be expanded (or collapsed again) by clicking on the "Comments" heading next to the plus / minus sign. This area displays all of the comments that have been submitted to the current operational document revision along with the author of the comment and when it was sumitted. Users with adequate permissions may also add new comments by clicking on the "New Comment" button [10] and entering their text and an optional attachment. Users with adequate permissions may also delete comments by clicking the "Delete" link [11] next to any comment and confirming their deletion.
Below the Comments area is a meta data or Details area [12]. This area is also collapsed by default but can be expanded / collapsed in the same fashion as the comments area. Within the Details are several bits of extra information about the document are displayed including:
-
Positions Assigned: when any positions are listed in this (or the Backup Positions area), they appear as hyper-links [13]. Clicking on a hyper-link position name automatically directs the browser to the Op Doc List screen filtered for other Op Docs which are also assigned to that position.
- Backup Positions
- Tags: [14] any tags associated with the Op Doc are displayed here. Depending on the user's role / permissions there may also be an "Add Tag" button which, when clicked will display a drop down list of available tags, choosing one of which will assign that tag to the Op Doc.
- Watchers: [15] any contacts watching the Op Doc. Depending on the user's role / permissions there may also be an "Add Watcher" button which, when clicked will display a drop down list of available contacts, choosing one of which will assign that contact as a Watcher to the Op Doc.
- Web Links [16]: a list of all web links contained within the Op Doc. This is merely a convenience re-listing of the web links, since they also already appear in the Op Doc content.
- Exhibits [16]: a list of all exhibits referenced within the Op Doc. This is merely a convenience re-listing of the exhibits, since they also already appear in the Op Doc content.
- Referenced Op Docs [16]: a list of all Op Doc references contained within the Op Doc. This is merely a convenience re-listing of the Op Doc references, since they also already appear in the Op Doc content.
- Op Docs that Reference this Op Doc [16]: a list of all Op Docs that contain references to the current Op Doc
Finally, the last area of the operational document detail view is the Authorship, Reviews and Approval section [17]. As expected, this area displays the original author of the document, the most recent editor and the approving party as well as the dates each of those events took place on. Additionally, any contacts currently assigned to review the current revision are indicated to the right [18] along with a history of any reviews that have already been completed for this revision. Users with sufficient permissions may also add new reviewers to the revision by clicking the "Add a Reviewer" link and selecting the appropriate contact and date from the options that appear.
Quick Jumping
Like the Quick Jump area on the Op Doc List, this Quick Jump area [2] allows jumping directly to a given Op Doc by number. In addition, clicking the left or right arrow in this area will jump to the next or previous Op Doc according to the order of Op Docs last displayed in the Op Doc list. For example, let us assume that the Op Doc list was filtered to display four op docs numbered "1000", "1003", "1007", and "1008" respectively. Clicking the right arrow link in the Quick Jump area while viewing Op Doc Detail view of Op Doc "1003" will load Op Doc "1007". From "1007" clicking the right arrow again will load Op Doc "1008".
Actions Menu
Several actions are available depending on the currently logged in user's role / permissions.
- Revise this Op Doc: redirects the user to the Op Doc Edit screen where either a new revision will be created or the existing revision will be edited, depending on its current status.
- Copy this op doc: redirects the user to the Op Doc Edit screen for a new Op Doc where all of the fields are copied from the currently viewed Op Doc.
- Approve this revision: will approve the Op Doc revision if approval is a valid option based on the revision's current state
- Obsolete this Op Doc: will obsolete the Op Doc revision if obsoletion is a valid option based on the revision's current state
- Delete this revision: will delete the current revision. Upon clicking this option, the user will be prompted to confirm the deletion. Once confirmed, the revision will be permanently deleted.
- Enable group editing: will change the Op Doc's status to "Group Editing"
- Submit for approval: will change the Op Doc's status to "Pending Approval"
|
