SWORD (protocol)

{{Infobox file format

| name = SWORD

| genre = Resource deposit

| extendedfrom = ATOM

| owner = JISC

| latest release version = 3.0

| url = [http://swordapp.org/ swordapp.org]

}}

SWORD (Simple Web-service Offering Repository Deposit) is an interoperability standard that allows digital repositories to accept the deposit of content from multiple sources in different formats (such as XML documents) via a standardized protocol. In the same way that the HTTP protocol allows any web browser to talk to any web server, so SWORD allows clients to talk to repository servers. SWORD is a profile (specialism) of the Atom Publishing Protocol, but restricts itself solely to the scope of depositing resources into scholarly systems.

History

The first version of the SWORD protocol was created in 2007 by a consortium of UK institutional repository experts. The project to develop SWORD was funded by the JISC and managed by UKOLN.{{Cite web|url=http://www.ukoln.ac.uk/repositories/digirep/index/SWORD_Project|title=SWORD Project - DigiRepWiki|website=www.ukoln.ac.uk}} An overview of the initial development of SWORD is given in "SWORD: Simple Web-service Offering Repository Deposit."

{{Citation

|author1=Julie Allinson |author2=Sebastien François |author3=Stuart Lewis | title = SWORD: Simple Web-service Offering Repository Deposit

| publisher = Ariadne

| date = 2008-01-30

| url = http://www.ariadne.ac.uk/issue54/allinson-et-al/

| accessdate = 2011-01-08}} The standard grew out of a need for an interoperable method by which resources could be deposited into repositories. Interoperable standards existed to allow the harvesting of content (e.g. Open Archives Initiative Protocol for Metadata Harvesting) or for searching (e.g. OpenSearch) but not for deposit.

Between the original release in 2007, two subsequent projects were undertaken until 2009 to further refine the version 1.0 specification and perform advocacy work. The resulting release was numbered 1.3.{{cite web |url=http://swordapp.org/docs/sword-profile-1.3.html |title=SWORD APP Profile version 1.3 |website=swordapp.org |url-status=dead |archive-url=https://web.archive.org/web/20090531061543/http://www.swordapp.org/docs/sword-profile-1.3.html |archive-date=2009-05-31}} Further descriptions of the work is available in Lewis et al., "If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocol."

{{Citation

|author1=Stuart Lewis |author2=Leonie Hayes |author3=Vanessa Newton-Wade |author4=Antony Corfield |author5=Richard Davis |author6=Tim Donohue |author7=Scott Wilson | title = If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocol

|journal=Program: Electronic Library and Information Systems | publisher = 'Program' Emerald

| year = 2009

|volume=43 |issue=4 |pages=407–418 |doi=10.1108/00330330910998057 | hdl = 2292/5315|url=https://www.research.ed.ac.uk/portal/en/publications/if-sword-is-the-answer-what-is-the-question(699b760f-9d1a-428f-88ba-6394c9db0ed6).html |hdl-access=free }}

In 2011 a new project began to extend the "fire and forget" approach of the SWORD 1.x specification into a full CRUD (Create, Retrieve, Update, Delete) interface, and the result was a new version (designated 2.0).{{cite web |url=https://swordapp.github.com/SWORDv2-Profile/SWORDProfile.html |title=SWORD 2.0 Profile |website=swordapp.github.com |url-status=dead |archive-url=https://web.archive.org/web/20120901103523/http://swordapp.github.com/SWORDv2-Profile/SWORDProfile.html |archive-date=2012-09-01}} This was followed by extensive development work on client environments in several programming languages, and incorporation into the development of several Jisc-funded efforts.{{Cite web|url=http://swordapp.org/2012/08/extending-dmponline-with-swordv2/|title = Extending DMPOnline with SWORDv2 – SWORD}}{{cite web |url=http://www.dataflow.ox.ac.uk/ |title=DataFlow project |website=www.dataflow.ox.ac.uk |url-status=dead |archive-url=https://web.archive.org/web/20111212055359/http://www.dataflow.ox.ac.uk/ |archive-date=2011-12-12}}

Use cases

Many different use cases exist

{{Citation

|author1=Stuart Lewis |author2=Pablo de Castro |author3=Richard jones | title = SWORD: Facilitating Deposit Scenarios

| journal = D-Lib Magazine

| year = 2012

| doi=10.1045/january2012-lewis | volume=18| doi-access=free}} where it may be desirable to remotely deposit resources into scholarly systems. These include:

  • Deposit to multiple repositories at once.
  • Deposit from a desktop client (rather from within the repository system itself)
  • Deposit by third party systems (for example by automated laboratory equipment)
  • Repository to repository deposit

Implementations

Three categories of implementation exist: repository implementations for existing repository servers, client implementations that can be used to perform SWORD deposits, and code libraries to assist in the creation of new SWORD clients or servers.

= SWORD-compliant repositories =

The following digital repositories are SWORD compliant:

  • arXivhttps://arxiv.org/help/submit_sword
  • Dataverse{{Cite web|url=https://guides.dataverse.org/en/latest/api/sword.html|title=SWORD API — Dataverse.org|website=guides.dataverse.org}}
  • DSpace
  • EPrints
  • Fedora
  • HAL{{Cite web|title=Import SWORD {{!}} API Archive Ouverte HAL|url=https://api.archives-ouvertes.fr/docs/sword|access-date=2022-02-15|website=api.archives-ouvertes.fr}}
  • Intralibrary (project deprecated){{cite web |title=Products / Home - Intrallect |url=http://www.intrallect.com/index.php/intrallect/products |archive-url=https://web.archive.org/web/20070820194231/http://www.intrallect.com/index.php/intrallect/products |url-status=dead |archive-date=20 August 2007 |accessdate=17 July 2020 |date=20 August 2007}}
  • Microsoft Zentity (project deprecated){{cite web |title=Research-Output Repository Platform - Microsoft Research |url=http://research.microsoft.com/en-us/projects/zentity/ |archive-url=https://web.archive.org/web/20090523170341/http://research.microsoft.com/en-us/projects/zentity/ |url-status=dead |archive-date=23 May 2009 |accessdate=17 July 2020 |date=23 May 2009}}
  • MyCoRehttps://www.mycore.de/site/features/interfaces/

= SWORD clients =

  • EasyDeposit{{Cite web |url=http://easydeposit.swordapp.org/ |title=EasyDeposit |access-date=2011-01-23 |archive-date=2011-01-14 |archive-url=https://web.archive.org/web/20110114011950/http://easydeposit.swordapp.org/ |url-status=dead }}
  • Open Journal Systems{{cite web |url=http://pkp.sfu.ca/node/1777 |title=SWORD plugin now available for OJS | Public Knowledge Project |accessdate=2011-01-23 |url-status=dead |archiveurl=https://web.archive.org/web/20110721084756/http://pkp.sfu.ca/node/1777 |archivedate=2011-07-21 }}
  • Pressbooks client{{Cite web|url=https://github.com/pressbooks/excalibur|title=Excalibur|website=GitHub|date=7 August 2021}}

= SWORD code libraries =

  • PHP SWORD client library{{cite web |url=http://php.swordapp.org |title=Index of / |website=php.swordapp.org. |url-status=dead |archive-url=https://web.archive.org/web/20090601121354/http://php.swordapp.org/ |archive-date=2009-06-01}}{{Cite web|url=https://github.com/swordapp/swordappv2-php-library/|title=Swordapp/Swordappv2-PHP-library|website=GitHub|date=19 October 2021}}
  • Ruby SWORD client library {{Cite web|url=https://github.com/swordapp/sword2ruby|title = Sword2Ruby gem|website = GitHub|date = 4 May 2017}}
  • Java SWORD client and server library{{Cite web|url=https://sourceforge.net/projects/sword-app/files/SWORD%20Java%20Library/|title=SWORD - Browse /SWORD Java Library at SourceForge.net}}
  • Python client library{{Cite web|url=https://github.com/swordapp/python-client-sword2|title=Swordapp/Python-client-sword2|website=GitHub|date=25 February 2021}}
  • Python server library and SWORD 2.0 reference implementation{{Cite web|url=https://github.com/swordapp/Simple-Sword-Server|title = SSS - Simple SWORD Server|website = GitHub|date = 17 July 2020}}

= Other resources =

The SWORD Course{{cite web |url=http://swordapp.org/the-sword-course/ |title=The SWORD Course » SWORD |website=swordapp.org |url-status=dead |archive-url=https://web.archive.org/web/20101017102655/http://swordapp.org/the-sword-course/ |archive-date=2010-10-17}}

References

{{Reflist}}