All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Page History
...
This documentation explains the features and the usage of the importer framework.
Enabling the framework can be achieved by uncommenting the following step in item-submission.xml.
Implementation specific or additional configuration can be found in their related documentation, if any.
Please refer to subdivisions of this documentation for specific implementations of the framework.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<step>
<heading>submit.progressbar.lookup</heading>
<processing-class>org.dspace.submit.step.XMLUIStartSubmissionLookupStep</processing-class>
<jspui-binding>org.dspace.app.webui.submit.step.JSPStartSubmissionLookupStep</jspui-binding>
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.StartSubmissionLookupStep</xmlui-binding>
<workflow-editable>true</workflow-editable>
</step> |
Features
- lookup publications from remote sources
- Support for multiple implementations
...
The importer framework does not enforce a specific input format. Each importer implementation defines which input format it expects from a remote source. The import framework uses generics to achieve this. Each importer implementation will have a type set of the record type it receives from the remote source's response. This type set will also be used by the framework to use the correct MetadataFieldMapping for a certain implementation. Read Implementation of an import source for more information and how to enable the framework.
Transformation to DSpace item
...
Note that the single field mappings used for the combined author mapping are not added to this list.
Framework Sources Implementations
Pubmed Integration
Introduction
First read the base documentation on external importing This documentation explains the implementation of the importer framework using pubmed as an example.
The configuration done for pubmed specifically is located at pubmed-integration.xml in dspace/config/spring/api I will not go into detail to what exactly is configured for the pubmed integration as it is simply a usage of the classes explained here
Enabling pubmed
The pubmed specific integration of the external sources import requires the following to be active.
The pubmed lookup is done during the "XMLUIStartSubmissionLookupStep" and this can be enabled by adjusting 1 step in the item-submission.xml
Uncommenting this step will enable permit the user to do the pubmed based lookups during their submission submission.
The pubmed lookup is done during the "XMLUIStartSubmissionLookupStep" and this can be enabled by adjusting 1 step in the item-submission.xml
Uncommenting this step will enable permit the user to do the pubmed based lookups during their submission submission.
| Code Block | ||
|---|---|---|
| ||
<!-- Find publications based on ID/DOI/Title/Author to pre-fill the submission
<step>
<heading>submit.progressbar.lookup</heading>
<processing-class>org.dspace.submit.step.XMLUIStartSubmissionLookupStep</processing-class>
<jspui-binding>org.dspace.app.webui.submit.step.JSPStartSubmissionLookupStep</jspui-binding>
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.StartSubmissionLookupStep</xmlui-binding>
<workflow-editable>true</workflow-editable>
</step>
--> |
Additional Config
To be able to do the lookup for our configured import-service, we need to be able to know what url to use to check for publications. This can be done by setting the publication.url property though maven using 2 different ways.
- Setting the publication.url property to the address as defined in the configured importservice (PubmedImportService in this case) in the file spring-dspace-addon-import-services.xml. This will check this single configured url for publications.
- Setting the publication url property to an askterisk '*'. This will check all configured importServices for their urls to base the search for publications on.
Pubmed specific classes Config
These classes are simply implementations based of the base classes defined in importer/external. They add characteristic behaviour for services/mapping for the pubmed specific data.
Metadata mapping classes
- "PubmedFieldMapping". An implementation of AbstractMetadataFieldMapping, linking to the bean that serves as the entry point of other metadata mapping
- "PubmedDateMetadatumContributor"/"PubmedLanguageMetadatumContributor". Pubmed specific implementations of the "MetadataContributor" interface
Service classes
...
Overview
Content Tools