SWORD 2.0 - Revision history

Kgoetz: Change category Developer to Contribute

2018-09-11T23:49:31Z

Change category Developer to Contribute

2018-08-30T06:17:44Z

HowTo -> Howto

2018-08-30T06:15:09Z

add categories

2015-01-21T15:10:09Z

← Older revision		Revision as of 15:10, 21 January 2015
Line 227:		Line 227:
	} ## end sub parse_epdcx_xml_data		} ## end sub parse_epdcx_xml_data

			</pre>

			==Depositing (from Perl)==

			A SWORD deposit is, at its most basic level, just an HTTP POST request, so can be scripted fairly easily.

			This is an example of an initial deposit, where the content being posted is a bespoke format

			<pre>
			# $ep is eprint to transfer
			my $ua = LWP::UserAgent->new;
			my $auth = "Basic " . MIME::Base64::encode( "$username:$password", '' );

			my %headers = (
			'X-No-Op' => 'false',
			'X-Verbose' => 'true',
			'Content-Disposition' => "filename=$filename", # The name of the "file" to be importer things its reading
			'Content-Type' => $mime, # This triggers what parses the content. eg: application/vnd.rjbroker
			'User-Agent' => 'OA-RJ Broker v0.2',
			'Authorization' => $auth,
			);

			if ($in_progress) {
			$headers{'in_progress'} = 'true' # Pushes into "inbox" rather than "review"
			}

			my $url = "${host}${collection}"; # eg: http://eprints.example.com/id/contents
			my $buffer = $ep->export($exporter) # eg: Bespoke_Export_Routine (as in EPrints::Export::Bespoke_Export_Routine)

			my $r = $ua->post( $url, %headers, Content => $buffer );
			if ( $r->is_success ) {
			# Transferred
			my $content = $r->content;
			my $return_id;
			if ( $content =~ m#<id>([^<]+)</id># ) {
			$return_id = $1 if $1;
			}
			} else {
			# fail
			}
	</pre>		</pre>

2015-01-21T11:13:32Z

Configuring SWORD

← Older revision		Revision as of 11:13, 21 January 2015
Line 18:		Line 18:
	** All updates are done by naming the specific eprint ID		** All updates are done by naming the specific eprint ID
	* By default, new records are created in the "review" buffer		* By default, new records are created in the "review" buffer
	** If the incoming request has the '''In-Progress''' header element set true, then the deposit will be put into the "inbox"		** If the incoming request has the '''In-Progress''' header element set true, then the deposit will be put into the <code>inbox</code>
	** If the repository has been configured to '''skip_buffer''' then items will be put into the "archive" buffer rather than "review"		** If the repository has been configured to '''skip_buffer''' then items will be put into the <code>archive</code> buffer rather than <code>review</code>

	== servicedocument ==		== servicedocument ==

2015-01-21T11:12:48Z

Configuring SWORD

← Older revision		Revision as of 11:12, 21 January 2015
Line 17:		Line 17:
	* There is only one '''collection''': <code>/id/contents</code>		* There is only one '''collection''': <code>/id/contents</code>
	** All updates are done by naming the specific eprint ID		** All updates are done by naming the specific eprint ID
	* By default, new records are created in the ~~public archive~~		* By default, new records are created in the "review" buffer
	* If ~~a deposit~~ has ~~an issue (such as missing metadata fields flagged as~~ ''~~required~~'') then the ~~deposits are~~ put into the ~~review queue~~		** If the incoming request has the '''In-Progress''' header element set true, then the deposit will be put into the "inbox"
			** If the repository has been configured to '''skip_buffer''' then items will be put into the "archive" buffer rather than "review"
	'''~~NOTE~~''' ~~- Need to work out how one uses~~ "~~status~~" ~~- can it direct a ''create'' into a particular~~ buffer?)

	== servicedocument ==		== servicedocument ==

2013-10-21T09:25:17Z

servicedocument

← Older revision		Revision as of 09:25, 21 October 2013
Line 30:		Line 30:
	The default location for the servicedocument is <tt>/sword-app/servicedocument</tt>		The default location for the servicedocument is <tt>/sword-app/servicedocument</tt>

	''NOTE'' If you install the SWORD 1.3 plugin into EPrints 3.3, then <tt>/sword-app/servicedocument</tt> returns the SWORD 1.3 configuration, not the SWORD 2.0 information.		'''NOTE''' If you install the SWORD 1.3 plugin into EPrints 3.3, then <tt>/sword-app/servicedocument</tt> returns the SWORD 1.3 configuration, not the SWORD 2.0 information.

	=== example ===		=== example ===

2013-10-21T09:25:07Z

servicedocument

← Older revision		Revision as of 09:25, 21 October 2013
Line 29:		Line 29:

	The default location for the servicedocument is <tt>/sword-app/servicedocument</tt>		The default location for the servicedocument is <tt>/sword-app/servicedocument</tt>

			''NOTE'' If you install the SWORD 1.3 plugin into EPrints 3.3, then <tt>/sword-app/servicedocument</tt> returns the SWORD 1.3 configuration, not the SWORD 2.0 information.

	=== example ===		=== example ===

2013-10-21T08:44:11Z

Basic framework

@@ Line 114: / Line 114: @@
 our @ISA = qw/ EPrints::Plugin::Import::Archive /;
-sub new {
+sub new
    my ( $class, %params ) = @_;
@@ Line 163: / Line 164: @@
 <pre>
-sub input_fh {
+sub input_fh
    my ( $plugin, %opts ) = @_;
@@ Line 173: / Line 175: @@
    # the file just deposited.
    # (local method)
-   my ( $type, $zipfile ) = $plugin->upload_archive($fh);
+   my $zipfile = $plugin->upload_archive($fh);
    ## Do magic to get the XML file with the metadata
@@ Line 191: / Line 193: @@
+}
-## add in the upload_archive & arse_epdcx_xml_data methods
+sub upload_archive
 </pre>

2013-10-17T15:50:31Z

example

← Older revision		Revision as of 15:50, 17 October 2013
Line 34:		Line 34:
	<pre>		<pre>
	<?xml version='1.0' encoding='UTF-8'?>		<?xml version='1.0' encoding='UTF-8'?>
	<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/" xmlns:dcterms="http://purl.org/dc/terms/">		<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/"
			xmlns:dcterms="http://purl.org/dc/terms/">
	<workspace>		<workspace>
	<atom:title>3.3.5: Manage deposits</atom:title>		<atom:title>3.3.5: Manage deposits</atom:title>