1. The DSpace Course Module - DSpace Configuration

2. Module objectives  By the end of this module you will:  Understand how to configure the submission interface via input-forms.xml  How to configure Emails/Notifications & Subscriptions  How to enable and configure RSS feeds  How to configure nightly scripts (filter media/index-all)

3. Modifying the Submission Process Submission Steps

4. The submission configuration file  The submission configuration file controls the ordering of the steps used to collect information during item deposit [dspace]/config/item-submission.xml  Traditional Submission Process Initial Questions -> Describe -> Upload -> Verify -> License -> Complete

5. The Structure of item-submission.xml...

6. The submission map  The submission can be configured for individual collections using the  The collection-handle is the unique identifier for the collection  The submission-name=“mysub” relates to the submission process name

7. Submission Process  It is possible to modify the traditional submission order to suit you institution For example, the licence acceptance first: Before: Initial Questions -> Describe -> Upload -> Verify -> License -> Complete After: 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.  So in the example below, the licence will be displayed before the initial questions are asked submit.progressbar.license org.dspace.submit.step.LicenseStep org.dspace.app.webui.submit.step.JSPLicenseStep org.dspace.app.xmlui.aspect.submission.submit.LicenseStep false submit.progressbar.initial-questions org.dspace.submit.step.InitialQuestionsStep org.dspace.app.webui.submit.step.JSPInitialQuestionsStep org.dspace.app.xmlui.aspect.submission.submit.InitialQuestionsStep true

9. Practical: Submission Order  Open [dspace]/config/item-submission.xml sudo gedit [dspace]/config/item-submission.xml  Locate the code block below  Move this above step 1 as below

10. Practical: Submission Order  Restart Tomcat  Submit an item to your newly created collection ‘Metadata’  The licence should now appear first

11. Modifying the Submission Process Input Forms

12. A bit on Metadata  Metadata is data that describes other data  DSpace uses metadata to describe internal objects such as communities, EPeople, collections & items  Metadata for an item is defined in the DSpace registry  Default out-of-the-box schema used by DSpace is Dublin Core  Each field in an items metadata is represented by a DC element dc contributor author Schema in use Descriptive element Qualifier

13. A bit more on Metadata  The metadata registry can be configured via the DSpace GUI

14. The Submission Process  Out of the box, DSpace, as expected uses a default submission process  This submission process can be customised allowing:  Adding additional metadata to be collected about an item  Individual collections to have unique metadata for their items

15. Input-forms.xml  The forms used during a submission of an item via the UI are created based 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 which contains 3 elements:  Mapping which denotes what collections use which form  What makes up an individual forms  Definition of selection lists included in the form

16. Form Map  The form-map maps collection handles to forms  Each has 2 attributes:  collection-handle="collectionHandle” (“default“ if not selected)  form-name="formName“ (e.g. )  Collection 123456789/110 has a form called ‘one’ defined

17. Form Definitions  The form-definitions map lays out what types of form are included in the submission  Each separate form set has a unique name as an attribute. This name is used to associate a form to a collection in the form-map  A form called “traditional” has been defined in this form definition...

18. 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: .....

19. Form Definitions - Fields  A consists of: NameMandatory?Description Truemetadata schema name Truemetadata element metadata qualifier Values: true or false Marks a field as repeatable. TrueLabel used in User Interface TrueType of input field that is displayed TrueHint used in User Interface If completed, the field is marked as mandatory. dc contributor author true One: Authors name Enter the names of the authors of this item below.

20. Form Definitions - Fields  The input-type: Input-typeDescription 1oneboxSingle boxes for short text 2twoboxA pair of single boxes 3textareaA text area 4nameA pair of text boxes for personal names 5dateAt least a year must be given 6dropdownA selection list 7qualdrop-valueA selection list combined with a single text box 1. 2. 4. 5. 6.3.

21. 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-name  dc-term ISSN issn.....

22. Metadata Customisation  Create a new collection called ‘Metadata’  Once created, navigate into the collection, click edit on the ‘admin tools’ menu and note its handle id i.e. 123456789/422  Open a terminal window  Navigate to [dspace]/config  Open the input-forms.xml using gedit: type ‘gedit input-forms.xml’  Locate the lines:

23. Metadata Customisation  Add an additional line setting:  collection-handle=“ ”  form-name=“one”  This forces any submission into this collection to use a different input form  Locate the form definition:  Try adding in you own field types using the dc elements in other field definitions as a starting point

24. Metadata Customisation  Restart Tomcat  Submit an item to your newly created collection ‘Metadata’  The submission form input should now be modified

25. Configuring Emails/Notifications & Subscriptions

26. Email Notification & Subscription  Most Email Notifications & Subscriptions can be configured through the dspace.cfg file: [dspace]/config/dspace.cfg  System 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 Registration To complete registration for a DSpace account, please click the link below: {0} If you need assistance with your account, please email dspace-help@myu.edu or call us at xxx-555-xxxx. The DSpace Team

27. Configuring RSS Feeds

28. RSS Syndication  DSpace supports RSS Syndication  It can be enabled by editing the dspace.cfg file  webui.feed.enable = true  Then 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

29. 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 be configured

30. Nightly Scripts Configuring Nightly Scripts (‘cron’ Jobs)

31. Nightly Scripts  A couple of DSpace features require that a script is run regularly  Email subscriptions feature (deposit alert)  Filter media tool (generates thumbnails & extracts full-text)  Indexer  Statistics generation

32. Nightly Scripts  To schedule these scripts to run, execute the command crontab –e as the DSpace user  Then add the following lines:  # Send out subscription e-mails at 01:00 every day  0 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:00  0 3 * * * [dspace]/bin/checker -lp  # Mail the results to the sysadmin at 04:00  0 4 * * * [dspace]/bin/dsrun org.dspace.checker.DailyReportEmailer –c  PostgreSQL also benefits from regular 'vacuuming‘  # Clean up the database nightly at 4.20am  20 4 * * * vacuumdb --analyze dspace > /dev/null 2>&1

33. Nightly Scripts  Generate Statistical reports:  # Run stat analyses  0 1 * * * [dspace]/bin/stat-general  0 1 * * * [dspace]/bin/stat-monthly  0 2 * * * [dspace]/bin/stat-report-general  0 2 * * * [dspace]/bin/stat-report-monthly  The timings of each of these jobs can be modified to suit you institution # +---------------- 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

34. Credits  These slides have been produced by:  Stuart Lewis & Chris Yates  Repository Support Project  http://www.rsp.ac.uk/  Part of the RepositoryNet  Funded by JISC  http://www.jisc.ac.uk/