SWORD

From MPDLMediaWiki
Jump to: navigation, search

SWORDSimple Web-service Offering Repository Deposit[1] is a lightweight protocol for depositing content from one location to another, implemented by a profile of the Atom Publishing Protocol[2]. The implementation of an corresponding interface is considered for PubManPublication Management in the context of the Peer project[3].

Scenarios

  1. Deposit metadata (+ files) to eSciDocEnhanced Scientific Documentation (SWORDSimple Web-service Offering Repository Deposit server)
  2. Deposit metadata (+ files) from eSciDocEnhanced Scientific Documentation to other repositories (SWORDSimple Web-service Offering Repository Deposit client)
  3. Edit/Delete existing eSciDocEnhanced Scientific Documentation items (SWORDSimple Web-service Offering Repository Deposit server)

The discussion on implementation steps can be found here. A description of the SWORDSimple Web-service Offering Repository Deposit Server implementation within the PubManPublication Management solution is available here.

SWORDSimple Web-service Offering Repository Deposit Profile

"Rather than develop a new standard from scratch, SWORDSimple Web-service Offering Repository Deposit choose to leverage the existing Atom Publishing Protocol (APP). APP is based on the HTTPHyperText Transfer Protocol transfer of Atom-formatted representations yet SWORDSimple Web-service Offering Repository Deposit has focused on two key aspects of the protocol - the deposit of files, rather than Atom documents, and the extension mechanism for specifying additional deposit parameters."[4]

SWORDSimple Web-service Offering Repository Deposit Elements

SWORDSimple Web-service Offering Repository Deposit Element Description Example
sword:collectionPolicy Used for a human-readable description of collection policy. Include either a text description or a URIUniform Resource Identifier.
sword:treatment Used for a human-readable statement about what treatment the deposited resource will receive "Zip archives recognized as content packages are opened and the individual files contained in them are stored. All other files are stored as is." (Example from IntraLibrary)
sword:formatNamespace Used to identify the content packaging types supported by this collection. SHOULD be a URIUniform Resource Identifier from SWORDSimple Web-service Offering Repository Deposit-TYPES SWORD-TYPES
sword:verbose If a server has support for verbose output
(detailed description of internal processing).
Yes or No
sword:verboseDescription
sword:level level of compliance Level 0: implementation of a minimal set of mandatory elements
Level 1: implementation of the full set of extension elements and compliance with APP


I think this is no longer the case with SWORDSimple Web-service Offering Repository Deposit APP profile 1.3 which is the latest one we need to use. See http://www.swordapp.org/docs/sword-profile-1.3.html, see also "Change control" comment on top of the page
right they state this in change control, but there is one example on that page where they still use the level element ...hmmm...

sword:mediation If the the SWORDSimple Web-service Offering Repository Deposit server supports on-behalf-deposits Yes or No
sword:noOp Is the POST a simulated deposit (For test purposes, no item should be created) Yes or No
sword:userAgent client identification
sword:acceptPackaging
sword:packaging
sword:version Version of implemented protocol 1.3
sword:error The description of the error can be found in the href attribute http://purl.org/net/sword/error/ErrorContent
http://purl.org/net/sword/error/ErrorChecksumMismatch
http://purl.org/net/sword/error/ErrorBadRequest
http://purl.org/net/sword/error/TargetOwnerUnknown
http://purl.org/net/sword/error/MediationNotAllowed
sword:maxUploadSize The maximum size (in kB) of package that can be uploaded to the SWORDSimple Web-service Offering Repository Deposit service

SWORDSimple Web-service Offering Repository Deposit Service Document

  • Example of a SWORDSimple Web-service Offering Repository Deposit Service Document (IntraLibrary).
  • Example of a FedoraFlexible Extensible Digital Object Repository Architecture SWORDSimple Web-service Offering Repository Deposit Service Document
  • Service description for PubMan

Open Questions

have been moved to talk page.

Repositories supporting SWORDSimple Web-service Offering Repository Deposit deposit

  • arxiv
  • Biomedcentral's Open Repository

References

  1. SWORD Homepage and SWORD definition in the Repositories Research Team Wiki
  2. SWORD AtomPub Profile version 1.3
  3. Draft report on the provision of usage data and manuscript procedures for publishers and repository managers
  4. Brief guide to SWORD

Further resources

Exemplary use cases

  • experiences in using SWORDSimple Web-service Offering Repository Deposit for Facebook=> repository (ePrints) can be found here.
  • depositing to supported repositories via SWORDSimple Web-service Offering Repository Deposit is one functionality of PublicationList.org