Implementation guide for COAR Controlled Vocabularies

COAR vocabularies can be implemented in repositories operating on DSpace by customising input forms or using the Dspace software functionality.

Figure 1. DSpace workflow approach

DSpace supports controlled vocabularies in search and submission process. Supported controlled vocabularies are expressed in a simple XML format (“DSpace node schema”). All information about a term is enclosed in a element. Only the expression of a hierarchical relationship is allowed through the use of the sub element. By using a simple annotation mechanism becomes possible. Hierarchical Taxonomies and Controlled Vocabularies are well explained in DuraSpace wiki pages. DSpace developer community forums may also helpful for relevant update patches.

In DSpace, you have two options to implement COAR Controlled Vocabularies. Option 1 includes a dropdown list of the fields to allow the submitter to select one option. Option 2 uses the internal controlled vocabularies functionality in DSpace.

Option 1: Dropdown

This option includes a dropdown list of the fields to allow the submitter to select one option. You may find the implementation steps below:

Figure 2. Option 1: Dropdown

1.Create a separate for each community per type inside the input-forms.xml file.

<name-map collection-handle="1111/33333" form-name="book" />

2.Example of the field in input-forms.xml

<field>
<dc-schema>dc</dc-schema>
<dc-element>type</dc-element>
<dc-qualifier></dc-qualifier>
<repeatable>false</repeatable>
<label>Tipo</label>
<input-type value-pairs- name="common_types">dropdown</input- type>
<hint>xyz.</hint>
<required></required>
</field>

3.Provide a way to show (flat term) type name instead of URL eg. Show “software” instead of > http://purl.org/coar/resource_type/c_5ce6

Option 2: Using Dspace Functionality

This option uses the internal functionality of controlled vocabularies in Dspace to present the COAR types. Note that this prototype implementation is valid Dspace version 5 and above. You may find the implementation steps below:

Figure 3. Option 2: Using DSpace Functionality

1.Insert provided coar-types.xml in ${DSpace_HOME}/dspace/config/controlled-vocabularies/

2.Switch in ${DSpace_HOME}/dspace/config/input-forms.xml at dc:type field and change input type for onebox and insert in the same field the tag coar-types, this tag forces the input to be only through the plugin.

3.Example of the field in input-forms.xml:

<field>
<dc-schema>dc</dc-schema>
<dc-element>type</dc-element>
<dc-qualifier></dc-qualifier>
<repeatable>false</repeatable>
<label>Type</label>
<input-type>onebox</input-type>
<hint>Select the type(s) of content of the item. </hint>
<required></required>
<vocabulary closed="true"> coar-types</ vocabulary>
</field>

4.In dspace.cfg Edit the value to “true”: webui.controlledvocabulary.enable = true # allows the use of the controlled vocabularies add-on to allow the tree visualization mode;

5.Add the following lines:

  choices.plugin.dc.type = coar-types # field (dc.type) to use the plugin and name of file with the vocabularies;
  choices.presentation.dc.type = select # field presentation mode;
  vocabulary.plugin.coar.hierarchy.store = true # saves in database the tree hierarchy;
  vocabulary.plugin.coar.hierarchy.suggest = true # show selected type with its hierarchy;
  vocabulary.plugin.coar.delimiter = "::" # delimiter to use between different hierarchic levels;

How to encode it?

Text or figure to be added Provide at least two values: 1. the concept URI – http://purl.org/coar/resource_type/c_6501 2. a label belongs to the concept

Changes required for each implementation

The following table describes the changes in different levels on DSpace regarding each implementation. Repository managers can make all changes or just a basic implementation by changing only the submission process in one of the two options.