Skip to content

cul/ldpd-sword

Repository files navigation

CUL SWORD service

The CUL SWORD service can be used to deposit file(s) into Hyacinth. The file(s) are deposited into a SWORD collection by send a POST request to the associated URL, know as an endpoint.

Setting up a new SWORD collection/endpoint (Admin)

  • Create a new Collection on the SWORD server (Currently in database via SWORD server GUI, but config file will be used in future version)
  • Associate a Depositor to the collection (Currently in database via SWORD server GUI, but config file will be used in future version). If desired, a new Depositor can be created (Currently in database via SWORD server GUI, but config file will be used in future version).

Creating a new Depositor

To be expanded once config setup is implemented

Client: initial setup

  • Obtain the URL used as target of POST request from SWORD administrator
  • Obtain the required credentials (username, password) from SWORD administrator

Client: process to submit files

  • Create mets.xml file with metadata and filenames (include more info here or in new section below)
  • zip files, including mets file
  • Deposit zip file using a POST request sent to the endpoint URL with credentials included in basic authentication.