The SWORD CourseModule4SWORDclients
Module objectivesBy the end of this module you will:Understand the need for SWORD clientsHave seen a variety of SWORD clientsHave had the opportunity to try using some SWORD clientsKnow what tools are available to help with the creation of SWORD clients
A quick recapSWORD is a web service that allows deposits to take place into a repository.You can find out about a repository’s SWORD interface by requesting a Service DocumentYou can deposit an item by POSTing a package
User friendly?Interaction with SWORD is via XML documentsXML is good for machine to machine interfacesDo users want to read / write XML?
User friendly?
The answer?SWORDclients
An analogyUsing the web:Do we read and write HTML?No!We use a web client / browser.
SWORD clientsThree types of SWORD client:Machine to machine custom clientE.g. custom code to deposit from lab equipmentGeneral clientDeposit any item type to any repositorySpecific clientTailored for an individual use (e.g. e-thesis deposit to repository X, journal article (with DOI) deposit to repository Y)
SWORD clientsMachine to machine custom clientE.g. JISC-funded ROAD projectRobot-generated Open Access DataAutomated laboratory undertaking investigations into gene functionsSpecific client for specific project / equipment
Online demo client
Desktop demo client
Problems with general clientsDo users know their repository URL?Do users know the URL of their repository’s service document?Do users have pre-compiled packages?
Another exampleThe Facebook SWORD deposit toolhttp://apps.facebook.com/swordapp/
Facebook client
Facebook client
Facebook clientThe application performs the packaging (metadata + file)
Facebook client
Specific clientsSpecific clients overcome the previous problems:URLs embedded (or hidden behind easy choices)Usernames and passwords may be embeddedLocal language can be used
An exampleE-thesis deposit at The University of Aucklandhttp://deposit.library.auckland.ac.nz/Uses local language (e.g. ‘UPI’ for login)Specific Creative Commons questionsEmail receipt
An example
An example
An example
An example
An example
Deposit by emailEmail deposit@swordapp.orgScript reads mailboxFrom name -> AuthorSubject -> TitleMessage body -> AbstractDeposit madeReply sent to user with deposited item URLAnother example
Article Authoring Add-in for Word 2007http://research.microsoft.com/en-us/projects/authoring/.docx files are actually ‘packages’Zip file containing XML filesEmbed SWORD details in the XML<article ms:DepositURL=”http://localhost:8080/sword/deposit/123456789/2″ ms:JournalName=”test” ms:SignupURL=”http://localhost:8080/jspui/” ms:PasswordRequired=”True” ms:PreferredFormat=”docx” ms:SupportedFormats=”docx” ms:Category=”" ms:SubCategory=”">Deposit from within Microsoft Word
Create a template using fieldsE.g. title / abstract / conclusionRepository can be programmed to extract these fields programmatically into metadata elementsDeposit from within Microsoft Word
Deposit from within Microsoft Word
Want to create your own custom client?No need to re-invent the wheelCode libraries / APIs availableCreating your own client
PHPhttp://github.com/stuartlewis/swordapp-php-library/Good for web-based or scripted clientsIncludes a METS/SWAP packagerJavahttp://sourceforge.net/projects/sword-app/developGood for web-based, scripted or desktop clientsSWORD code libraries / APIs
ReviewSWORD clients are required to perform depositsThere are some generic clients availableGeneric clients require a level of technical knowledgeSpecific clients can be created to shield the user from detailsThere are code libraries available to help you write your own clients
Want to learn more?If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocolhttp://dx.doi.org/10.1108/00330330910998057http://hdl.handle.net/2292/5315
CreditsThis course has been produced by:Stuart LewisThe SWORD projecthttp://swordapp.org/Funded by JISChttp://www.jisc.ac.uk/LicenceCreative commons
Photo CreditsLecture hall: http://www.flickr.com/photos/iamthebestartist/2008790/It’s a No!: http://www.flickr.com/photos/biscuitsmlp/2247299538/

