Protégé 1.5 Scope Document
Author: Gilberto Fragoso/ Bob Dionne
Email: fragosog@mail.nih.gov
Team: EVS Protege
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 |
---|---|---|---|
Sherri De Coronado | 6/18/2015 | Government Sponsor | CBIIT |
Gilberto Fragoso | 6/18/2015 | Government Sponsor | CBIIT |
Kumar Kuntipuram | 6/18/2015 | Government Sponsor | Leidos Biomedical Research Inc. |
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) Protégé Release 1.5. 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 Protégé 1.5 is to harden the existing Protege 3.4 so the project can go into an operation and maintenance mode of operation whilst new development is occurring on Protégé 5. This release builds on the technology stack upgrade that's already in production and will entail one and possibly two iterations:
Iteration 1 - will include all the JIRA bug fixes enumerated below
Iteration 2 - Possible new JIRA items will be added in addition to any new bugs exposed by iteration 1.
Iteration 1 (1.5.0)
JIRA ticket | Brief description of item | (Approved or Proposed) |
---|---|---|
Associations are not able to be copied in the copy tab. | Approved | |
1430 | Add a cancel search button | Deferred |
1442 | Performance issues with long running queries | Approved |
1432 | Batch Editor commits 'NA' to filler values | Approved |
1431 | Administrator should have rights to edit retired concepts | Approved |
1424 | Can't Batch Delete Original N&S Parent | Approved |
1423 | Language on Definition not displayed in Edit Tab | Approved |
1457 | Initial Editing of Preferred Class Name is not being recognized | Approved |
1454 | Incorrect label on "Preretire" button | Approved |
1455 | Warning message spelling error when performing PreRetire | Approved |
1450 | Disable Worflow | Approved |
1445 | Batch Edit not treating FULL_SYN the same as Batch Load | Approved |
1443 | Report Writer fails if a bad code is in the input | Approved |
1448 | Empty qualifiers should not be allowed on batch edit | Approved |
1447 | Duplicate restrictions discarded but still write to the evs_history table | Approved |
1446 | It is possible to create duplicate roles | Approved |
1439 | Allow code to be selected and copy/pasted from the edit pane | Approved |
1427 | If you click on 'No results found.' an error is thrown and comes up on the console | Approved |
1415 | When cloning not escaping definition if invalid class name | Approved |
Iteration 2 (1.5.1)
JIRA ticket | Brief description of item | (Approved or Proposed) |
---|---|---|
Umlaut in a :NAME in a batch load file creates a term with a bad :NAME | Approved | |
1467 | Right Clicking on Class Name and Sub-Class name the Create Workflow Task Menu Pops up | Approved |
1468 | Closing "Enter Class Identifiers" by Clicking "X" Causes Java Error | Approved |
1465 | Disallow save of self concept as the parent concept (superclass) | Approved |
1457 | Initial Editing of Preferred Class Name using the Shift Key + Letter is not being recognized. | Approved |
34 | Output Duplicates for Input Duplicates | Approved |
1461 | Copy tab functional discrepancy | Approved |
1433 | Have default Editor_Note and DesignNote on retiring merge partner point to the code. | Approved |
1460 | Ability to select "lucene match" as a default search | Approved |
1471 | After save the GUI focus goes to the New Project... icon | Approved |
1440 | Assign STY to concept in Batch Load file | Approved |
1407 | Sorting Feature | Approved |
1436 | ByCode issue - Partonomy Tree dialog shows role codes | Approved |
1437 | ByCode issue - Partonomy Tree tab unable to create tree in byCode vocab | Approved |
1413 | Change of Semantic_Type value after changing PTs | Approved |
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 |
---|---|---|
| NCI CBIIT | Oversees NCI CBIIT Application Infrastructure |
| Director of CORE Engineering | Oversees NCICB caCORE Software Engineering |
| EVS Product Manager | Directs EVS Projects |
Sherri de Coronado | Contract Project Officer | Management/technical resource from Bioinformatics vertica. Contract management, coordination, testing, documentation |
Gilberto Fragoso | Government Lead | Technical resource from Bioinformatics vertical |
Technical Environment
This product uses the following technical components which have been derived from the current NCICB Technology Stack.
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. |
Application Server | None |
Database Server | MySQL |
Operating System | Any that supports Java: Windows, Linux, OS X |
Other | Portable ANSI-SQL compliant relational schemas |
Product Dependencies
The runtime product has no dependencies other than the ones stated under Technical Environment.
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 JIRA site: | |
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 |
---|---|---|
| Product Manager | Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release |
| Engineering Manager | Oversees NCICB caCORE software engineering practices, conducts design reviews, guides technical development |
| Product Line Manager | Oversees NCICB caCORE product line. Responsible for overall product integration, major and minor release cycles. Supports Product Manager. |