This feature is available in version 2.0-MS1.11 and later. |
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 known as Commonly Used Resources. This feature alleviates the need for duplication of common resources in each institutional node: rather than linking a record to a locally-created instance of a very common resource, users may now link to an instance in a centrally-curated collection that resides in a dedicated 'global' repository. This eliminates the need for locally-created copies of common resources such as major manufacturers and government agencies.
This concept has been internally referenced as 'globals' and this is reflected in the choice of configuration property names. These resources will reside in a central repository that is maintained by the eagle-i team, although all institutions will have read-access to it. We strongly encourage users to select from Commonly Used Resources wherever appropriate when entering data in SWEET.
As of the 2.0-MS1.11 release, only resources that link to the following resource types are affected by the implementation of theĀ Commonly Used Resources:
Once the SWEET application has been configured to use Commonly Used Resources, the application will periodically query the Commonly Used Resources data repository for a minimal set (label and URI) of information from the published data. SWEET will then place a local copy of this minimal set of information in its own data repository, in a specialized graph (NG_GlobalProxy
). Subsequent uses of SWEET will present selections for the user from this specialized graph, as well as the default and published graphs.
In fields that have one of the above mentioned types as a range, users will now see a new group of listings at the top:
Resources that are not Commonly Used Resources will be listed at the bottom:
From the perspective of the other eagle-i applications (such as search or dissemination pages), there is no visible effect. The triples containing the Commonly Used Resources will contain an object value that will be resolved by the 'global' repository.
|
To start using this feature in your institution's installation, please follow these steps:
NG_GlobalProxy
graph in the institution's data repository. See creating repository users for details on how to create a new user.
Automated Agent
. In this example, the username for the new user is GlobalUser
and the password is GlobalPw
. We will be referring to this new user in other parts of this section.
${EAGLE_I_HOME
}, in the conf
directory and in the .config
directory.
eagle-i-apps-credentials.properties
.config
directory of the ${EAGLE_I_HOME
} directory, e.g. /opt/eaglei/.config/eagle-i-apps-credentials.properties
.
eagle-i-apps-credentials.properties
file:
# GLOBAL SERVICE eaglei.datatools.globals.user=GlobalUser eaglei.datatools.globals.password=GlobalPw |
eagle-i-apps.properties
conf
directory of the ${EAGLE_I_HOME
} directory, e.g. /opt/eaglei/conf/eagle-i-apps.properties
.
eagle-i-apps.properties
file:
## -- GLOBALS -- # True if datatools needs to reach out to a global repository; Default is FALSE. # NB: If setting this to true, be sure to add the other properties that are needed # for configuring the global repository communication eaglei.datatools.uses.globals=true # the URL where the global data repository resides eaglei.datatools.globalRepository.url=https://global.eagle-i.net |
NG_GlobalProxy
with data from Commonly Used Resources repository, add the following lines to the eagle-i-apps.properties
file:
# the frequency to perform the polling for global information eaglei.datatools.globalPolling.frequency=12 # the time unit for the frequency, *must* be one of java.util.concurrent.TimeUnit # [DAYS, HOURS, MINUTES, SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS] eaglei.datatools.globalPolling.unit=HOURS ## -- END GLOBALS -- |
whoami.xml
whoami.xml
file, after the <local>
tag:
<global url="http://global.eagle-i.net"> <institutionList> <institution URI="http://purl.org/eagle-i/app-ext/#ERO_0000065_29" graphURI="test29"> <namespace>global.eagle-i.net</namespace> <logoSrc>images/logo_global.png</logoSrc> </institution> </institutionList> </global> |
whoami.xml
file with the new information about the Commonly Used Resources:
<?xml version="1.0" encoding="UTF-8"?> <local> <global url="http://global.eagle-i.net"> <institutionList> <institution URI="http://purl.org/eagle-i/app-ext/#ERO_0000065_29"> <namespace>global.eagle-i.net</namespace> <logoSrc>images/logo_global.png</logoSrc> </institution> </institutionList> </global> <node url="http://foo.bar.edu"> <institutionList> <institution URI="http://purl.org/eagle-i/app-ext/#ERO_0000065_3" graphURI="test3"> <namespace>foo.bar.edu</namespace> <label>Furry Object Orientation University</label> <logoSrc>images/logo_foo.png</logoSrc> </institution> </institutionList> </node> </local> |
At this time, if there is not a Commonly Used Resources that corresponds to your needs, you may still create locally instances of private companies and government agencies. We will periodically update the Commonly Used Resources and provide updated data migration files to reflect this.
If your institution is not one of the eagle-i network institutions (i.e. connected to central search prior to April 1, 2013), please contact us for assistance to migrate your data. |
To completely integrate the Commonly Used Resources within the institution's data repository, the existing data in the repository needs to be migrated.
cd /opt/eaglei/repo/etc |
globals-migration.sh
script. You will need to know the administrative credentials for the repository. In the following example, we assume the username for the administrative user is adminUser
and the password is adminPw
. We also assume that the url for the repository is http://foo.bar.edu
bash globals-migration.sh adminUser adminPw http://foo.bar.edu |
To verify that you have configured Commonly Used Resources correctly for SWEET, try to enter a new Instrument. When selecting a Manufacturer, you should see a group of manufacturers under the heading of Commonly Used Resources
(see image in SWEET - Entering Data).
If you have installed institution search and you have successfully migrated your data, you will not notice a difference in the resource's instance page. However, when you click through to a Commonly Used Resource, you will notice that the logo is no longer your institution's logo, but the logo for the Commonly Used Resources data repository.
You will not notice a difference in the resource's instance page. However, when you click through to a Commonly Used Resource, you will notice that the logo is no longer your institution's logo, but the logo for the Commonly Used Resources data repository.