OAI - Revision history

Adb1a11@ecs.soton.ac.uk: Typos

2012-06-15T09:38:26Z

Typos

← Older revision		Revision as of 09:38, 15 June 2012
Line 5:		Line 5:
	====Configuring====		====Configuring====

	The setting for OAI are held in the <tt>oai.pl</tt> file, in the <tt>eprints3/archives/<archive id>/cfg/cfg.d/</tt> directory. This is a perl file, but don't let that daunt you. Some of the settings are set to sensible defaults. This guide ~~cover~~ the essentials. Feel free to use your favourite text editor instead of pico.		The setting for OAI are held in the <tt>oai.pl</tt> file, in the <tt>eprints3/archives/<archive id>/cfg/cfg.d/</tt> directory. This is a perl file, but don't let that daunt you. Some of the settings are set to sensible defaults. This guide covers the essentials. Feel free to use your favourite text editor instead of pico.

	At the command prompt, backup then open the file:		At the command prompt, backup then open the file:
Line 27:		Line 27:

	<strong>Policies</strong>		<strong>Policies</strong>
	Next you need to define a number of policies which will define how your repository may be used. It may be helpful for you to visit http://www.opendoar.org/tools/en/policies.php which has a step-by-step process to create these policies. It will even output EPrints 3 configuration code. which you can then copy and paste into the oai.pl file. These policies are:		Next you need to define a number of policies which will define how your repository may be used. It may be helpful for you to visit http://www.opendoar.org/tools/en/policies.php, which has a step-by-step process to create these policies. It will even output EPrints 3 configuration code, which you can then copy and paste into the oai.pl file. These policies are:

	* Metadata Policy		* Metadata Policy

Pm705 at 12:37, 20 March 2010

2010-03-20T12:37:57Z

← Older revision		Revision as of 12:37, 20 March 2010
Line 1:		Line 1:
	[[Category:~~Configuration~~]]		[[Category:Howto]]
	[[Category:OpenAccess]]		[[Category:OpenAccess]]
	We would also encourage you to configure the OAI support for your archive and register it.		We would also encourage you to configure the OAI support for your archive and register it.

Pm705 at 16:36, 8 February 2010

2010-02-08T16:36:51Z

← Older revision		Revision as of 16:36, 8 February 2010
Line 1:		Line 1:
			[[Category:Configuration]]
			[[Category:OpenAccess]]
	We would also encourage you to configure the OAI support for your archive and register it.		We would also encourage you to configure the OAI support for your archive and register it.

DaveTarrant at 14:21, 3 September 2007

2007-09-03T14:21:10Z

← Older revision		Revision as of 14:21, 3 September 2007
Line 1:		Line 1:
	~~===OAI===~~
	We would also encourage you to configure the OAI support for your archive and register it.		We would also encourage you to configure the OAI support for your archive and register it.

DaveTarrant at 14:21, 3 September 2007

2007-09-03T14:21:02Z

New page

===OAI===
We would also encourage you to configure the OAI support for your archive and register it.

====Configuring====

The setting for OAI are held in the <tt>oai.pl</tt> file, in the <tt>eprints3/archives/<archive id>/cfg/cfg.d/</tt> directory. This is a perl file, but don't let that daunt you. Some of the settings are set to sensible defaults. This guide cover the essentials. Feel free to use your favourite text editor instead of pico.

At the command prompt, backup then open the file:
>cd /opt/eprints3/archive/<archive id>/cfg/cfg.d
>cp oai.pl oai.backup
>pico oai.pl

The following need to be changed:

The archive ID. This needs to be unique, so check that it doesn't already exist at http://www.openarchives.org/.

Find the following line in oai.pl:
$oai->{v2}->{archive_id} = "generic.eprints.org";
And change generic.eprints.org to something which identifies your repository.

Content Description. What does your repository contain? Write a description, then find the lines:
$oai->{content}->{"text"} = latin1( <<END );
OAI Site description has not been configured.
END
Do not modify the first or last line in any way. Simply put your new text in the place of the middle line. This text can be as many lines as you wish, but it must not contain the word "END" at the start of a line.

Policies
Next you need to define a number of policies which will define how your repository may be used. It may be helpful for you to visit http://www.opendoar.org/tools/en/policies.php which has a step-by-step process to create these policies. It will even output EPrints 3 configuration code. which you can then copy and paste into the oai.pl file. These policies are:

* Metadata Policy
* Data Policy
* Submission Policy

These are updated in exactly the same way as the Content Description section. Just look for the following lines:

*$oai->{metadata_policy}->{"text"} = latin1( <<END );
*$oai->{data_policy}->{"text"} = latin1( <<END );
*$oai->{submission_policy}->{"text"} = latin1( <<END );

====Registering====

Once you register your archive (at http://www.openarchives.org) various search systems will be able to collect the metadata (titles, authors, abstract etc.) and allow more people to find records in your archive.

See http://www.openarchives.org/ for more information on the OAI protocol. For more information setting up the OAI interface archive see the section in this documentation about Configuring an Archive.