alanorth
/
cgspace-java-helpers
mirror of https://github.com/ilri/cgspace-java-helpers.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README.md: Update notes for DSpace 6

This commit is contained in:
Alan Orth 2020-08-05 12:40:55 +03:00
parent 9bf487a336
commit 29f6aff35e
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,7 +3,7 @@ Metadata curation tasks used on the [CGSpace](https://cgspace.cgiar.org) institu
- **CountryCodeTagger**: add ISO 3166-1 Alpha2 country codes to items based on their existing country metadata - **CountryCodeTagger**: add ISO 3166-1 Alpha2 country codes to items based on their existing country metadata
Tested on DSpace 5.8. Read more about the [DSpace curation system](https://wiki.lyrasis.org/display/DSDOC5x/Curation+System). Tested on DSpace 6.3. Read more about the [DSpace curation system](https://wiki.lyrasis.org/display/DSDOC5x/Curation+System).
## Build and Install ## Build and Install
@ -14,7 +14,7 @@ To use these curation tasks in a DSpace project add the following dependency to
<dependency> <dependency>
<groupId>io.github.ilri.cgspace</groupId> <groupId>io.github.ilri.cgspace</groupId>
<artifactId>dspace-curation-tasks</artifactId> <artifactId>dspace-curation-tasks</artifactId>
<version>1.0-SNAPSHOT</version> <version>6.0-SNAPSHOT</version>
</dependency> </dependency>
``` ```
@ -30,33 +30,31 @@ $ mvn package
Copy the resulting jar to the DSpace `lib` directory: Copy the resulting jar to the DSpace `lib` directory:
``` ```
$ cp target/dspace-curation-tasks-1.0-SNAPSHOT.jar ~/dspace/lib/dspace-curation-tasks-1.0-SNAPSHOT.jar $ cp target/dspace-curation-tasks-6.0-SNAPSHOT.jar ~/dspace/lib/dspace-curation-tasks-6.0-SNAPSHOT.jar
``` ```
## Configuration ## Configuration
Add the curation task to DSpace's `config/modules/curate.cfg`: Add the curation task to DSpace's `config/modules/curate.cfg`:
``` ```
plugin.named.org.dspace.curate.CurationTask = \ plugin.named.org.dspace.curate.CurationTask = io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger
... plugin.named.org.dspace.curate.CurationTask = io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger.force
io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger \
io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger.force
``` ```
And then add a configuration file for the task in `config/modules/countrycodetagger.cfg`: And then add the following variables to your `local.cfg` or some other [configuration file that is included](https://wiki.lyrasis.org/display/DSDOC6x/Configuration+Reference#ConfigurationReference-IncludingotherPropertyFiles):
``` ```
# name of the field containing ISO 3166-1 country names # name of the field containing ISO 3166-1 country names
iso3166.field = cg.coverage.country countrycodetagger.iso3166.field = cg.coverage.country
# name of the field containing ISO 3166-1 Alpha2 country codes # name of the field containing ISO 3166-1 Alpha2 country codes
iso3166-alpha2.field = cg.coverage.iso3166-alpha2 countrycodetagger.iso3166-alpha2.field = cg.coverage.iso3166-alpha2
# only add country codes if an item doesn't have any (default false) # only add country codes if an item doesn't have any (default false)
#forceupdate = false #countrycodetagger.forceupdate = false
``` ```
*Note*: DSpace's curation system supports "profiles" where you can use the same task with different options, for example above I have a normal country code tagger and a "force" variant. To use the "force" variant you create a new configuration file with the overridden options in `config/modules/countrycodetagger.force.cfg`. The "force" profile clears all existing country codes and updates everything. *Note*: DSpace's curation system supports "profiles" where you can use the same task with different options, for example above I have a normal country code tagger task and a "force" variant. The "force" variant is the same task, but it looks for configuration variables using the `countrycodetagger.force` instead. To use the "force" variant you simply need to add these new variables with the `forceupdate` parameter overridden to the same configuration file where you put the other variables. The "force" profile clears all existing country codes and updates everything.
## Invocation ## Invocation
Once the jar is installed and you have added appropriate configuration in `~/dspace/config/modules`: Once the jar is installed and you have added appropriate configuration in `~/dspace/config/modules`: