Module 4 - SWORD clients
-
Upload
sword-project -
Category
Technology
-
view
7.159 -
download
0
description
Transcript of Module 4 - SWORD clients
![Page 1: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/1.jpg)
The SWORD Course
Module4 SWORD
clients
![Page 2: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/2.jpg)
Module objectives
• By the end of this module you will:
– Understand the need for SWORD clients
– Have seen a variety of SWORD clients
– Have had the opportunity to try using some SWORD clients
– Know what tools are available to help with the creation of SWORD clients
![Page 3: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/3.jpg)
A quick recap
• SWORD 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 Document
• You can deposit an item by POSTing a package
![Page 4: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/4.jpg)
User friendly?
• Interaction with SWORD is via XML documents
• XML is good for machine to machine interfaces
• Do users want to read / write XML?
![Page 5: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/5.jpg)
User friendly?
![Page 6: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/6.jpg)
The answer?
SWORD
clients
![Page 7: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/7.jpg)
An analogy
• Using the web:
– Do we read and write HTML?
– No!
– We use a web client / browser.
![Page 8: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/8.jpg)
SWORD clients
• Three types of SWORD client:
1. Machine to machine custom client
• E.g. custom code to deposit from lab equipment
2. General client
• Deposit any item type to any repository
3. Specific client
• Tailored for an individual use (e.g. e-thesis deposit to repository X, journal article (with DOI) deposit to repository Y)
![Page 9: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/9.jpg)
SWORD clients
• Machine to machine custom client
– E.g. JISC-funded ROAD project
– Robot-generated Open Access Data
– Automated laboratory undertaking investigations into gene functions
– Specific client for specific project / equipment
![Page 10: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/10.jpg)
Online demo client
![Page 11: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/11.jpg)
Desktop demo client
![Page 12: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/12.jpg)
Problems with general clients
• Do users know their repository URL?
• Do users know the URL of their repository’s service document?
• Do users have pre-compiled packages?
![Page 13: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/13.jpg)
Another example
• The Facebook SWORD deposit tool
– http://apps.facebook.com/swordapp/
![Page 14: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/14.jpg)
Facebook client
![Page 15: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/15.jpg)
Facebook client
![Page 16: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/16.jpg)
Facebook client
The application performs the packaging (metadata + file)
![Page 17: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/17.jpg)
Facebook client
![Page 18: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/18.jpg)
Specific clients
• Specific clients overcome the previous problems:
– URLs embedded (or hidden behind easy choices)
– Usernames and passwords may be embedded
– Local language can be used
![Page 19: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/19.jpg)
An example
• E-thesis deposit at The University of Auckland
– http://deposit.library.auckland.ac.nz/
– Uses local language (e.g. ‘UPI’ for login)
– Specific Creative Commons questions
– Email receipt
![Page 20: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/20.jpg)
An example
![Page 21: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/21.jpg)
An example
![Page 22: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/22.jpg)
An example
![Page 23: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/23.jpg)
An example
![Page 24: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/24.jpg)
An example
![Page 25: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/25.jpg)
• Deposit by email
– Email [email protected]
– Script reads mailbox
• From name -> Author
• Subject -> Title
• Message body -> Abstract
– Deposit made
– Reply sent to user with deposited item URL
Another example
![Page 26: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/26.jpg)
• Article Authoring Add-in for Word 2007– http://research.microsoft.com/en-us/projects/authoring/
– .docx files are actually ‘packages’• Zip file containing XML files
– Embed 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
![Page 27: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/27.jpg)
• Create a template using fields
– E.g. title / abstract / conclusion
• Repository can be programmed to extract these fields programmatically into metadata elements
Deposit from within Microsoft Word
![Page 28: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/28.jpg)
Deposit from within Microsoft Word
![Page 29: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/29.jpg)
• Want to create your own custom client?
• No need to re-invent the wheel
• Code libraries / APIs available
Creating your own client
![Page 30: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/30.jpg)
• PHP– http://github.com/stuartlewis/swordapp-php-library/
– Good for web-based or scripted clients
– Includes a METS/SWAP packager
• Java– http://sourceforge.net/projects/sword-app/develop
– Good for web-based, scripted or desktop clients
SWORD code libraries / APIs
![Page 31: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/31.jpg)
Review
• SWORD clients are required to perform deposits
• There are some generic clients available
• Generic clients require a level of technical knowledge
• Specific clients can be created to shield the user from details
• There are code libraries available to help you write your own clients
![Page 32: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/32.jpg)
Want to learn more?
• If SWORD is the answer, what is the question? Use of the Simple Web service Offering Repository Deposit protocol
– http://dx.doi.org/10.1108/00330330910998057
– http://hdl.handle.net/2292/5315
![Page 33: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/33.jpg)
Credits
• This course has been produced by:
– Stuart Lewis
• The SWORD project
– http://swordapp.org/
• Funded by JISC
– http://www.jisc.ac.uk/
• Licence
– Creative commons
![Page 34: Module 4 - SWORD clients](https://reader035.fdocuments.us/reader035/viewer/2022062419/559c3fcf1a28ab273c8b46a4/html5/thumbnails/34.jpg)
Photo Credits
• Lecture hall: http://www.flickr.com/photos/iamthebestartist/2008790/
• It’s a No!: http://www.flickr.com/photos/biscuitsmlp/2247299538/