Documentation - NCIEVS/nci-protege5 GitHub Wiki

Evolving documentation. Main page with outline for topics, eventually to become the table of contents with links

Project Administration

  • Server administration tab
  • Server configuration
  • Users, roles, operations, access, projects
  • Configuring a project
  • Configuring a vocabulary

GUI descriptions

Editing

  • Client preferences
  • Creating a class
  • Editing "complex" properties
  • Editing simple properties
    • enums, text, URIs
  • Class expressions
  • Complex operations
    • Retirement
    • Merge
    • Split
    • Copy
  • Batch load
  • Batch editing
  • Classification
  • Lucene search

Reporting

  • Lucene
  • Reportwriter
  • SPARQL

Other panels or tabs

  • Property IRIs
  • Read Only

Workflow management

  • Root node class creation
  • Annotation & object property creation/editing
  • Datatype creation/editing
  • Class retirement
  • Class merge
  • Conflicts & baseline reconciliation & squashing
  • History publication

Workflow management

The operations in this section can only be done by a user with the "Workflow Manager" role, either because we want to restrict the number of people that can execute the operation, e.g. create root nodes, or because an action needs to be approved independently of the user initiating the action, e.g. retirement.

Class Retirement

This operation is initiated by an editor, a workflow modeler. To complete it, it needs to be approved a workflow manager.

Class deletion

The NCI Edit Tab supports deleting classes under limited circumstances. If you wish to delete a class regardless, you will need to delete it in Protege's Entities tab; the edit history record would be incomplete though.

A class can be deleted by a workflow manager in the NCI Edit Tab if

  • it has already been retired, and
  • it has not been published
    • if the class has been published then it can be retired but not deleted

To delete a class, first retire it:

  • Follow the steps for a regular class retirement, either
    • drag the class from the tree widget to the Retire subtab of the NCI Edit Tab,
    • or right click on the class in the tree and select "Retire selected class . . ."
  • The Retire subtab will be populated. If there are dependencies on the class, they will be referenced in the bottom panel of this subtab.
    • The references (e.g. roles, subclass statements, other class expressions) in the dependent classes need to be fixed with appropriate replacements before the class can be retired.

The Retire subtab after populating it with the class to be retired

  • Click on the Retire button.
  • The class will be re-treed under the current active retirement superclass

The tree location showing the class to be retired

  • Click on the Save button

The class can now be deleted

  • Highlight it in the tree widget, and click on the delete icon (a crossed circle) above the tree widget

The retreed class in its retirement location; the Delete icon is the crossed circle above the tree

The class will no longer exist in the terminology. If you examine the editing history in the EVS History tab, you will find the Delete record as well as the Retire record.

Editing history records showing the Retire and the Delete actions