SWORD

SWORD Deposits

Esploro supports the SWORD v.2.0 protocol – a standard lightweight protocol for depositing content from one location to another.  It stands for Simple Web-service Offering Repository Deposit and is a profile of the Atom Publishing Protocol. For full information about SWORD, visit the SWORD website.

This page contains basic information about how SWORD is supported in Esploro, namely, details about required Esploro configuration and Esploro’s SWORD server.

Deposit Configuration

Before you can use SWORD to accept deposits, you must first set up one or more of the sword import profile crosswalks. This is needed in order to map between the original XML record sent to Esploro and the Esploro asset format.

For more information, contact Ex Libris Support.

Configuring your SWORD Integration Profile

Follow the instructions in Configuring the SWORD Server Integration Profile and add your username and password. These, and the BaseURL, will be required to configure your SWORD client.

All requests to the SWORD server, unless they come from Converis, must also include an ‘On-behalf-of’ header with a valid Alma user.

ETD Administrator Configuration

ETD Administrator also uses SWORD to make deposits into Esploro. For more information, see ETD Administrator Integration. For deposits that are created by ProQuest ETD Administrator, you can configure the asset status (approved or deposit) deposited and the default date population. For more information, see configuring Other Settings.

Asset Update Configuration

When updating an asset through SWORD, you can restrict fields from being updated.
To configure that go to Configuration > Repository > under Integrations click on “SWORD Fields Not to Update”

Here you can add Row for the fields you wish not to update through SWORD.
Any field that appear on this list and is enabled will not be updated by SWORD.

Implementation

The following methods are supported by the Esploro SWORD server:

Requested Action Command Esploro Format ETDAdmin Converis Other formats through AMAP
Retrieve service document GET /esploro/sd/
Or
/esploro/
/sd/esploro_ETDAdmin
Or
/esploro_ETDAdmin/
/esploro_Converis/sd/
Or
/esploro_Converis/
/other/sd/
Or /other/
Add new asset with files POST /esploro/collection/
Or
/esploro/
/collection/esploro_ETDAdmin
Or
/esploro_ETDAdmin /
/other/collection/
Or
/other/
Add new asset without files POST /esploro_Converis/collection/
Or
/esploro_Converis/
Add files to existing asset POST /esploro_Converis/edit-media/{mms_id}
Update an asset – MD and files PUT /esploro/edit/{record_id}
Or
/esploro/{record_id}
Header must include ‘Content-Type’: ‘multipart/related’
/edit/esploro_ETDAdmin/{record_id}
Or
/esploro_ETDAdmin/{record_id}
Header must include ‘Content-Type’: ‘multipart/related’
/other/edit/{record_id}
Or
/other/{record_id}
Header must include ‘Content-Type’: ‘multipart/related’
Update an asset – only MD PUT /esploro/edit/{record_id}
Or
/esploro/{record_id}
Header must include ‘Content-Type’: ‘application/atom+xml;type=entry’
/edit/esploro_ETDAdmin/{record_id}
Or
/esploro_ETDAdmin/{record_id}
Header must include ‘Content-Type’: ‘application/atom+xml;type=entry’
/esploro_Converis/edit/{record_id}
Or
/esploro_Converis/{record_id}
Header must include ‘Content-Type’: ‘application/atom+xml;type=entry’
/other/edit/{record_id}
Or
/other/{record_id}
Header must include ‘Content-Type’: ‘application/atom+xml;type=entry’