Module 5 - Create your own SWORD client
Download as PPTX, PDF1 like3,299 views
This document discusses EasyDeposit, an open-source PHP toolkit for creating custom SWORD clients. EasyDeposit allows institutions to easily create SWORD clients for depositing content like theses, technical reports, and journal articles. It provides over 20 configurable deposit steps out of the box and can be customized through its administrative interface. EasyDeposit aims to make SWORD client creation accessible to general web developers by using a PHP/CodeIgniter framework. The document outlines EasyDeposit's benefits and provides examples of how it can be used to build clients for different deposit workflows.
Module 5 - Create your own SWORD client
- 1. The SWORD CourseModule5Create yourown SWORDclient
- 2. Module objectivesBy the end of this module you will:Know about the EasyDeposit SWORD client creation toolkitHave seen some example configurations of EasyDepositUnderstand how to construct a custom SWORD clientHave had the opportunity to construct your own custom EasyDeposit SWORD client
- 3. Background to EasyDepositCreated at the University of Auckland LibraryDigital Development and Media Services teamAlready created several custom SWORD clientsThesis depositComputer Science technical report archiveWanted an easy way to create more clients
- 4. EasyDepositBenefitsWritten in PHP (a skill often found in general web teams rather than specialised repository development teams)Web-based (user + admin)Stand-alone (doesn’t require extra systems such as a database)Comes with more than 20 ‘steps’ out-of-the-boxOpen-source: you are free to modify or extend it
- 5. EasyDeposithttp://easydeposit.swordapp.org/Download applicationInstallation and configuration instructionsExample clientsMakes use of the SWORDAPP PHP libraryBuilt on the popular CodeIgniter framework
- 6. Anatomy of EasyDepositHome pageCustomisableDeposit screensMade up of a series of ‘steps’Steps can be added or removedSteps can be configuredExtra steps can be addedLook and feelCustomisable CSS / header / footer
- 7. StepsDifferent types of stepLogin (must come first)Repository credentialsRepository relatedData collectionVerificationDepositPost-processing
- 8. Visible / Invisible stepsSome steps are visible:Collect metadataUpload filesVerify inputsSome steps are invisible:Deposit
- 9. Login stepsMust come firstSets the user ID (used to store uploaded files on disk, and optionally for deposit credentials)Different options:LDAP login – allows local credentials to be usedService Document login – checks username and password with the repositoryNo login – Used when you want anonymous deposit
- 10. Repository credentialsMust set repository credentialsRepository username / password / on-behalf-ofUse users’ credentialsDeposit performed as that userUse single set of credentialsMinimises number of user accounts in the repository if users only deposit a few items (e.g. theses)
- 11. Repository related stepsAllow user to interact with the Service DocumentSelect from collections they are allowed to deposit toOnly useful if they understand the choiceSelect a repository to use from a pre-defined list or enter a Service Document URLToo complex for most users
- 12. Data collection stepsCollect metadataAllow files to be uploadedCan have automated stepsE.g.: Crossref DOI lookup
- 13. Verification stepAllows user to verify their submissionAllows the user to return to the step to edit the details if required
- 14. Deposit stepPerforms the depositUsually also performs the packagingAn invisible stepMultiple repository deposit step to deposit to multiple repositories
- 15. Post-processing stepsPerforms tasks after the deposit has taken placeExamples:Email confirmation to the userThank you message with the URL of the deposited itemEmail sent to administrator to alert them
- 16. An exampleDeposit a journal article with a DOISteps:NologinCrossrefdoilookupCrossrefdoimetadataUploadfilesVerifyDepositThankyou
- 17. Another exampleDeposit of a PhD thesisSteps:LdaploginTitleUploadfilesUOACreativecommonsembargoVerifyDepositEmailThankyou
- 18. The administrative interfaceProtected with a username and passwordEdit and configure the stepsEdit the welcome screenEdit the commons header, footer, and CSSSet some global settings
- 22. Extending EasyDepositBased on CodeIgniterMVC-based architectureCreate a controller and a viewLook at the current controllers and views to see how they workFeel free to contribute them back to the project
- 23. ConclusionIf you have any questions or suggestions about EasyDeposit, please get in touch!stuart@stuartlewis.com
- 24. CreditsThis course has been produced by:Stuart LewisThe SWORD projecthttp://swordapp.org/Funded by JISChttp://www.jisc.ac.uk/LicenceCreative commons
- 25. Photo CreditsLecture hall: http://www.flickr.com/photos/iamthebestartist/2008790/