Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changed to use local-node.xml, updating to simplify for new defaults.

...

  1. Create a new user to the data repository
    In order for the SWEET application to locally cache the minimal information about Centrally Curated Resources in the institution's data repository, a new user needs to be created that has the ability to add, remove, and read the NG_GlobalProxy graph in the institution's data repository. See creating repository users for details on how to create a new user.

    • Create a new user with a role of 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.

  2. Edit configuration files
    The next step is to edit the configuration files to tell the applications what credentials SWEET should use to cache the Centrally Curated Resources data locally, how often should SWEET update its Centrally Curated Resources data, and where to find the Centrally Curated Resources. For this step, we will be editing the configuration files that are located in the eagle-i home directory, ${EAGLE_I_HOME}, in the conf directory and in the .config directory.

    1. eagle-i-apps-credentials.properties
      To let the SWEET application know the credentials for this new user, a new set of properties needs to be added to the credentials property file. This file is located in the .config directory of the ${EAGLE_I_HOME} directory, e.g. /opt/eaglei/.config/eagle-i-apps-credentials.properties.

      Add the following lines to the eagle-i-apps-credentials.propertiesfile:

      Code Block
      languagenone
      # GLOBAL SERVICE
      eaglei.datatools.globals.user=GlobalUser
      eaglei.datatools.globals.password=GlobalPw
      


      Please substitute the username and password that you have created for the example ones.

    2. eagle-i-apps.properties
      This file is located in the conf directory of the ${EAGLE_I_HOME} directory, e.g. /opt/eaglei/conf/eagle-i-apps.properties.

      To let the applications know to use Centrally Curated Resources data repository and where that repository is, add the following lines to the eagle-i-apps.propertiesfile:

      Code Block
      languagenone
      ## -- 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=no longer needs to specify any configurations.  The defaults have been updated to always require the use of the Centrally Curated Resources and the location of the Centrally Curated Resourcesrepository is defaulted to be https://global.eagle-i.net.  If desired, the polling frequency can be adjusted with the following properties:
      • To let SWEET know how often it should update its NG_GlobalProxy with data from Centrally Curated Resources repository, add the following lines to the eagle-i-apps.propertiesfile:

        Code Block
        # 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 --
        

        You can tweak the frequency as you see fit, however we recommend 12 hours as the polling frequency.

    3. whoamilocal-node.xml
      Insert the following snippet at the beginning of your whoamilocal-node.xml file, after the <local>tag:

      Code Block
      languagexml
      <global urlURL="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>
      

      Here is an example of a complete whoamilocal-node.xml file with the new information about the Centrally Curated Resources:

      Code Block
      languagexml
      <?xml version="1.0" encoding="UTF-8"?>
      <local>
              <global urlURL="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>
      
  3. Restart tomcat
    Finally, restart tomcat to pick up the changes to the configuration files.

...