Author: Stephen Alred
Email: alreds@mail.nih.gov
Team: caDSR
Contract: [caCORE:Contract number]
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services
|
| Sign off |
Date |
Role
|
CBIIT or Stakeholder Organization
|
| Denise Warzel |
12/19/2008 (revised)
|
Prod Manager
|
CBIIT
|
| Dave Hau |
|
Engg
|
CBIIT CORE Engineering
|
| Dianne Reeves |
|
Content Team
|
CBIIT
|
Charles Griffin
|
|
Technical Project Manager
|
CORE Engineering - Ekagra
|
The purpose of this document is to collect, analyze, and define high-level needs and features of the NCI CBIIT caDSR content browsers, CDE and UML Browsers, Release 4.0.0.1. This document focuses on the functionality proposed by the product stakeholders and target users in order to make it a better product. The use-case and supplementary specifications document will detail how the framework will fulfill these needs.
Vision and Needs
The objective of this release of the caDSR content browsers is to add several high priority but fixes from the content developers, making way for the next release, 4.0.0.2 to address end users "Top 10" list, and to begin design for new clinician friendly, end user browser for users who are not familiar with caDSR or ISO 11179. This has been described as something that might be similar to the Tolven Wikihit, a view of content in which the end user does not need to know what content is available, but is provided with an interface that serves up content in a way that is intuitive. This would be accomplished by leveraging the relationships that are inherent in the ISO11179 and caDSR metamodel.
This release will address simplifying access to caDSR content by providing the ability to customize downloads, making browser UIs function more similarly and improve user experiences with the product.
Current Solution
[caCORE:Optional, briefly describe the existing solution and shortcomings.]
Proposed Solutions
[caCORE:Optional, describe the future state.]
Functional Requirements
Each enhancement, modification or new feature is described in detail below.
GForge number
(hyperlinked) |
Brief description of functional requirement
(enhancement or new feature)
|
References
|
Iteration
(Approved or Proposed)
|
|
CDE Browser |
|
|
|
UML Model Browser |
|
|
| 16746 |
Display GME Metadata in UML Browser |
Design (TBD)
|
Approved |
Functional Bug Fixes
Each bug fix included in this release is described in detail below.
GForge number
(hyperlinked) |
Brief description of bug
|
Iteration
(Approved or Proposed)
|
Priority |
| |
CDE Browser
|
|
|
| 16053 |
Remove window size and position settings for Online Help
|
Approved |
L |
| 18256 |
Reference Document - URLs not working |
|
M |
| 18367 |
CDE Browser's "New Search" button is not resetting search path bread crumbs |
Approved |
H |
| 18442 |
CDE Browser includes retired CDE's by default. |
Approved |
H |
| 18452 |
CDE Browser Tree jumps to top |
|
M |
| 18531 |
Extra columns in "Prior Version" Download in CDE Browser 4.0.0.0 |
Approved |
H |
| |
UML Model Browser
|
|
|
| 16780 |
Make UML Model Browser tree sort case insensitive |
Approved
|
M |
7362
7039 |
Fix UML Model Browser so that Display of multiple released Versions of projects works the same way as in the CDE Browser
After versioning a CS, only the new version appears in the tree, but both appear in the project search drop-down.
Browser only displays 'latest version yes' |
Approved |
H |
17681
|
UML Browser performance degrades under multiple users
|
Approved |
H |
Non-Functional Requirements
This section describes in detail all the related requirements which must be met for this release but do not add functionality. These requirements are included in the scope and project plan due to level of effort or relative importance to the overall success of delivery of the release.
| GForge number (hyperlinked) |
Brief description of non-functional requirement
|
Iteration
(Approved or Proposed)
|
| |
CDE Browser |
|
| 12871 |
Complete work to auto-deploy the CDE Browser |
Approved |
| |
UML Model Browser |
|
| 12872 |
Complete work to auto-deploy the UML Model Browser
|
Approved |
| |
|
|
General Support Activities
This section describes in detail all the related activities which must be performed for this release but do not add functionality. These activities are included in the scope and project plan due to level of effort or relative importance to the overall success of delivery of the release.
| GForge number (hyperlinked) |
Brief description of general support activity |
Iteration
(Approved or Proposed) |
| |
Example, "Level 2 Support, integration of help and training to the user community." |
|
| |
|
|
| |
|
|
| |
|
|
Stakeholder Summary
Customer Name
|
Role
|
Interest/Need
|
[caCORE:Name]
|
[caCORE:Title or role]
|
|
| |
|
|
| |
|
|
CBIIT Staff/Contractor Name
|
Role
|
Responsibilities
|
[caCORE:Name]
|
[caCORE:Role in this project]
|
|
| |
|
|
| |
|
|
Technical Environment
This product uses the following technical components which have been derived from the current NCICB Technology Stack.
Client Interface
|
- Internet Explorer 6.0 and above
- A new browser will be developed to be compatible with Mozilla
|
| Application Server |
[caCORE:Example, Apache Tomcat 5.5.9] |
| Database Server |
[caCORE:Example, Oracle 9i] |
Operating System
|
- [caCORE:Example, Windows 2000. XP, Vista]
- [caCORE:Example, Unix (Sun Solaris)]
|
| [caCORE:Other] |
|
Product Dependencies
This release is dependent on the caCORE components or products documented in the CORE Product Dependency Matrix.
[caCORE:Provide additional explanation as applicable. For example, "The EVS vocabulary systems are used by the Java client to retrieve and validate concept information for naming and defining meanings."]
Out of Scope Items
Items that are out of scope were evaluated as part of the initial scoping activities for this release, and subsequently not included in the final approved scope. These items are also documented in the cumulative backlog of requirements found on the product GForge site. They include out-of-scope functional requirements (enhancements or new features), bug fixes, non-functional requirements, and general support activities.
| GForge number (hyperlinked) |
Brief description of item moved from the in-scope section
with brief explanation added of why it was not included in this release
|
Iteration during which the item
was removed from in-scope
|
| 4650 |
Provide ability to refresh/update the materialized view from the UI when content is not visible.
Will be handled via a work procedure in conjunction with CBIIT Application Support.
|
4.0.0.1 |
| 11899 |
Enhance CDE Browser: Registration Metadata |
4.0.0.1 |
| 1333 |
4.0.0.1 has been changed into a bug fix release due to the high priority bugs that are being reported from the 4.0.0.0 release |
4.0.0.1 |
| 4666 |
4.0.0.1 has been changed into a bug fix release due to the high priority bugs that are being reported from the 4.0.0.0 release |
4.0.0.1 |
| 16688 |
4.0.0.1 has been changed into a bug fix release due to the high priority bugs that are being reported from the 4.0.0.0 release. This change was deemed not a high priority fix and de-scoped so some critical bug fixes can be made available to users faster. |
4.0.0.1 |
Document History
Document Version:
|
Click the Info tab. View the Recent Changes or click the link to view the page history.
|
Last Modified:
|
Refer to the first line displayed in the document window.
|
Project GForge site:
|
https://gforge.nci.nih.gov/projects/cdebrowser/\\ |
Most current version:
|
Unless the display includes a notice that you are viewing a previous version, you are viewing the most current version of this Scope Document for the release indicated in the title.
|
Revision history:
|
Click the Info tab. In the Recent Changes area, click the link to view the page history.
|
Review history:
|
Click the Info tab. In the Recent Changes area, note the developer who made each change and the date and time. Refer to the Key People Directory for their roles. Click the link to view any page or to view the page history, and then click the link for a page. When the page opens, view the comments and changes made in that version.
|
Related documents:
|
[caCORE:Name and URL of each related document]
|
Project Information
CBIIT Management
|
Role |
Responsibilities |
Denise Warzel
|
Product Manager
|
Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release
|
Dave Hau
|
Engineering Manager
|
Oversees caDSR software engineering
|
|
The additional items on the users Top Ten - (Below the top 10) needs to be evaluation to determine which items are higheste priority. Ther eare a number of issues with the UI defaults and behavior for Basic/Advanced searches, a few of which could potentially be addressed.