About

In order to avoid unnecessary duplication of data across institutions, increase standardization, and ease as much of the burden of data entry on users as possible we have introduced a new concept of 'Commonly Used Resources'. This concept has been internally referenced as 'globals' and this is reflected in the choice of property names. These resources will reside in central repository, maintained by the eagle-i team, that all institutions will have read-access to.  As of the 2.0-MS1.0 release, only resources that have a type of Organization are eligible for 'Commonly Used Resources' values.  Specifically, 'Commonly Used Resources' will be generated for the types: Private Company and Funding Organization.

This feature will affect the following applications:

• SWEET: When editing or adding a resource, if there are 'Commonly Used Resources' available for a given field, these will be presented to users at the top of the dropped down list under the heading 'Commonly Used Resources'. 

When a resource contains a reference to a 'Commonly Used Resources', the search application will treat this as a normal resource, which happens to reside in a repository 'global' as opposed to a specific institution.  In this document, the 'client' will be the repository that is receiving the minimal information about global resources into its own proxy graph.  The 'server' will be the repository where the full resource information resides.

Activation

To activate this feature, the following must take place:

Client / Institution:

• Create a user for the repository which has the role of 'Automated Agent', i.e. iAmGlobalUser
  • The Automated Agent role has add, remove, read access to the GlobalProxy graph.
• Add the following properties to the non-credentialed properties file:
  • eaglei.datatools.uses.globals
  • eaglei.datatools.globalRepository

  • \[TODO\] Optional properties

  • \[TODO\] Update properties document

• Add the following properties to the credentialed properties file:

  • \[TODO\]

• Add a new / edit whoami.xml file

  • \[TODO: <global></global>\]

Data Migration

\[TODO\] How to migrate existing data to use the globals 

Advanced Topics

\[TODO\] Details about the implementation

\[TODO\] global annotation on type

\[TODO\] Use of the proxy ng

\[TODO\] Global instances are not searchable as a resource themselves

\[TODO\] NB: Tomcat will appear to take a little bit longer to shut down.  This is expected because of the code for the global harvesting.

Troubleshooting

• I can't see any commonly used resources as options for Private Company and Funding Organization in my SWEET.
  1. Verify that your repository successfully harvested the globals

     1. \[TODO\] expected logs for successful global harvest

  2. Verify that your properties have been configured

     1. \[TODO\] expected logs for correct configuration

     2. \[TODO\] example logs of incorrect configurations