The Cutting Edge of SWORD

Transcription

1 The Cutting Edge of SWORD 18 th May 2009 OR09, Atlanta, GA Adrian Stevenson and Julie Allinson SWORD Project Managers UKOLN is supported by:

2 SWORD Quick Introduction Vision: lowering barriers to deposit Simple Web service Offering Repository Deposit Aims to provide a standard mechanism for doing deposit into repositories JISC funded project started 2007, continuation funding for SWORD 2 from June 2008

3 What is it? A lightweight protocol for deposit A profile of the Atom Publishing Protocol Implementations of SWORD in IntraLibrary, Fedora, DSpace and Eprints repositories SWORD clients web-based, desktop, MS Office plugin, Facebook, widgets

4 Motivations why? no standard interface for tagging, packaging or authoring tools to upload objects into a repository no standard interface for transferring digital objects between repositories no way to deposit into more than one repository with one click no way of initiating a deposit workflow from outside a repository system

5 The Project Partners SWORD partners: UKOLN, University of Bath and University of York (Project Management) Adrian Stevenson & Julie Allinson University of Aberystwyth (DSpace, Fedora, & clients) Stuart Lewis, Neil Taylor, Glen Robson, Richard Jones University of Southampton (EPrints) Les Carr Intrallect (IntraLibrary) Sarah Currier Plus some friendly advisors Jim Downing, Richard Green

6 Use Cases Deposit from a Desktop/Online tool Multiple deposit - e.g. deposit to institutional and (mandated) funders repository with one action Machine deposit - e.g. automated deposit from a laboratory machine Migration/transfer - e.g. to a preservation service Mediated deposit - e.g. deposit by a nominated representative, to additional repositories

7 SWORD AtomPub Profile

8 Standards WebDAV ( JSR 170 ( JSR 283 ( SRW Update ( Flickr Deposit API ( Fedora Deposit API ( OKI OSID ( ECL ( ATOM Publishing Protocol (

9 the Atom Publishing Protocol is an application-level protocol for publishing and editing Web resources benefits supports many of our parameters and requirements, in particular file deposit it already exists and has growing support it is well-used in popular applications it has an extension mechanism good fit with the Web architecture drawbacks / risks too much of a retrofit? it is designed for a single package/file OR an atom document this means that we need to package up metadata and files

10 SWORD AtomPub Profile SWORD profile builds on AtomPub Provides set of extensions, constraint relaxations and enforcements when: Clients post compound resources (zip,tar) Mediated deposit required Workflows involved SWORD compliance does not preclude AtomPub compliance

11 SWORD APP Package Support AtomPub uses MIME to describe resources Inadequate for compound types e.g. Zip, tar METS, SCORM, MPEG21, DIDL packages SWORD extends AtomPub: sword:acceptpackaging element Value taken from SWORD package types

12 SWORD APP Mediated Deposit SWORD deposit client user may not be owner of resource SWORD allows clients to set a HTTP header: X-On-Behalf-Of Assumes trust between owner and mediating user

13 SWORD APP Developer Features No-Op (Dry Run) Verbose Output Client and Server Identity Auto-Discovery Error Documents Nested Service Desription

14 SWORD APP Error Documents SWORD adds new class of doc to AtomPub to allow better error description ErrorContent ErrorChecksumMismatch ErrorBadRequest TargetOwnerUnknown MediationNotAllowed

15 SWORD Profile of AtomPub Part B follows AtomPub specification highlighting where SWORD profile diverges Part B covers: Protocol Operations Retrieving Service Document Listing Collections Creating a Resource Editing a Resource - Not currently implemented Category Documents MUST NOT be required Service Documents new elements: version, verbose, noop, maxuploadsize

16 How it Works APP works by issuing HTTP requests (GET, POST) GET Service Document (explain/discover) POST ATOM document or file to collection URI HTTP response and ATOM document is returned HTTP basic authentication is required

17 SWORD 2 Profile Updates SWORD Profile Version 1.3 includes: Revised deviations from AtomPub and Atom increasing requirement for persistent Atom Entry Documents Includes description of SWORD specific extensions Removed notion of levels of compliance Added sword:useragent, sword:error, sword:service, sword:version and sword:maxuploadsize elements

18 SWORD In Use

19 Implementations Repository implementations DSpace EPrints IntraLibrary Fedora Client implementations command-line, desktop and web clients Facebook Client Deposit from within MS Word & Powerpoint Feedforward / FOREsite and others: Java, PHP and.net libraries

20 Web Interface

21 Fedora deposit

22 Fedora Deposit response

23 Validation

24 Netvibes Widget

25

26

27 Deposit in Intralibrary

28 Deposit via Facebook

29

30

31

32

33 FeedForward Deposit

34 Intralibrary preview of deposited item

35 OfficeSWORD Add-on

36

37 SWORD in use In addition to the case study implementations: Feedforward has already implemented ICE project is looking at SWORD EU PEER project implementing SWORD Microsoft echemistry work OAI-ORE - FOREsite work EM-Loader YODL-ING University of York Others coming along all the time Collaboration with Nature Publishing Group

38 More Info and Contact SWORD Website: General queries: Adrian Stevenson Technical queries: Sword sourceforge list

39 Questions SWORD Website Adrian Stevenson, UKOLN