Module 4 - SWORD clients

  • 1.
  • 2.
    Module objectivesBy theend of this module you will:Understand the need for SWORD clientsHave seen a variety of SWORD clientsHave had the opportunity to try using some SWORD clientsKnow what tools are available to help with the creation of SWORD clients
  • 3.
    A quick recapSWORDis a web service that allows deposits to take place into a repository.You can find out about a repository’s SWORD interface by requesting a Service DocumentYou can deposit an item by POSTing a package
  • 4.
    User friendly?Interaction withSWORD is via XML documentsXML is good for machine to machine interfacesDo users want to read / write XML?
  • 5.
  • 6.
  • 7.
    An analogyUsing theweb:Do we read and write HTML?No!We use a web client / browser.
  • 8.
    SWORD clientsThree typesof SWORD client:Machine to machine custom clientE.g. custom code to deposit from lab equipmentGeneral clientDeposit any item type to any repositorySpecific clientTailored for an individual use (e.g. e-thesis deposit to repository X, journal article (with DOI) deposit to repository Y)
  • 9.
    SWORD clientsMachine tomachine custom clientE.g. JISC-funded ROAD projectRobot-generated Open Access DataAutomated laboratory undertaking investigations into gene functionsSpecific client for specific project / equipment
  • 10.
  • 11.
  • 12.
    Problems with generalclientsDo users know their repository URL?Do users know the URL of their repository’s service document?Do users have pre-compiled packages?
  • 13.
    Another exampleThe FacebookSWORD deposit toolhttp://apps.facebook.com/swordapp/
  • 14.
  • 15.
  • 16.
    Facebook clientThe applicationperforms the packaging (metadata + file)
  • 17.
  • 18.
    Specific clientsSpecific clientsovercome the previous problems:URLs embedded (or hidden behind easy choices)Usernames and passwords may be embeddedLocal language can be used
  • 19.
    An exampleE-thesis depositat The University of Aucklandhttp://deposit.library.auckland.ac.nz/Uses local language (e.g. ‘UPI’ for login)Specific Creative Commons questionsEmail receipt
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
    Deposit by emailEmaildeposit@swordapp.orgScript reads mailboxFrom name -> AuthorSubject -> TitleMessage body -> AbstractDeposit madeReply sent to user with deposited item URLAnother example
  • 26.
    Article Authoring Add-infor Word 2007http://research.microsoft.com/en-us/projects/authoring/.docx files are actually ‘packages’Zip file containing XML filesEmbed SWORD details in the XML<article ms:DepositURL=”http://localhost:8080/sword/deposit/123456789/2″ ms:JournalName=”test” ms:SignupURL=”http://localhost:8080/jspui/” ms:PasswordRequired=”True” ms:PreferredFormat=”docx” ms:SupportedFormats=”docx” ms:Category=”" ms:SubCategory=”">Deposit from within Microsoft Word
  • 27.
    Create a templateusing fieldsE.g. title / abstract / conclusionRepository can be programmed to extract these fields programmatically into metadata elementsDeposit from within Microsoft Word
  • 28.
    Deposit from withinMicrosoft Word
  • 29.
    Want to createyour own custom client?No need to re-invent the wheelCode libraries / APIs availableCreating your own client
  • 30.
    PHPhttp://github.com/stuartlewis/swordapp-php-library/Good for web-basedor scripted clientsIncludes a METS/SWAP packagerJavahttp://sourceforge.net/projects/sword-app/developGood for web-based, scripted or desktop clientsSWORD code libraries / APIs
  • 31.
    ReviewSWORD clients arerequired to perform depositsThere are some generic clients availableGeneric clients require a level of technical knowledgeSpecific clients can be created to shield the user from detailsThere are code libraries available to help you write your own clients
  • 32.
    Want to learnmore?If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocolhttp://dx.doi.org/10.1108/00330330910998057http://hdl.handle.net/2292/5315
  • 33.
    CreditsThis course hasbeen produced by:Stuart LewisThe SWORD projecthttp://swordapp.org/Funded by JISChttp://www.jisc.ac.uk/LicenceCreative commons
  • 34.
    Photo CreditsLecture hall:http://www.flickr.com/photos/iamthebestartist/2008790/It’s a No!: http://www.flickr.com/photos/biscuitsmlp/2247299538/