Author: [Project Manager/Technical Lead]
Email: [Email address for Scope Document contact]
Team: [For example caDSR, EVS, caGRID, and so on.]
Contract: [Contract number]
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) Protege Release 1.4. 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 objective of this release of Protege 1.4 is to harden Protege so the project can go into an operation and maintenance mode of operation in lieu of actively developing new releases of the product containing new features. Protege 1.4 is planned to be the last major release of Protege.
This release will be performed over five iterations:
Iteration B0 - will focus on merging the 1.3 branch with trunk and will not include the explanation server and explanation tabs.
Iteration B1 - will be a refactoring and hardening iteration focused on making improving and stabilizing the code base.
Iteration B2 - will focus on bugs that were discovered during QA of the 1.3 release and need to be resolved. Any critical 1.4 release bugs found at this point will be fixed as well.
Iteration B3 - will focus on highly desireable "Nice to Have" features.
Iteration B4 - will be dedicated to fixing defects found in 1.4 that are "must haves". Since 1.4 is currently planned to be the last major release, all critical fixes need to be resolved.
Current Solution
Protege 1.3 is in production currently and a Protege 1.3.0.1 patch release is scheduled to be released before Protege 1.4 is released.
Iteration B0
- Merge the 1.3 branch with trunk and create a 1.4 branch.
Iteration B1
GForge number |
Brief description of item |
(Approved or Proposed) |
|---|---|---|
5967 |
New concepts go to bottom of the sibling list, rather than alphabetical (C) |
Approved |
8851 |
Hardcoding of 'special' classes or properties in NCIEVSHistory and NCIConceptHistory plugins (C) |
|
10811 |
Restriction change frozen out (C) |
|
11018 |
catch client exception when server is down or being bounced (C) |
|
11891 |
deleting classes can cause spurious values showing up in class browser (C) |
|
13856 |
When client left open, log file grew to 4 GB (C) |
|
16533 |
Unnecessary warning when leaving Copy or Edit pane (C) |
|
18978 |
frame caching refactoring. (C) |
|
18981 |
Switching subtabs in nciedittab is slow (C) |
|
18988 |
Modifications to the reasoning server to support storage plug-ins (C) |
|
18989 |
Add context information in reasoner client/server protocol to reject updates to unrelated ontologies (C) |
|
18990 |
Reasoner URL as per-project preference (rather than per Protege Server) (C) |
|
18995 |
Update C&P Custom Reasoner Plug-in to better integrate as a Protege Reasoner Plug-in (C) |
|
18996 |
Update Reasoner Server the latest released version of Pellet 2 (C) |
|
14480 |
Make NCIEdit subtabs configurable (E) |
|
16120 |
Addition of a date tag to retired concepts and to merged concepts (E) |
|
18663 |
Synchronization Errors for Domain Changes of Annotation Properties (CB) |
|
18232 |
Language should be serialialized as xml:lang attribute (CH) |
|
Iteration B2
GForge number |
Brief description of item |
(Approved or Proposed) |
|---|---|---|
|
Export of inferred Ontology - Tweaks to output file (A) |
|
|
insertion of Brackets in Preferred Name Display |
|
|
Language display (B) |
|
|
port EVS history plugin to support db inclusions (B) |
|
|
Merging two concepts with incoming roles should not result in duplicates (B) |
|
|
Merging two concepts with incoming properties should not result in duplicates (B) |
|
|
Invalid classification findings if premerge or pre-retire exists (B) |
|
|
Adding restrictions and the Advanced Query (B) |
|
|
Does not change status of workflow to Updated when manager edits a concept (B) |
|
16140 |
Copy Tab allows save of class with duplicate restrictions (B) |
|
16753 |
Retain slot delimiters in LQT export (B) |
|
16926 |
:ROLE concrete - Prompt bug fix (B) |
|
16928 |
Ampersands in property values affecting copy/clone function (B) |
|
|
Automated creation of EVSHISTORY and CONCEPTHISTORY tables on first use (B) |
|
|
Prompt - accept and reject icons in 'changed by' panel of 'table' view don't work (B) |
|
|
PROMPT- 'Table View' crashes after visting 'Show sources' window (B) |
|
|
PROMPT- Reject button in Tree view produces error message to the console (B) |
|
|
If character in slot matches delimiter then export misaligns values (B) |
|
|
History records created on classification in client--server mode (B) |
|
|
Duplicates Items displayed on the main menu. (B) |
|
|
Loss of Concepts form the Hierarchy (B) |
|
17777 |
AQP sometimes returns an incomplete result set (B) |
|
17926 |
Ontology imports cause data problems when loading the explanation server from a Protege database (B) |
|
18163 |
Triple click on Change History causes UnsupportedOperationException (B) |
|
18210 |
User can drag and drop a concept which has not been pre-merged into a merge pane. (B) |
|
18497 |
RuntimeException when you click 'Edit form of type...' button on Edit tab (B) |
|
18533 |
Changes Tab does not reflect items created in Batch Load. (B) |
|
18588 |
Lucene query tab default setting will not search PATO (B) |
|
18589 |
LQP view class buttons do not appear for class in PATO. (B) |
|
18820 |
Package status not being updated in workflow. (B) |
|
18929 |
A classifier run tags all concepts with protege:inferred properties. (B) |
|
18930 |
PROMPT tab allows start of compare even when another compare is running. (B) |
|
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 |
|---|---|---|
|
Example, "Although there are no functional changes to the product for this requirement, the team must migrate the existing software to Hibernate 4.1 to be compatible with the caCORE technology stack." |
|
|
|
|
|
|
|
|
|
|
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 |
|---|---|---|
|
Example, "Level 2 Support, integration of help and training to the user community." |
|
|
|
|
|
|
|
|
|
|
Stakeholder Summary
Customer Name |
Role |
Interest/Need |
||
|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="493632b5-7009-4ef8-9d13-779281a23518"><ac:plain-text-body><![CDATA[ |
[Name] |
[Title or role] |
|
]]></ac:plain-text-body></ac:structured-macro> |
|
|
|
||
|
|
|
CBIIT Staff/Contractor Name |
Role |
Responsibilities |
||
|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d8da5441-7c33-4128-bffa-fc8878a45e40"><ac:plain-text-body><![CDATA[ |
[Name] |
[Role in this project] |
|
]]></ac:plain-text-body></ac:structured-macro> |
|
|
|
||
|
|
|
Technical Environment
This product uses the following technical components which have been derived from the current NCICB Technology Stack.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="53cee27f-0041-492e-aee9-792ec1dfc028"><ac:plain-text-body><![CDATA[ |
Client Interface |
|
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b93fea7b-4675-4c4c-a40e-02f7017857ca"><ac:plain-text-body><![CDATA[ |
Application Server |
[Example, Apache Tomcat 5.5.9] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a559d1f6-96c3-441c-b53c-48811091870f"><ac:plain-text-body><![CDATA[ |
Database Server |
[Example, Oracle 9i] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f912ab90-63dd-4877-8013-6641c1f88800"><ac:plain-text-body><![CDATA[ |
Operating System |
|
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5e65aa39-af2c-404f-9f2e-e22528212450"><ac:plain-text-body><![CDATA[ |
[Other] |
|
]]></ac:plain-text-body></ac:structured-macro> |
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 |
Iteration during which the item |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
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. |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3ee3db24-76ce-4565-83b9-62564a5e50b4"><ac:plain-text-body><![CDATA[ |
Project GForge site: |
[Project GForge site link] |
]]></ac:plain-text-body></ac:structured-macro> |
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. |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a8bc6802-0f0f-4665-bb2c-4f6d68dfc158"><ac:plain-text-body><![CDATA[ |
Related documents: |
[Name and URL of each related document] |
]]></ac:plain-text-body></ac:structured-macro> |
Project Information
CBIIT Management |
Role |
Responsibilities |
||
|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e0755e76-db81-4046-baba-e7c0072366e6"><ac:plain-text-body><![CDATA[ |
[Name] |
Product Manager |
Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release |
]]></ac:plain-text-body></ac:structured-macro> |
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. |
