Differences

This shows you the differences between two versions of the page.

--- en:user_advanced:oai_server_gs3 [2018/07/30 22:59] – created kjdon
+++ en:user_advanced:oai_server_gs3 [2023/03/13 01:46] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Greenstone 3 OAI server ======
 The Greenstone3 OAI data provider facility comes enabled by default. It runs as a servlet called "oaiserver", and can be accessed using the same URL as the library,
-by replacing library with oaiserver. For example, ''<nowiki>http://localhost:8080/greenstone3/oaiserver</nowiki>''. You can see a demonstration OAI server at [[http://www.greenstone.org/greenstone3/oaiserver?verb=Identify|http://www.greenstone.org/greenstone3/oaiserver?verb=Identify]].
+by replacing library with oaiserver. For example, ''<nowiki>http://localhost:8080/greenstone3/oaiserver</nowiki>''.
+You can see a demonstration OAI server at [[http://www.greenstone.org/greenstone3/oaiserver?verb=Identify|http://www.greenstone.org/greenstone3/oaiserver?verb=Identify]].
 ==== Configuration ====
@@ Line 100: / Line 105: @@
 	<element name="dc:format"><mapping elements="dc.Format"/></element>
 	<element name="dc:identifier"><mapping elements="dc.Identifier,Identifier" select="firstvalue"/></element>
+        <element name="dc:identifier"><mapping
+        elements="gs.OAIResourceURL,gsflink.source,gsflink.document"
+        select="allvalues"/></element> (available July 2018)
 	<element name="dc:source"><mapping elements="dc.Source"/></element>
 	<element name="dc:language"><mapping elements="dc.Language"/></element>
@@ Line 154: / Line 162: @@
 <code><element name="dc:date"><mapping select="allvalues" elements="dc.Date,gs.Date"/></element></code>
 This will output all dc.Dates and gs.Dates as dc:date.
+=== OAI Identifiers ===
+Prior to July 2018, an extra oai_dc:identifier element was automatically added to the metadata list, containing a link to the document. The values used would be chosen from the following list, using the first available value:
+  * gs.OAIResourceURL - if this metadata was set for a document, this would be used as the identifier URL. This enables you to link to the document outside of Greenstone.
+  * a link to the source document, eg PDF, Word files. (gsf:link type="source">)
+  * a link to the Greenstone version of the document. (<gsf:link>)
+After July 2018, this was modified to be specified via the OAIConfig in the same way as other metadata mappings are specified. **gsflink.source** and **gsflink.document** are keywords specifying the source url and the Greenstone documemnt URL, respectively.
+<code><element name="dc:identifier"><mapping elements="gs.OAIResourceURL,gsflink.source,gsflink.document" select="allvalues"/></element>
+</code>
+This way, users can customize further which identifiers they want - they can use all of them, as the above mapping specifies.
@@ Line 204: / Line 224: @@
 If you have rebuilt collections then you need to reset the server. This can either be done by restarting it (stop the server and run gs3-server.sh/bat again, or run 'ant restart'), or you can reset the server using the reset command: http://localhost:8383/greenstone3/oaiserver?reset. This will make it reload all the collection information again. (Make sure you use the correct host name and port number.)
+====Testing====
+Once you have your OAI service in place, testing can be done via online validation facilities such as the following: http://www.openarchives.org/data/registerasprovider.html or http://re.cs.uct.ac.za/.
+The former only verifies the Identify command, while extensive testing can be performed via the later one (called //Repository Explorer//).
+The Greenstone OAI server must be publically accessible over the Internet to use these validation tools.