Versions Compared

Key

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

Introduction
A new version of the eagle-i applications is now available for download. The release notes documented on this page apply specifically to version 2.0 MS 3.073.0.6.

Please note that we have moved to a more conventional approach for our version numbering scheme.  We are now using the format of: [major].[minor].[patch].  Also note that this is a major release and we are not guaranteeing backwards compatibility with previous versions.

How to use this document
Notes for this release are broken out into five categories: #Bug fixes, #Improvements/New Features, #Known Issues, #Prerequisites for Upgrading & #Deprecated Properties 3.0.6 Release Notes, 3.0.6 Release Notes, 3.0.6 Release Notes, 3.0.6 Release Notes & 3.0.6 Release Notes. Within each category, notes are further divided into the application that is affected. If you are unsure what applications are applicable for your installation, please refer to this page.

...

  1. Update configuration files (#Prerequisites for Upgrading3.0.6 Release Notes)
  2. Upgrade repository (Repository Installation, Upgrade and Administration Guide#UpgradeGuide)
  3. Upgrade applications (SWEET and Institutional Search Installation and Upgrade Guide#UpgradeGuide)

...

Table of Contents

Bug fixes

  • General

    • Redirects no longer cause error (e.g. http redirecting to https)
    • Feedback form is now fully visible without needing to scroll
    • Resources of the type "Clinical Organization" are now showing in search results as well as in the SWEET workbench.
  • SWEET application

    • Now able to save records when using Internet Explorer
  • Search application (Institution and Central)

    • Use of HTML tags for super & subscripts are now correctly displayed.
  • Network Administration (Central Search Only)

    • Removed dependency on a local-node.xml file (previously named whoami.xml)
  • Tools

    • Datamanagement now accepts "http://localhost" as a valid target repository parameter (used in data migration scripts)

Improvements/New Features

  • Search application (Central)

    • Fixed several issues related to requesting a resource:

      • [SOFT-1315] Close button for the email preview is sometimes hidden and inaccessible in Firefox and IE

      • [SOFT-1310] While waiting for a request to be submitted, the screen is nearly blacked out in IE.

      • [SOFT-1386] Intermittent incomplete reset of request resource forms.

      • [SOFT-1391] Typing in the partial name of a location should return the same results as the full name, e.g. “Flying” and “Flying Kittens Lab” should return the same result set.

Improvements/New Features

  • General

    • new feature Ontology is now ISF compliant

    • new feature Extensive ontology modelling for induced pluripotent stem cells.
    • new feature Browse page [help need text]
    • new feature Institution logo on application can now be customized.  In the past, clicking on the institution logo brought users to the eagle-i.net home page. To customize, add the following property to the eagle-i-apps.properties file (replace https://www.eagle-i.net with the link of your choice):

    • new feature Citations that refer to resources that have been withdrawn or returned to curation are now resolvable.  The dissemination pages that these resources resolve to have been styled differently than published resources.

    • improvement Improved error page for unresolvable eagle-i URIs

    • improvement Now using Apache HttpClient 4.3

  • SWEET application

    • improvement Username and password for the training site (https://training.eagle-i.net/sweet/) has been added to the header for ease of use.

    • improvement Checkboxes have been replaced with a dropdown. Now it is possible to differentiate between an unknown value versus an explicit no value

  • General

    • improvement Data with non-UTF-8 characters are now correctly displayed (e.g. MS Word smart quotes)
    • improvement The feedback form now uses email. It is no longer dependent on the JIRA API.
  • SWEET application

    improvement Entering data as a user with the role of "admin" no longer inserts spurious triples into the data. NOTE: We very strongly recommend that users with the role of "admin" should not be entering data. If required, a second user account should be created instead
    • .

  • Search application (Institution and Central)

    • new feature

    "Cite This Resource" button added for ease of finding the resource ID.
  • improvement The contact button has been moved for better visibility and the text display is now conditional on the resource type being displayed.
  • improvementThe decision process for who to contact for a resource has been improved:
    1. Contact the person specified for this resource as the contact person. If this is not specified or no valid email is provided, then
    2. Contact the general email for the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    3. Contact the person specified as the contact person for the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    4. Contact the PI for the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    5. Contact the Co-PI for the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    6. Contact the Director for the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    7. Contact any person that is a member of the lab that the resource belongs to. If this is not specified or no valid email is provided, then
    8. Contact the eagle-i-postmaster
    • Browse functionality for the resource type filters:

      • Users are now able to explore the resource type hierarchy without triggering a search by using the + or - buttons next to the resource type label (where available).

      • After applying a resource type filter to a search, the type hierarchy for the selected resource type will remain visible.

    • new feature Shortcuts to selected resource types have been added:

      • Quick Filters: Applies the specified resource type to the current search

      • All Filters: Clears the current search and displays all the resources for the specified type.

    • new feature Sticky filters for a search:

      • Filters that have been added to a search will not get cleared if the text being searched for is changed.

      • Clear all filters link now provided. This will clear only the filters. Any search text that has been searched on will remain.

    • new feature A configurable announcement panel has been added to the left hand side of the display.

    • improvement Changes displayed text on the search page

    • improvement Instance pages for the search results have been redesigned to better display a larger number of resources.

    • improvement Removal of misleading categorization of resource type suggestions in the search box.

  • Search Application (Central)

    • improvement Usability of the institution select window:

      • Users are now able to double click in the institution select window to add institutions to the selected lists.

      • Users are now able to select multiple institutions to add to the selected list.

    • improvement Better user error messages on the provider response to a request form

    Search Application (Central)

    improvement Instance pages should load faster now
    • .

  • Network Administration (Central Search Only)

    • improvement

    Easier to administer the network:
    • Consistency of how institution names are handled by the network admin console.

    •  improvement Better usability of the network admin console
  • Node registry application has been folded into the central application to improve robustness.
  • Now able to add a node to a specific group via the network admin page. To add a node to an existing group, the group name needs to be identical (includes case sensitivity and possible leading/trailing whitespaces). A new group will be created for the node if the group name does not already exist
    • .

Known Issues

Note

The following are known issues that may be addressed in future releases. If there is a suitable workaround for a given issue, it will be listed.

  • General

    • When using drop down boxes in Chrome, it is not possible to jump to an entry by typing the first few letters. (No workaround)
  • SWEET

    • It is possible to save records with unnamed embedded instances. Doing so results in losing any information entered for the embedded instances. (No workaround)
    • If more than one organization record has the same exact name, only one of them will be displayed in the "Work With My Organizations" dropdown. (No workaround)
  • Search application (Institution and Central)

    • Entering text with square brackets, [ & ], in the search box will execute a blank search, rather than searching for the text. (No workaround)
    • "Cite This Resource" - The keyboard shortcut for copying does not work in Firefox or Chrome. Workaround:
      • Use the Copy from the browser's menu bar or from the popup while right clicking.
  • Network Administration (Central Only)

    • There is no direct way to remove a node (institution) from a group. Workaround:
      1. Edit the node
      2. Take the node out of service
      3. Save
      4. Edit the node again
      5. Put the node back into service
      6. Save
    • There is no direct way to change the group a node belongs to. Workaround:
      1. Edit the node
      2. Take the node out of service
      3. Save
      4. Edit the node again
      5. Enter a new name for the group
      6. Put the node back into service
      7. Save
  • Incomplete records displayed in central search if no upgrade is done.

Extensive work has gone into our ontology for this release to bring eagle-i to ISF compliance, in addition to enhancing the modelling for induced pluripotent stem cell types.  If existing data is not migrated to the new ontology, the central search application may not be able to interpret/recognize obsolete ontological properties and will not display them

Prerequisites for Upgrading

Warning

The following changes need to be done to upgrade to this version. These changes are not compatible with prior versions of the software.

  • Consolidation of properties related to configuring how emails should be sent (message transfer agent)

There are several types of email that can be sent by the various applications.  Previously, each of these email types had separate properties for configuring how the emails should be sent, in addition to the email address that should be used.  In an attempt to simplify our configuration files, we have consolidated these properties.  There is now one set of properties to configure how an email should be sent.  Each email type will still be able to specify its own email address.

    • The new configuration properties to use are:
      • eaglei.email.mta.host (no default)
      • eaglei.email.mta.port (defaults to 25)
      • eaglei.email.mta.ssl (defaults to false)
      • eaglei.email.mta.username (defaults to an empty string)
      • eaglei.email.mta.password (defaults to an empty string)
      • eaglei.email.postmaster (no default, the 'from' address)
      • eaglei.email.postmaster.name (no default, the 'from' name)
      • eaglei.email.feedback (no default, the feedback 'to' address)
  • General configuration file(s) for all applications

    • eagle-i-apps.properties - new required properties
      • eaglei.feedback.email.host
      • eaglei.feedback.email.from
      • eaglei.feedback.email.to
  • Node configuration file(s) (for SWEET & Institution Search applications)

    whoami.xml
  • File needs to be renamed "local-node.xml"
  • Within this file, change

    Code Block
    <node url="https://some.institution.edu">

    with

    Code Block
    <node URL="https://some.institution.edu">
    Please note that this is case sensitive.

Deprecated Properties

Info

The following properties have been deprecated and can be removed from the properties file to avoid confusion.

  • eagle-i-apps.properties

    • eaglei.datatools.uses.globals
    • eaglei.datatools.
      repository
      globalRepository.url
    • eaglei.
      ui
      feedback.
      ontologyBrowser
      jira.url
    • eaglei
      .noderegistry.url
    • eaglei.identity.url

    configuration.properties

    • .feedback.jira.user
    • eaglei.feedback.email.host
    • eaglei.feedback.email.port
    • eaglei.feedback.email.ssl
    • eaglei.feedback.email.user
    • eaglei.feedback.email.password
    • eaglei.feedback.email.from
    • eaglei.feedback.email.to
    • eaglei.tributary.smtp.host
    • eaglei.tributary.smtp.port
    • eaglei.tributary.smtp.user
    • eaglei.tributary.smtp.password
    • eaglei.tributary.smtp.starttls.enable
    • eaglei.tributary.response.email.from
    • eaglei.tributary.response.email.from.name
    • eaglei.services.user
    • eaglei.services.password
      eaglei.repository.index.url