Protégé 1.4.2 Scope Document
Author:Jason Lucas/Gilberto Fragoso
Email:lucasjr@mail.nih.gov
Team:EVS
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) Protégé Release 1.4.2. 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.4.2 is to provide bugs fixes found in previous Protégé releases as well as validating functionality that had been developed in previous releases but never tested. Then fixing any defects that come out of that testing.
Current Solution
Protege 1.4.1.1 is currently in production.
Feature Requests
GForge number | Brief description of item | (Approved or Proposed) |
---|---|---|
Export of inferred Ontology - Tweaks to output file | Approved | |
Load explanation server from the Protege KB using the OWL API converter in Protege 3.4 | Approved | |
Serialize state at explanation server shut-down so start-up can be incremental since previous run | Approved | |
Only exports the first page of results in LQT search | Approved | |
update protege/workflow and SWM to handle new XML Literal complex properties | Approved | |
Batch jobs performance improvements | Approved | |
Batch jobs robustness | Approved | |
Allow multiple domains and ranges | Approved | |
Report Writer outputs extra instances in 'Property value present' query | Approved | |
Unable to get filler values from roles in query export | Approved | |
A button to refresh the class hierarchy tree in the class browser pane. | Approved | |
Disable Tooltips for NCI ontologies. | Approved | |
Add a Complete button to workflow subtab | Approved | |
Remove Unnecessary scripts from Protege Server / Explanation Server Folder | Approved | |
Lucene query tab default setting will not search PATO | Approved | |
Export of Annotations are viewed by OWLAPI as ObjectProperties | Approved | |
Start or restart of the Explanation server has lost the time/date reference | Approved | |
In all NCI Editor Tabs except the Edit tab concept name property is not displayed properly | Approved | |
Edit set as default instead of Load Please | Approved | |
“by code” (rdf:ID is meaningless) | Approved | |
Configurability | Approved | |
wiki collaboration | Approved | |
Runtime classification | Approved | |
Results panel callable from the explanation tab | Approved | |
:NAME needs to be added to pull down list of Attributes w/ID in Report Writer | Approved | |
Prevent save of a class that has less than 2 N&S conditions. | Approved |
Bug Fixes
GForge number | Brief description of item | (Approved or Proposed) |
---|---|---|
(make configurable) Default search parameters for Advanced Search are not default for search w/in search | — | |
Prompt - accept and reject icons in 'changed by' panel of 'table' view don't work | — | |
Change of Focus after Retire | — | |
Protege incorrectly exporting names with quotes | — | |
Single quote mark around multi-word parents | — | |
Hierarchy is not refreshing the D when retire concept | — | |
Incorrect unretire functionality | — | |
Tool Tab compression and disappearance | — | |
search string appears empty when invoked from restriction dialog box | — | |
Convert project to format seems to run twice | — | |
Create a restriction with retired individual in premerge only | — | |
lucene search option falls off pull down list not sure of the trigger | — | |
Explanation server syncronization issue with retire action | — | |
protege:readOnly=true behavior is unexpected | — | |
Inconsistant reject button availability | — | |
PROMPT Tree View reject gave null pointer exception | – | |
Legacy_Concept_Name is ReadOnly but will be replicated in copy/split actions | — | |
Legacy_Concept_Name should not transfer during merge | — | |
User's Guide goes to Protege 2000 page | — | |
Cannot change case of PT and PN | — | |
inheritance of role restrictions is no longer working correctly | — | |
Strange behavior on Preferred Name change | — | |
Failure of Lucene to index at runtime | — | |
LQT nested query causes error dialog | — | |
Edit of Preferred_Name does not always sync the NCI PT | — | |
Search using contains is very slow | — | |
Rejection of changes to Retired Concept branch caused deletion of newly retired classes | — | |
Selection of display slot for individuals is not scrollable | — | |
Properties that have spaces cannot be edited in the Edit tab | — | |
identifiable? | — | |
SPCA contrib source | — | |
Error Message displays association error, yet performs edit | — | |
Strange output during Explanation Server restart | — | |
Duplicate Full Syn atom could not be deleted via NCI Editor Tab | — | |
unable to find concept | — | |
Remove hard-coding of LONG_DEFINITION and other deprecated complex properties | — | |
Cannot add role after editing a parent due to loss of focus in class browser | — | |
"Increase or Decrease Font Size" causes Edit Tab increment | — | |
extra prefix string when exporting ALT-DEFINITION and DEFINITION | — | |
report writer fails to produce output | — | |
EditTab not persisting complex properties correctly | — | |
GO_Annotation props not showing in correct panel | — | |
Allows duplicated roles to be added with batch processing | — | |
Different “Reviewer Name” is displayed | — | |
"Delete Parent" is allowed to delete last parent when batch processing. | — | |
OLD_PARENTS and OLD_ROLEs ought to be added simultaneously | — | |
batch delete definitions fails | — | |
“Required field” for FULL_SYN is not enforced when doing Batch Processing. | — | |
“Required field” for DEFINITION or ALT_DEFINITION is not enforced when doing Batch Processing. | — | |
deleting a role takes rdfs:label (preferred name) and should take rdfs:ID | — | |
Trouble with usage of datatype properties | — | |
Spotty Synchronization of NCIEditor Hierarchy with Explanation and OWLClasses Tabs | — | |
Enable the use of rdfs:comment | — | |
New strange behavior on PT change | — | |
Preretire fails if redirect or remove two of the same restrictions pointing to the preretiree | — | |
Generate Report with attributes does not display Definition or FULL_SYN | — | |
AQP export needs to escape comma everywhere | — | |
rename a class and rename it back leads to loss of type information. | — | |
Tabs in Edit Tab Preferences can't be removed. (Tabs in Edit Tab Preferences can't be added). | — | |
"Delete FULL_SYN" in batch processing doesn't work | — | |
Batch delete of Semantic_Type fails | — | |
Need to be able to configure Property Value Query in the LQP | — | |
Performance Issues | — | |
New concept with existing rdf:ID fails to be created, insufficient error message. | — | |
Can only shutdown protege server through the Administer Server GUI | — | |
There is error message when batch processing special characters "& and <" fails. | — | |
Classification Optimization | — | |
Reasoner Error While Classifying in Standalone Mode | — | |
New scenarios that have strange behavior on PT change | — | |
Performance testing | — | |
Preretire causes multiplication of OLD_SOURCE_ROLEs from referencing classes | — | |
Figure out if LQP result display timing is okay for a number of search scenarios. | — | |
LastUsageInvocationHandler being called with a high frequency | — | |
Restrictions drop off when toggling from primitive to defined related to concurrency | — | |
Split and Copy don't work in protege ByCode 1.4.2.174. | — | |
Typo in Batch Load parent causes infinitely repeating exception | — | |
Qualifiers of Complex Properties don't display (ByCode) | — | |
Legacy_Concept_Name ReadOnly works but it is passed to new concepts | — | |
Retired concept is not listed under Retired Concepts | — | |
Changing Preferred name makes 2nd rdfs:label be added. (NCIt - ByCode) | — | |
There is no check-box next to Retire in the "Edit Tab Preferences" | — | |
Cannot Edit Concept assigned in NCI Workflow (NPO) | — | |
java.lang.NullPointerException is displayed in console windows after check /uncheck Copy, Split, Merge, or Retire in Preference. |
| |
Association Edit/Delete failed. | — | |
Does not retain assignment of workflow task from creation dialog | — | |
report writer fails to produce correct output for no attributes | — | |
The record number in the batch log may not match with the "line number" of the input file. | — | |
An invalid value is able to be added into the property Contributing_Source by the batch processing | — | |
Need to use Display slot in Explanation tab panel | — | |
After merge, redirected filler values are not updated by the Explanation Server | — | |
A user was able to premerge two classes into a third class during concurrent editing | — | |
Duplicate restrictions after merge with restriction pointing to surviving concept | – | |
Invalid messagebox/warning to user when modify a concept with N&S restrictions | — | |
Review panel from LQT pane displays class name as "foo" | — | |
Exceptions are thrown when closing "Select a property" dialog-box nested in "Edit an Object-Valued Property" dialog-box. | — |
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 |
---|---|---|
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 vertical. 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 XP, Linux, OS X |
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 | Iteration during which the item |
---|---|---|
search string appears empty when invoked from restriction dialog box | — | |
refactoring namespaces | — | |
Need a fail-safe for creating codes for properties | — | |
Edit tab does not handle & or < properly | — | |
role groups not handled when toggling prim/defined | — | |
(NPO) Association Edit/Delete failed. | — | |
Improved formatting of batch load with error | — | |
When invalid format is provided on a clone it doesn't retain previously entered Definition | — | |
"Create Workflow Task" doesn't work" in 1.4.2.223 ByCode. | — | |
PreMerge "two concepts" after renaming them is not allowed. | — | |
Generate Reports shows undesirable internal values | — | |
Extra box character shows in generated report | — |
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: | |
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 |
---|---|---|
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. |