Versions Compared

Key

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

...

Storage of related metadata

ORCID authorities not only link a digital identifier to a name. It regroups a load of metadata going from alternative names and email addresses to keywords about their works and much more. In order to avoid querying the ORCID web services every time for some information, all these related metadata is gathered in a "metadata authority cache" that DSpace can access directly.

In practice the cache is provided by an apache solr server. When a look-up is made and an author is chosen that is not yet in the cache, a record is created from an ORCID profile and added to the cache with the list of related metadata. The value of the Dublin Core metadata is based on the first and last name as they are set in the ORCID profile. The authority key for this value links directly to the solr document's id.

The information in the authority cache can be updated by running the following command line operation:

[dspace]/bin/dspace dsrun org.dspace.authority.UpdateAuthorities

This will iterate over every solr record currently in use, query the ORCID web service for the latest data and update the information in the cache. If configured, the script will also update the metadata of the items in the repository where applicable.

Configuration - wip

In the Enabling the ORCID authority control section, you have been told to add this block of configuration.

...

  • With the authority.controlled property every metadata field that needs to be authority controlled is configured. This involves every type of authority control, not only the fields for ORCID integration.
  • The choices.plugin should be configured for each metadata field under authority control. Setting the value on SolrAuthorAuthority tells DSpace to use the solr authority cache for this metadatafield, cfr. Storage of related metadata.
  • The choices.presention should be configured for each metadata field as well. The traditional values for this property are select|suggest|lookup. A new value, authorLookup, has been added to be used in combination with the SolrAuthorAuthority choices plugin. While the other values can still be used, the authorLookup provides a richer user interface in the form of a popup on the submission page.
  • More existing configuration properties are available but their values are independent of this feature and their default values are usually fine: choices.closed, authority.required, authority.minconfidence.

For the cache update script, one property can be set in config/modules/solrauthority.cfg:

Code Block
auto-update-items = false | true

The default value for when the property is missing is false.

Changes to the configuration always require a server restart before they're in effect.