Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents

Table of Contents
maxLevel3

About

We recognize that institutions may need to annotate their resources with information that is specific to their institution and would not apply to all the institutions in the network.  One example of such a description could be an internal billing code to use for a core service. It would not be efficient to include this information in the eagle-i ontology if it only pertains to one institution, and may in fact lead to confusion about the use of the field by other institutions.

To address this need, we are introducing in this release the concept of 'Institution Specific Annotation'.  This feature will allow institutions to do just this by including an owl file in the configuration directory and adding two properties to the eagle-i-apps.properties file.  These additional ontological properties will be incorporated with the eagle-i ontology only within the scope of the institution's deployment.  

Info
titlePlease note the following
  1. The institution specific annotations will be applied to all resource types
  2. Only datatype properties are allowed.
  3. This is an advanced feature and we recommend that you contact us to assist in the use of the feature.

This feature, if used, will have the following visibility in the applications Wiki MarkupThis feature, if used, will affect the following applications \[<span style="color: #339966">annotation is viewable</span>, <span style="color: #800000">annotation is not viewable</span>\]:

SWEET - Entering data

  • A new section will appear between the end of the standard eagle-i fields and before the comments and curator notes sections. 
    Image Modified
  •  

  • SWEET - Viewing data
    • If institution specific information has been entered for a resource, this will be displayed in its own section just before the Metatdata section.
      Image Modified

  • SEARCH - Institution
    • If you have installed the institution search application, and the institution specific information has been entered for a resource, this will be displayed at the end Image Modified

  • DISSEMINATION SEARCH - Central
    • Any institution specific information that is associated with an institution's resource will not be be viewable from the resource's dissemination page
      Image Added

Institution specific annotations will not be visible in the central search application:

  • SEARCH - Central
      Image Removed
    DISSEMINATION
    • Any institution specific information that is associated with an institution's resource will be not be viewable from the resource's dissemination page Image Removed

Please note:

  • The institution specific properties will be applied to all resource types and only datatype properties are allowed.
  • This is an advanced feature and we recommend that you contact us to assist in the use of the feature.
    • central search application
      Image Added

Use

To use this feature:

  • Generate an owl file.
    • A sample owl file with several datatypes can be found in our examples folder:
      Code Block
      /eagle-i-base/examples/config-files/institution-specific-annotations.owl
      
    • NB: Only datatype properties are allowed at this time
  • Place the owl file in your eagle-i configuration folder.  This is usually
    Code Block
    ~tomcatX/eaglei/conf/
    
  • Edit the eagle-i-apps.properties file and add the following properties:
    • eaglei.model.jena.localSource
      • This is the name of your owl file
    • eaglei.model.jena.localIri
      • This is the IRI for your owl file