Download - Module - DSpace Configuration (Slides)
-
8/10/2019 Module - DSpace Configuration (Slides)
1/34
The DSpace Course
Module - DSpace Configuration
-
8/10/2019 Module - DSpace Configuration (Slides)
2/34
-
8/10/2019 Module - DSpace Configuration (Slides)
3/34
Modifying the Submission ProcessSubmission Steps
-
8/10/2019 Module - DSpace Configuration (Slides)
4/34
-
8/10/2019 Module - DSpace Configuration (Slides)
5/34
The Structure of item-submission.xml
...
-
8/10/2019 Module - DSpace Configuration (Slides)
6/34
The submission map
The submission can be configured for individual collectionsusing the
The collection-handle is the unique identifier for the collection
The submission- name=mysub relates to the submissionprocess name
-
8/10/2019 Module - DSpace Configuration (Slides)
7/34
Submission Process
It is possible to modify the traditional submission order to suityou institution
For example, the licence acceptance first:
Before: Initial Questions -> Describe -> Upload -> Verify -> License -> CompleteAfter: Licence -> Initial Questions -> Upload -> Describe -> Verify -> Complete
The ordering of the tags within a definition corresponds to the order in which those steps will
appear
-
8/10/2019 Module - DSpace Configuration (Slides)
8/34
So in the example below, the licence will be displayed before the initial questionsare asked
submit.progressbar.licenseorg.dspace.submit.step.LicenseSteporg.dspace.app.webui.submit.step.JSPLicenseSteporg.dspace.app.xmlui.aspect.submission.submit.LicenseStepfalse
submit.progressbar.initial-questionsorg.dspace.submit.step.InitialQuestionsSteporg.dspace.app.webui.submit.step.JSPInitialQuestionsSteporg.dspace.app.xmlui.aspect.submission.submit.InitialQuestionsSteptrue
-
8/10/2019 Module - DSpace Configuration (Slides)
9/34
Practical: Submission Order
Open [dspace]/config/item-submission.xmlsudo gedit [dspace]/config/item-submission.xml
Locate the code block below
Move this above step 1 as below
-
8/10/2019 Module - DSpace Configuration (Slides)
10/34
Practical: Submission Order
Restart TomcatSubmit an item to your newly created collection Metadata The licence should now appear first
-
8/10/2019 Module - DSpace Configuration (Slides)
11/34
Modifying the Submission ProcessInput Forms
-
8/10/2019 Module - DSpace Configuration (Slides)
12/34
A bit on Metadata
Metadata is data that describes other dataDSpace uses metadata to describe internal objects such ascommunities, EPeople, collections & items
Metadata for an item is defined in the DSpace registry
Default out-of-the-box schema used by DSpace is Dublin CoreEach field in an items metadata is represented by a DCelement
dccontributorauthor
Schema in use
Descriptive element
Qualifier
-
8/10/2019 Module - DSpace Configuration (Slides)
13/34
A bit more on Metadata
The metadata registry can be configured via the DSpace GUI
-
8/10/2019 Module - DSpace Configuration (Slides)
14/34
The Submission Process
Out of the box, DSpace, as expected uses a default submission processThis submission process can be customised allowing:
Adding additional metadata to be collected about an itemIndividual collections to have unique metadata for their items
-
8/10/2019 Module - DSpace Configuration (Slides)
15/34
Input-forms.xml
The forms used during a submission of an item via the UI are createdbased on[dspace]/config/input-forms.xml
Detailed information can be found in[dspace]/docs/submission.html
The input-forms.xml consists of the top level element whichcontains 3 elements:
Mapping which denotes what collections use which form What makes up an individual forms
Definition of selection lists included in the form
-
8/10/2019 Module - DSpace Configuration (Slides)
16/34
Form Map
The form-map maps collection handles to formsEach has 2 attributes:
collection- handle="collectionHandle (default if not selected) form- name="formName (e.g. )
Collection 123456789/110 has a form called one defined
-
8/10/2019 Module - DSpace Configuration (Slides)
17/34
Form Definitions
The form-definitions map lays out what types of form are included in thesubmissionEach separate form set has a unique name as an attribute. This name isused to associate a form to a collection in the form-mapA form called traditional has been defined in this form definition
...
-
8/10/2019 Module - DSpace Configuration (Slides)
18/34
Form Definitions
A form is created with Each form has the attribute name e.g.
This name is used to map a form to a collection.A form may consist of multiple elements:
..........
-
8/10/2019 Module - DSpace Configuration (Slides)
19/34
Form Definitions - Fields
A consists of: Name Mandatory? Description
True metadata schema name
True metadata element
metadata qualifier
Values: true or false Marks a field as repeatable.
True Label used in User Interface
True Type of input field that is displayed
True Hint used in User Interface
If completed, the field is marked as mandatory.
dccontributor
authortrueOne: Authors
nameEnter the names of the authors of this item below.
-
8/10/2019 Module - DSpace Configuration (Slides)
20/34
Form Definitions - Fields
The input-type:Input-type Description
1 onebox Single boxes for short text
2 twobox A pair of single boxes
3 textarea A text area
4 name A pair of text boxes for personal names
5 date At least a year must be given
6 dropdown A selection list
7 qualdrop-value A selection list combined with a single text box
1.
2.
4.
5.
6.3.
-
8/10/2019 Module - DSpace Configuration (Slides)
21/34
Form Value Pairs
Form-value-pairs populate dropdown and qualdrop-value lists.The form-value-pairs element holds child elements named 'value- pairs A form value pair has two attributes:
value-pairs-namedc-term
ISSNissn
.....
-
8/10/2019 Module - DSpace Configuration (Slides)
22/34
Metadata Customisation
Create a new collection called Metadata
Once created, navigate into the collection, click edit on the admin toolsmenu and note its handle id i.e. 123456789/422
Open a terminal windowNavigate to [dspace]/config
Open the input-forms.xml using gedit: type gedit input -forms.xml Locate the lines:
-
8/10/2019 Module - DSpace Configuration (Slides)
23/34
Metadata Customisation
Add an additional line setting:collection- handle=form- name=one
This forces any submission into this collection to use a different input formLocate the form definition:
Try adding in you own field types using the dc elements in other fielddefinitions as a starting point
-
8/10/2019 Module - DSpace Configuration (Slides)
24/34
Metadata Customisation
Restart TomcatSubmit an item to your newly created collection Metadata The submission form input should now be modified
-
8/10/2019 Module - DSpace Configuration (Slides)
25/34
Configuring Emails/Notifications &Subscriptions
-
8/10/2019 Module - DSpace Configuration (Slides)
26/34
Email Notification & Subscription
Most Email Notifications & Subscriptions can be configuredthrough the dspace.cfg file: [dspace]/config/dspace.cfgSystem emails are based on templates found in:[dspace]/config/emails
# E-mail sent to DSpace users when they register for an account## Parameters: {0} is expanded to a special registration URL## See org.dspace.core.Email for information on the format of this file.#Subject: DSpace Account RegistrationTo complete registration for a DSpace account, please click the linkbelow:
{0}If you need assistance with your account, please [email protected] or call us at xxx-555-xxxx.
The DSpace Team
-
8/10/2019 Module - DSpace Configuration (Slides)
27/34
Configuring RSS Feeds
-
8/10/2019 Module - DSpace Configuration (Slides)
28/34
RSS Syndication
DSpace supports RSS SyndicationIt can be enabled by editing the dspace.cfg file
webui.feed.enable = trueThen restart Tomcat
Other Syndication settings such as:Number of items per feed
Syndication formats
What metadata is included in the feed
Can also be configured in the dspace.cfg file
-
8/10/2019 Module - DSpace Configuration (Slides)
29/34
Practical: RSS Syndication
Open the dspace.cfg file[dspace]/config/dspace.cfg
Locate the #### Syndication Feed Settings ######Modify webui.feed.enable
webui.feed.enable = true
Restart Tomcat as defined in your local instructions
Have an explore of what syndication features can beconfigured
-
8/10/2019 Module - DSpace Configuration (Slides)
30/34
Nightly Scripts
Configuring Nightly Scripts (cron Jobs)
-
8/10/2019 Module - DSpace Configuration (Slides)
31/34
-
8/10/2019 Module - DSpace Configuration (Slides)
32/34
Nightly Scripts
To schedule these scripts to run, execute the commandcrontab e as the DSpace userThen add the following lines:
# Send out subscription e-mails at 01:00 every day0 1 * * * [dspace]/bin/sub-daily# Run the media filter at 02:00 every day
0 2 * * * [dspace]/bin/filter-media# Run the checksum checker at 03:000 3 * * * [dspace]/bin/checker -lp# Mail the results to the sysadmin at 04:000 4 * * * [dspace]/bin/dsrun org.dspace.checker.DailyReportEmailer c
PostgreSQL also benefits from regular 'vacuuming # Clean up the database nightly at 4.20am20 4 * * * vacuumdb --analyze dspace > /dev/null 2>&1
-
8/10/2019 Module - DSpace Configuration (Slides)
33/34
Nightly Scripts
Generate Statistical reports:# Run stat analyses0 1 * * * [dspace]/bin/stat-general0 1 * * * [dspace]/bin/stat-monthly0 2 * * * [dspace]/bin/stat-report-general0 2 * * * [dspace]/bin/stat-report-monthly
The timings of each of these jobs can be modified to suit youinstitution
# +---------------- minute (0 - 59)# | +------------- hour (0 - 23)
# | | +---------- day of month (1 - 31)# | | | +------- month (1 - 12)# | | | | +---- day of week (0 - 7) (Sunday=0 or 7)
# | | | | |* * * * * command to be executed
-
8/10/2019 Module - DSpace Configuration (Slides)
34/34
Credits
These slides have been produced by:Stuart Lewis & Chris Yates
Repository Support Projecthttp://www.rsp.ac.uk/
Part of the RepositoryNet
Funded by JISChttp://www.jisc.ac.uk/