Date: Thu, 28 Mar 2024 06:48:53 -0400 (EDT) Message-ID: <977668424.27428.1711622933090@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_27427_1175922816.1711622933090" ------=_Part_27427_1175922816.1711622933090 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
SWORD (Simple Web-service Offering Repository Deposit) is a prot= ocol that allows the remote deposit of items into repositories. DSpace impl= ements the SWORD protocol via the 'sword' web application. The version of S= WORD v1 currently supported by DSpace is 1.3. The specification and further= information can be found at http://swordapp.org.
SWORD is based on the Atom Publish Protocol and allows service documents= to be requested which describe the structure of the repository, and packag= es to be deposited.
To enable DSpace's SWORD server, just make sure the [dspace]/webap=
ps/sword/
web application is available from your Servlet Container (=
usually Tomcat).
Configuration File: |
|
---|---|
Property: |
|
Example Value: |
|
Informational Note: |
The property key tell the SWORD METS implemen= tation which package ingester to use to install deposited content. This sho= uld refer to one of the classes configured for: plugin.= named.org.dspace.content.packager.PackageIngester The value of sword.mets-ingester.package-ingester tells the system= which named plugin for this interface should be used to ingest SWORD METS = packages. |
Properties: |
|
Example Value: |
|
Informational Note: |
Define the metadata types which can be accept= ed/handled by SWORD during ingest of a package. Currently, EPDCX (EPrints D= C XML) is the recommended default metadata format, but others are supported= . |
Property: |
|
Example Value: |
|
Informational Note: |
Define the stylesheet which will be used by t= he self-named XSLTIngestionCrosswalk class when asked to load the SWORD con= figuration (as specified above). This will use the specified stylesheet to = crosswalk the incoming SWAP metadata to the DIM format for ingestion. = td> |
Property: |
|
Example Value: |
deposit= .url =3D http://www.myu.ac.uk/sword/deposit |
Informational Note: |
The base URL of the SWORD deposit. This is th=
e URL from which DSpace will construct the deposit location URLs for collec=
tions. The default is |
Property: |
|
Example Value: |
service= document.url =3D http://www.myu.ac.uk/sword/servicedocument |
Informational Note: |
The base URL of the SWORD service document. T=
his is the URL from which DSpace will construct the service document locati=
on URLs for the site, and for individual collections. The default is |
Property: |
|
Example Value: |
media-l= ink.url =3D http://www.myu.ac.uk/sword/media-link |
Informational Note: |
The base URL of the SWORD media links. This i=
s the URL which DSpace will use to construct the media link URLs for items =
which are deposited via sword. The default is |
Property: |
|
Example Value: |
generat= or.url =3D http://www.dspace.org/ns/sword/1.3.1 |
Informational Note: |
The URL which identifies the SWORD software w= hich provides the sword interface. This is the URL which DSpace will use to= fill out the atom:generator element of its atom documents. The default is:= {{ http://www.dspace.org/ns/sword/1.3.1}}. If yo= u have modified your SWORD software, you should change this URI to identify= your own version. If you are using the standard 'dspace-sword' module you = will not, in general, need to change this setting. |
Property: |
|
Example Value: |
|
Informational Note: |
The metadata field in which to store the upda= ted date for items deposited via SWORD. |
Property: |
|
Example Value: |
|
Informational Note: |
The metadata field in which to store the valu= e of the slug header if it is supplied. |
Properties: |
accept-= packaging.METSDSpaceSIP.identifier accept-packaging.METSDSpaceSIP.q |
Example Value: |
accept-= packaging.METSDSpaceSIP.identifier =3D http://purl.org/net/sword-types/METS= DSpaceSIP accept-packaging.METSDSpaceSIP.q =3D 1.0 |
Informational Note: |
The accept packaging properties, along with t= heir associated quality values where appropriate. This is a Global Setting;= these will be used on all DSpace collections |
Property: |
|
Example Value: |
|
Informational Note: |
A comma separated list of MIME types that SWO= RD will accept. |
Properties: |
accept-= packaging.[handle].METSDSpaceSIP.identifier accept-packaging.[handle].METSDSpaceSIP.q |
Example Value: |
accept-= packaging.[handle].METSDSpaceSIP.identifier =3D http://purl.org/net/sword-t= ypes/METSDSpaceSIP accept-packaging.[handle].METSDSpaceSIP.q =3D 1.0 |
Informational Note: |
Collection Specific settings: these will be u= sed on the collections with the given handles. |
Property: |
|
Example Value: |
|
Informational Note: |
Should the server offer up items in collectio= ns as sword deposit targets. This will be effected by placing a URI in the = collection description which will list all the allowed items for the deposi= ting user in that collection on request. NOTE: this will r= equire an implementation of deposit onto items, which will not be forthcomi= ng for a short while. |
Property: |
|
Example Value: |
|
Informational Note: |
Should the server offer as the default the li= st of all Communities to a Service Document request. If false, the server w= ill offer the list of all collections, which is the default and recommended= behavior at this stage. NOTE: a service document for Comm= unities will not offer any viable deposit targets, and the client will need= to request the list of Collections in the target before deposit can contin= ue. |
Property: |
|
Example Value: |
|
Informational Note: |
The maximum upload size of a package through = the sword interface, in bytes. This will be the combined size of all the fi= les, the metadata and any manifest data. It is NOT the same as the maximum = size set for an individual file upload through the user interface. If not s= et, or set to 0, the sword service will default to no limit. |
Property: |
|
Example Value: |
|
Informational Note: |
Whether or not DSpace should store a copy of =
the original sword deposit package. NOTE: this will cause =
the deposit process to run slightly slower, and will accelerate the rate at=
which the repository consumes disk space. BUT, it will also mean that the =
deposited packages are recoverable in their original form. It is strongly r=
ecommended, therefore, to leave this option turned on. When set to "true", =
this requires that the configuration option |
Property: |
|
Example Value: |
|
Informational Note: |
The bundle name that SWORD should store incom= ing packages under if sword.keep-original-package is set to true. The defau= lt is "SWORD" if not value is set |
Properties: |
|
Example Value: |
keep-pa= ckage-on-fail=3Dtrue failed-package.dir=3D${dspace.dir}/upload |
Informational Note: |
In the event of package ingest failure, provi= de an option to store the package on the file system. The default is false.= |
Property: |
|
Example Value: |
|
Informational Note: |
Should the server identify the sword version = in a deposit response. It is recommended to leave this unchanged. |
Property: |
|
Example Value: |
|
Informational Note: |
Should mediated deposit via sword be supporte= d. If enabled, this will allow users to deposit content packages on behalf = of other users. |
Property: |
|
Example Value: |
|
Informational Note: |
Should the sword server enable restore-mode w= hen ingesting new packages. If this is enabled the item will be treated as = a previously deleted item from the repository. If the item had previously b= een assigned a handle then that same handle will be restored to activity. I= f that item had not been previously assign a handle, then a new handle will= be assigned. |
Property: |
|
Example Value: |
plugin.= named.org.dspace.sword.SWORDIngester =3D \ org.dspace.sword.SWORDMETSIngester =3D http://purl.org/net/sword-types/ME= TSDSpaceSIP \ org.dspace.sword.SimpleFileIngester =3D SimpleFileIngester |
Informational Note: |
Configure the plugins to process incoming pac=
kages. The form of this configuration is as per the Plugin Manager's Named =
Plugin documentation: |