Page History
Info | ||
---|---|---|
| ||
Please note that ORCID API 1.2 was turned off on August 1, 2018. To use the current ORCID API 2.x, you will need DSpace 5.9 or DSpace 6.3 or newer. Details: DS-3447. |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
...
Enabling the ORCID authority control
Warning | ||
---|---|---|
| ||
In DSpace 5.0 , the functionality only includes user interface functionality for the DSpace XML User Interface. | ||
Warning | ||
| ||
In DSpace 5.0 the functionality only adds adds support for the XMLUI Mirage and Mirage 2 themes. Older XMLUI themes including Kubrick, Reference and Classic are currently unsupported. |
...
Code Block |
---|
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester |
Importing existing authors & keeping the index up to date
...
Running this script again will update the index and keep the index clean. For example if an author occurs in a single item and that item is deleted the script will need to be run again to remove it from the index. When run again it will remove all records that no longer have a link to existing authors in the database.
Submission of new DSpace items - Author lookup
...
For each of the ORCID authors a lookup will be done and their names will be added to the metadata. All the non-ORCID authors will be added as well. The authority keys and solr records are added when the reported changes are applied.
Storage of related metadata
...
The information in the authority cache can be updated by running the following command line operation:
Command used: |
| |
Arguments | description |
-i | update specific solr records with the given internal ids (comma-separated) |
-h | prints this help message |
This will iterate over every solr record currently in use (unless the -i argument is provided), 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.
The configuration property can be set in config/modules/solrauthority.cfg
:, or overridden in your local.cfg
(see Configuration Reference).
Code Block |
---|
solrauthority.auto-update-items = false | true |
When set to true and this is script is run, if an authority record's information is updated the whole repository will be scanned for this authority. Every metadata field with this authority key will be updated with the value of the updated authority record.
Configuration
...
be updated with the value of the updated authority record.
Configuration
In the Enabling the ORCID authority control section, you have been told to add this block of configuration.
Info | ||
---|---|---|
| ||
For all of the configuration options described below, you can use either dspace.cfg or local.cfg. Either will work. It is possible that, when you compile your code with Maven, and you have tests enabled, your build will fail. DSpace unit tests utilize parts of dspace.cfg, and the configuration options you will utilize below are known to cause unit test errors. The easiest way to avoid this situation is to use the local.cfg file. |
Code Block |
---|
solr.authority.server=${solr.server}/authority choices.plugin.dc.contributor.author = SolrAuthorAuthority choices.presentation.dc.contributor.author = authorLookup authority.controlled.dc.contributor.author = true authority.author.indexer.field.1=dc.contributor.author |
...
- 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 areselect|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. - The browse indexes need to point to the new authority-controlled index:
webui.browse.index.2 = author:metadata:dc.contributor.*,dc.creator:text
should become webui.browse.index.2 = author:metadataAuthority:dc.contributor.author:textauthority - 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
...
Code Block |
---|
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester |
Without the consumer there is no automatic indexing of the authority cache and the metadata will not even have authority keys.
...