Author: Charles Griffin
Email: griffinch@mail.nih.gov
Team: EVS
Contract:
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services
|
| Sign off |
Date |
Role
|
CBIIT or Stakeholder Organization
|
| |
|
|
|
| |
|
|
|
| |
|
|
|
The purpose of this document is to collect, analyze, and define high-level needs and features of the National Cancer Institute Center for Biomedical Informatics and Information Technology (NCI CBIIT) caCORE [product] Release [x.x.x.x]. This document focuses on the functionalities 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 Protege 1.4 release is intended to a product hardening release that will focus on fixing defects, address build and deployment issues, and resolve critical usability issues. The only new features that will be added in this release will be features that are deemed crucial for the usage of Protege.
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)
|
Iteration
(Approved or Proposed)
|
| 2948 |
Domain and Range checks on property restrictions at edit time |
|
| 8302 |
Need automatic cursors in filler windows |
|
| 8303 |
Copying Properties in the Edit pane |
|
| 8407 |
Enter key does not close confirmation message box |
|
8590
|
Allow user to modify Superclasses in Copy tab
|
|
| 8608 |
Add Cut, Copy, and Paste options to main tree that modifies Superclass |
|
| 8609 |
Retain frame sizes after switching tabs |
|
| 8656 |
Improve usability of object annotation searches in AQP
|
|
| 8989 |
Selection of Properties in Report Writer |
|
| 8990 |
Report Writer output format |
|
10987
|
"Modify Name Superclass" dialog should be eliminated |
|
| 11018 |
catch client exception when server is down or being bounced |
|
| 11523 |
Can't delete an annotation |
|
| 10987 |
"Modify Name Superclass" dialog should be eliminated |
|
| 11018 |
catch client exception when server is down or being bounced |
|
| 12337 |
Automated configuration of server project |
|
12815
|
Track the last modeler who modified the assignment |
|
12817
|
Creating new workflow assignments |
|
| 13586 |
Can the Read-Only view look like the Review pane (have one page with all class info)? |
|
| 14480 |
Make NCIEdit subtabs configurable |
|
15003
|
NCIWorkflow - reorder columns |
|
15632
|
Inability to reject and/or ignore suggestions from the classifier |
|
| 15752 |
In copy pane, modify restriction does not remember filler value |
|
16012
|
User is able to accept changes that classifier suggest for inconsistant class - leads to issue |
|
16152
|
Display of NCIEditTab Build Version |
|
16163
|
Addition of Superclass in Copy/Split/PreMerge - allow 'defining' superclass
|
|
| 16164 |
Defined/Primitive state of output concept in Split or Copy operation |
|
16255
|
Disable the Merge tab when the user is not allowed to merge |
|
16753
|
Retain slot delimiters in LQT export |
|
16755
|
Simplify adding a role |
|
16389
|
Each change needs to be associated with an editor |
|
16887
|
Add definition field to window when cloning a class |
|
| 17210 |
LQP/AQP - selection and output of superclasses |
|
17212
|
LQP/AQP - search for concepts lacking a property |
|
17213
|
Selection criteria for concepts to be exported via LQP/AQP export function |
|
17214
|
Report writer - add export function currently in LQP/AQP |
|
17466
|
Loss of Connectivity to History Database |
|
17570
|
Confusing message to the user when you drag the retiring concept into surviving concepts pane. |
|
17571
|
Search under the Class browser is not cleared after the search is done. |
|
17760
|
Workflow Improvements
|
|
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)
|
| 8525 |
Editing new unsaved role group shows blank dialog |
|
| 8918 |
Allows paste of Preferred Name but can not delete
|
|
| 8947 |
Modal dialog does not stay on top
|
|
| 10811 |
Restriction change frozen out |
|
| 11600 |
Automatically switches Restriction when select a Restriction Property
|
|
| 11891 |
deleting classes can cause spurious values showing up in class browser |
|
14786
|
Focus jumps to new project after final row deleted |
|
15174
|
No copy option on right click menus for Split function |
|
| 15175 |
Invalid classification findings if premerge or pre-retire exists |
|
| 15182 |
Removal of XML tags from query export |
|
15381
|
Adding restrictions and the Advanced Query |
|
| 15493 |
Default Task Description of new Workflow assignment has typo |
|
| 15664 |
Assumption of role groups |
|
15889
|
Merging two concepts with incoming properties should not result in duplicates |
|
16140
|
Copy Tab allows save of class with duplicate restrictions |
|
16926
|
:ROLE concrete - Prompt bug fix |
|
16928
|
Ampersands in property values affecting copy/clone function |
|
17711
|
Missing warning message to the user : causes protege to freeze. |
|
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)
|
| 17031 |
Release 1.4 packaging |
|
| |
|
|
Stakeholder Summary
Customer Name
|
Role
|
Interest/Need
|
[Name]
|
[Title or role]
|
|
| |
|
|
| |
|
|
CBIIT Staff/Contractor Name
|
Role
|
Responsibilities
|
[Name]
|
[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
|
Protege client is java based and provides a complete editing environment for Protege databases, called ontologies. It uses a plugin architecture to support extensions, called Tabs. For example, the NCI Edit Tab, Workflow, Changes, and Prompt, are examples of plugin tabs. |
Java 1.5.x |
| Application Server |
Protege server is an RMI-based server that runs against any relational database, in our case MySQL |
| Database Server |
MySQL |
Operating System
|
Any OS supporting Java, Windows, Linux OS X |
| [caCore:Other] |
Portable ANSI-SQL compliant relational schemas |
Product Dependencies
This release is dependent on the caCORE components or products documented in the CORE Product Dependency Matrix.
[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
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
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:
|
[Project GForge site link]
|
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:
|
[Name and URL of each related document]
|
Project Information
CBIIT Management
|
Role |
Responsibilities |
| [Name] |
Product Manager
|
Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release
|
Avinash Shanbhag
|
Engineering Manager
|
Oversees NCICB caCORE software engineering practices, conducts design reviews, guides technical development
|
Denise Warzel
|
Product Line Manager
|
Oversees NCICB caCORE product line. Responsible for overall product integration, major and minor release cycles. Supports Product Manager.
|
|
