Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Module 4 - SWORD clients


Published on

Module 4 of ’The SWORD Course’.

For further information see

Published in: Technology
  • Be the first to comment

Module 4 - SWORD clients

  1. 1. The SWORD Course<br />Module4<br />SWORDclients<br />
  2. 2. Module objectives<br />By the end of this module you will:<br />Understand the need for SWORD clients<br />Have seen a variety of SWORD clients<br />Have had the opportunity to try using some SWORD clients<br />Know what tools are available to help with the creation of SWORD clients<br />
  3. 3. A quick recap<br /><ul><li>SWORD is a web service that allows deposits to take place into a repository.</li></ul>You can find out about a repository’s SWORD interface by requesting a Service Document<br />You can deposit an item by POSTing a package<br />
  4. 4. User friendly?<br />Interaction with SWORD is via XML documents<br />XML is good for machine to machine interfaces<br />Do users want to read / write XML?<br />
  5. 5. User friendly?<br />
  6. 6. The answer?<br />SWORD<br />clients<br />
  7. 7. An analogy<br />Using the web:<br />Do we read and write HTML?<br />No!<br />We use a web client / browser.<br />
  8. 8. SWORD clients<br />Three types of SWORD client:<br />Machine to machine custom client<br />E.g. custom code to deposit from lab equipment<br />General client<br />Deposit any item type to any repository<br />Specific client<br />Tailored for an individual use (e.g. e-thesis deposit to repository X, journal article (with DOI) deposit to repository Y)<br />
  9. 9. SWORD clients<br />Machine to machine custom client<br />E.g. JISC-funded ROAD project<br />Robot-generated Open Access Data<br />Automated laboratory undertaking investigations into gene functions<br />Specific client for specific project / equipment<br />
  10. 10. Online demo client<br />
  11. 11. Desktop demo client<br />
  12. 12. Problems with general clients<br />Do users know their repository URL?<br />Do users know the URL of their repository’s service document?<br />Do users have pre-compiled packages?<br />
  13. 13. Another example<br />The Facebook SWORD deposit tool<br /><br />
  14. 14. Facebook client<br />
  15. 15. Facebook client<br />
  16. 16. Facebook client<br />The application performs the packaging (metadata + file)<br />
  17. 17. Facebook client<br />
  18. 18. Specific clients<br />Specific clients overcome the previous problems:<br />URLs embedded (or hidden behind easy choices)<br />Usernames and passwords may be embedded<br />Local language can be used<br />
  19. 19. An example<br />E-thesis deposit at The University of Auckland<br /><br />Uses local language (e.g. ‘UPI’ for login)<br />Specific Creative Commons questions<br />Email receipt<br />
  20. 20. An example<br />
  21. 21. An example<br />
  22. 22. An example<br />
  23. 23. An example<br />
  24. 24. An example<br />
  25. 25. Deposit by email<br />Email<br />Script reads mailbox<br />From name -> Author<br />Subject -> Title<br />Message body -> Abstract<br />Deposit made<br />Reply sent to user with deposited item URL<br />Another example<br />
  26. 26. Article Authoring Add-in for Word 2007<br /><br />.docx files are actually ‘packages’<br />Zip file containing XML files<br />Embed SWORD details in the XML<br /><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=”"><br />Deposit from within Microsoft Word<br />
  27. 27. Create a template using fields<br />E.g. title / abstract / conclusion<br />Repository can be programmed to extract these fields programmatically into metadata elements<br />Deposit from within Microsoft Word<br />
  28. 28. Deposit from within Microsoft Word<br />
  29. 29. Want to create your own custom client?<br />No need to re-invent the wheel<br />Code libraries / APIs available<br />Creating your own client<br />
  30. 30. PHP<br /><br />Good for web-based or scripted clients<br />Includes a METS/SWAP packager<br />Java<br /><br />Good for web-based, scripted or desktop clients<br />SWORD code libraries / APIs<br />
  31. 31. Review<br />SWORD clients are required to perform deposits<br />There are some generic clients available<br />Generic clients require a level of technical knowledge<br />Specific clients can be created to shield the user from details<br />There are code libraries available to help you write your own clients<br />
  32. 32. Want to learn more?<br />If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocol<br /><br /><br />
  33. 33. Credits<br />This course has been produced by:<br />Stuart Lewis<br />The SWORD project<br /><br />Funded by JISC<br /><br />Licence<br />Creative commons<br />
  34. 34. Photo Credits<br />Lecture hall:<br />It’s a No!:<br />