{scrollbar:icons=false}

h1. Protégé  1.3 Scope
{anchor:ContentsofthisPage}{panel:title=Contents of this Page}
{toc:minLevel=2}
{panel}
{panel:title=Document Information}
*Author:* Charles Griffin
*Email:* ---
*Team:* EVS
*Contract:* ---
*Client:* National Cancer Institute Center for Biomedical Informatics and Information Technology
National Institutes of Heath
US Department of Health and Human Services
{panel}

The *purpose of this document* is to collect, analyze, and define high-level needs and features of the NCI CBIIT Protégé Release 1.3. This document focuses on the functionalities proposed by the product stakeholders and target users in order to make it a better product.

h2. Vision and Needs

The *objective of this release* of Protégé 1.3 is to introduce the database inclusion enhancements that will support owl:imports for federation.

This release will also incorporate defects fixes and other minor feature requests that were high priority items identified by the NCI editing team that were not able to be addressed in the Protégé 1.2.3 release.

h2. Functional Requirements

Each enhancement, modification or new feature is described in detail in the following table.

|| GForge number \\
(hyperlinked) || Brief description of functional requirement \\
(enhancement or new feature) \\ || Iteration \\
(Approved or Proposed) \\ ||
| [caCORE:GF#12247|https://gforge.nci.nih.gov/tracker/?func=detail&group_id=174&aid=12247&atid=822]\\ | Database inclusion | 1 |
| [caCORE:GF#8714|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=8714&group_id=174&atid=822] | Admin component of protege server goes to sleep on extended inactivity periods | 1 |
| [caCORE:GF#3435|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=3435&group_id=174&atid=822] | Restriction INHERITED listing includes duplicate and superceded values | 1 |
| [caCORE:GF#7518|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=7518&group_id=174&atid=822] | Visibility of 'changes' ontology | 1 |
| [caCORE:GF#8745|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=8745&group_id=174&atid=822] | Removal of duplicate GO_Annotations from the Complex Properties | 1 |
| [caCORE:GF#9298|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=9298&group_id=174&atid=822] | Prompt - accept and reject icons in 'changed by' panel of 'table' view don't work | 1 |
| [caCORE:GF#14296|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=14296&group_id=174&atid=822] | Copy tab panes don't have header labels | 1 |
| [caCORE:GF#14557|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=14557&group_id=174&atid=822] | Unnecessary warning dialog when saving with no semantic type set | 1 |
| [caCORE:GF#15131|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=15131&group_id=174&atid=822] | Cancel in classification progress dialog does not terminate the classification | 1 |
| [caCORE:GF#15251|https://gforge.nci.nih.gov/tracker/?func=detail&group_id=174&aid=15251&atid=822] | The order of items in config file is important | 1 |
| [caCORE:GF#16191|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16191&group_id=174&atid=822] | Export of inferred Ontology - Tweaks to output file | 1 |
| [caCORE:GF#16400|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16400&group_id=174&atid=822] | split tab allows creation of new roots | 1 |
| [caCORE:GF#16076|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16076&group_id=174&atid=822] | Transaction didn't close in a class copy operation from the Copy panel | 1 |
| [caCORE:GF#16058|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16058&group_id=174&atid=822] | Class Creation Problems | 1 |
| [caCORE:GF#15788|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=15788&group_id=174&atid=822] | Save Confirmation Popup Dialog blocks other editors | 1 |
| [caCORE:GF#14973|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=14973&group_id=174&atid=822] | class dissappears after editing(wind up under \*Thing\* ?) | 1 |
| [caCORE:GF#16252|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16252&group_id=174&atid=822] | Lengthy and incorrect transactions in EditTab \\ | 1 |
| [caCORE:GF#16258|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=16258&group_id=174&atid=822] | Can't retire some concepts that had referenced classes \\ | 1 |
| [caCORE:GF#15230|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=15230&group_id=174&atid=822] | Error when Retiring a class with existing Editor_Note or DesignNote \\ | 1 |
| [caCORE:GF#14056|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=14056&group_id=174&atid=822] | Permission allows delete of definition (see comments) \\ | 1 |
| [caCORE:GF#13842|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=13842&group_id=174&atid=822] | Incremental Round Trip from Protege to Wiki \\ | 1 |
| [caCORE:GF#8682|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=8682&group_id=174&atid=822] | Merged and Retired concepts are not properly tagged with Retired_Concept \\ | 1 |
| [caCORE:GF#14966|https://gforge.nci.nih.gov/tracker/index.php?func=detail&aid=14966&group_id=174&atid=822] | Business rule - Single restriction as N'S condition cannot be quantified by 'all' \\ | 1 |
| [caCORE:GF#11018|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=11018] | catch client exception when server is down or being bounced \\ | 1 |
| [caCORE:GF#14404|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=14404] | if character in slot matches delimiter then export misaligns values \\ | 1 |
| [caCORE:GF#15131|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=15131] | Cancel in classification progress dialog does not terminate the classification \\ | 1 |
| [caCORE:GF#15921|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=15921] | Explanation server synchronization issue \\ | 1 |
| [caCORE:GF#14939|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=14939] | Copy pane Preferred_Name issues after a modeling error \\ | 1 |
| [caCORE:GF#12066|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=12066] | Different displays of attributes in top and bottom pane of workflow \\ | 1 |
| [caCORE:GF#15913|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=15913] | Save should not be an option on the Merge panel until after a Merge or UnMerge \\ | 1 |
| [caCORE:GF#13712|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=13712] | SMW manifestation - If source not found, may enter BioCarta \\ | 1 |
| [caCORE:GF#12068|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=12068] | Apply the same restrictions as Protege on imported data from SMW \\ | 1 |
| [caCORE:GF#12935|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=12935] | text is not trimmed \\ | 1 |
| [caCORE:GF#9455|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=9455] | Editing the DEFINITION Annotation property \\ | 1 |
| [caCORE:GF#3537|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=3537] | Synchronization of rdfs:label and Preferred_Name \\ | 1 |
| [caCORE:GF#15247|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=15247] | Failure to cross check Preferred Term in Protege 1.2.3 release \\ | 1 |
| [caCORE:GF#15613|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=15613] | the start_explanation_server.sh script does not have appropriate commands \\ | 1 |
| [caCORE:GF#12131|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=12131] | Inconsistant naming used in Configuration dialog \\ | 1 |
| [caCORE:GF#12831|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=12831] | Removes/Corrupts Go_Annotation if have the exact same Long_Definition \\ | 1 |

h2. 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) \\ ||
| None | None \\ | None |

h2. 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) ||
| --\- | Support Activities are Performed by the EVS Operations Team \\ | --\- |

h2. Stakeholder Summary

|| Customer Name \\ || Role \\ || Interest/Need \\ ||
| NCI CBIIT EVS Content Editorial Team \\ | EVS Content Management \\ | Primary Users of Protege.  Utilize Protege to edit EVS content \\ |
\\
\\
|| CBIIT Staff/Contractor Name \\ || Role \\ || Responsibilities \\ ||
| George Komatsoulis | NCI CBIIT \\ | Oversees NCI CBIIT Application Infrastructure \\ |
| Avinash Shanbhag \\ | Director of CORE Engineering \\ | Oversees NCICB caCORE Software Engineering \\ |
| Frank Hartel \\ | EVS Product Manager \\ | Directs EVS Projects \\ |
| Sherri de Coronado \\ | Contract Project Officer \\ | Management/technical resource from Bioinformatics vertica. Contract management, coordinateion, testing, documentation \\ |
| Gilberto Fragoso \\ | Government Lead \\ | Technical resource from Bioinformatics vertical \\ |

h2. Technical Environment

This product uses the following technical components which have been derived from the current [NCICB Technology Stack|https://gforge.nci.nih.gov/docman/index.php?group_id=27&selected_doc_group_id=460&language_id=1].

|| Component || Description ||
| Client Application \\ | The Protege client is java based and provides a complete editing environment for Protege databases, call ontologies.  It uses the same 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 | None |
| Database Server | MySQL |
| Operating System | Any that supports Java: Windows XP, Linux, OS X \\ |
| \[caCORE:Other\] | Portable ANSI-SQL compliant relational schemas \\ |

h2. Product Dependencies

This release is dependent on the caCORE components or products documented in the [caCORE:caCORE Tools 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."\]

h2. 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 \\ ||
| [caCORE:GF#14480|https://gforge.nci.nih.gov/tracker/?group_id=174&atid=822&func=detail&aid=14480] | Make NCIEdit subtabs configurable - The requirements and design need to be flushed out in more detail before the team can move forward on this item. \\ | 1 |


h2. Document History

|| Item || Information ||
| *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:* \\ | [EVS Collaborative Development Tools|https://gforge.nci.nih.gov/projects/protegegui/]\\ |
| *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|https://wiki.nci.nih.gov/x/Cg5y] 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\] \\ |

h2. Project Information

|| CBIIT Management \\ || Role || Responsibilities ||
| Frank Hartel \\ | 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. \\ |

h2. Document Signoffs

|| CBIIT Management \\ || Role \\ || Stakeholder Management || Role ||*Sign off || Date ||
| --\- | \--\- \\ | \--\- \\ | --\- | \--\- \\ | --\- |
\\
{scrollbar:icons=false}