DSpace Basic Tutorial

1
DSpace Basic Tutorial

• Stuart Lewis Chris Yates
• support_at_rsp.ac.uk

2
Information

• Details
• Requires tutorial CD
• DSpace 1.4.2
• CD includes DSpace 1.5 alpha
• CD and workbook created by
• Chris Yates
• chris.yates_at_aber.ac.uk
• Stuart Lewis
• stuart.lewis_at_aber.ac.uk

3
Information

• Tutorial created by
• Repositories Support Project
• http//www.rsp.ac.uk/
• support_at_rsp.ac.uk
• Funded by
• JISC as part of the RepositoryNet

4
Contents

1. Introduction to DSpace
2. The tutorial CD
3. DSpace technical architecture
4. Users and groups
5. Item structure
6. Metadata and item input, workflows
7. Search and browse
8. Import / export / harvest

5
Introduction to DSpace

• DSpace captures your data in any format in text,
  video, audio, and data. It distributes it over
  the web. It indexes your work, so users can
  search and retrieve your items. It preserves your
  digital work over the long term. DSpace provides
  a way to manage your research materials and
  publications in a professionally maintained
  repository to give them greater visibility and
  accessibility over time.
• www.dspace.org

6
Introduction to the tutorial CD

• Intended to be used with tutorial
• DSpace version 1.4.2 (includes 1.5 alpha)
• Shouldnt affect your PC
• Installs no software
• Can be reused
• DOES NOT SAVE DATA!
• Disclaimer

7
DSpace Technical Architecture

• Written in Java
• Can be run on any platform that supports Java
• Most installation on Unix (Linux / Solaris)
• Runs on Windows / Mac OS X
• Sun JDK (not GNU)
• 1.4 for lt version 1.4.2
• 1.5 for gt version 1.5

8
DSpace Technical Architecture

• Database
• Same machine, or database server
• Postgres
• Oracle
• Web application server
• Tomcat
• Jetty
• Other

9
DSpace file layout

• Download
• dspace-src
• Edit config/dspace.cfg
• Build
• Installed
• dspace (often /dspace/)
• dspace/assetstore/
• dspace/upload/
• dspace/logs/
• dspace/bin/
• dspace/search/

10
Create the database

• Create a database user
• Who will own the database
• Called dspace
• Create the database
• Called dspace
• UNICODE encoding
• Owned by the dspace database user

11
Create the database

• Create a database user
• Double click on the Terminal icon
• su - postgres password is postgres
• createuser -U postgres -d -P dspace
• password is postgres
• Create the database
• createdb -U dspace -E UNICODE dspace

12
Build DSpace

• DSpace needs to be compiled
• Uses ant build system
• Inserts default data into the database
• Table structures
• Dublin Core metadata schema
• Bitstream formats
• Builds package for the web server
• Configuration can be changed

13
Build DSpace

• cd /dspace142-src/
• gedit config/dspace.cfg
• Change dspace.name to your name
• Save and quit
• ant fresh_install
• chmod 777 /dspace142/upload
• chmod 777 /dspace142/assetstore

14
Deploy to the web server

• .war files are packaged applications
• Tomcat is a Java web application server
• Tomcat automatically unpacks .war files
• Two web applications
• DSpace DSpace OAI interface
• Copy .war files to Tomcat directory
• Start Tomcat

15
Deploy to the web server

• cp build/.war /var/lib/tomcat5.5/
• sudo /etc/init.d/tomcat5.5 start
• Load Firefox
• Go to http//localhost8080/dspace/

16
DSpace users and groups

• Administrator
• bin/create-administrator
• Create more users
• Web user interface
• Administrator
• Other authentication methods
• LDAP (LDAP or Active Directory)
• Plugable and stackable authentication

17
DSpace users and groups

• Groups
• Members can be users of other groups
• E.g. Dept group made up of research group groups
• User defined or
• Automatically generated for collections

18
Create DSpace users

• Create an administrator
• Log in
• Log out
• Create a normal user
• Modify a group

19
Create DSpace users

• Create first administrator
• bin/create-administrator
• Answer questions
• Create another user
• Administrator pages, E-People
• Add EPerson
• Promote new user to administrator
• Administrator pages, Groups
• Edit Administrator group

20
Communities collections

• Communities
• Often used to represent organisational units
• Can have sub-communities and collections
• Can be branded (logo) and have own policies
• Collections
• Holds items

21
Communities collections

• Communities / Collections link
• Create Top-Level Community
• Enter name, short description
• Press Create button
• Create collection
• Enter name, short description
• Add the Administrator group to submitters

22
DSpace items

• Metadata
• One or more metadata schemas
• User-entered
• System-generated (e.g. accessioned date)
• Files
• In bundles
• Special bundles (e.g. extracted text, licences)

23
DSpace Items

• Items can be mapped across collections
• E.g. appear in central and departmental e-theses
  collections
• Same as a file system symbolic link
• Submissions controlled by input forms
• config/input-forms.xml
• Input forms
• Controlled vocabularies

24
DSpace Items

• input-forms.xml
• ltform-mapgt
• ltname-map collection-handle"default"
  form-name"traditional" /gt
• ltname-map collection-handle2160/56
  form-nameetheses" /gt
• ltname-map collection-handle2160/802"
  form-namelawdepartment" /gt
• lt/form-mapgt

25
input-forms.xml

• ltform name"traditional"gt
• ltpage number"1"gt
• ltfieldgt
• lt/fieldgt
• ltfieldgt
• lt/fieldgt
• lt/pagegt
• ltpage number""gt
• lt/pagegt
• lt/formgt

26
input-forms.xml

• ltfieldgt
• ltdc-schemagtschemalt/dc-schemagt
• ltdc-elementgtelementlt/dc-elementgt
• ltdc-qualifiergtqualifierlt/dc-qualifiergt
• ltrepeatablegttrue/falselt/repeatablegt
• ltlabelgtText labellt/labelgt
• ltinput-typegtname/onebox/date/twobox/textarea/drop
  down/
• qualdrop_valuelt/input-typegt
• lthintgtExpanded hintlt/hintgt
• ltrequiredgtWarning to show if not
  enteredlt/requiredgt
• lt/fieldgt

27
input-forms.xml

• ltvalue-pairs value-pairs-namename"
  dc-termelement"gt
• ltpairgt
• ltdisplayed-valuegtEnglishlt/displayed-valuegt
• ltstored-valuegtenlt/stored-valuegt
• lt/pairgt
• ltpairgt
• ltdisplayed-valuegtWelshlt/displayed-valuegt
• ltstored-valuegtcylt/stored-valuegt
• lt/pairgt
• ltvalue-pairsgt

28
input-forms.xml

• ltfieldgt
• ltdc-schemagtdclt/dc-schemagt
• ltdc-elementgtcontributorlt/dc-elementgt
• ltdc-qualifiergtauthorlt/dc-qualifiergt
• ltrepeatablegttruelt/repeatablegt
• ltlabelgtAuthorslt/labelgt
• ltinput-typegtnamelt/input-typegt
• lthintgtEnter the names of the authors of this
  item below.lt/hintgt
• ltrequiredgtlt/requiredgt
• lt/fieldgt

29
input-forms.xml

• ltfieldgt
• ltdc-schemagtdclt/dc-schemagt
• ltdc-elementgttitlelt/dc-elementgt
• ltdc-qualifiergtlt/dc-qualifiergt
• ltrepeatablegtfalselt/repeatablegt
• ltlabelgtTitlelt/labelgt
• ltinput-typegtnamelt/input-typegt
• lthintgtEnter the main title of the item.lt/hintgt
• ltrequiredgtYou must enter a main title for this
  item.lt/requiredgt
• lt/fieldgt

30
Deposit an item

• Choose collection
• Enter metadata
• Upload file
• Confirm details
• Agree to the licence

31
Deposit an item

• Enter the collection you created
• Tick The item has been published or publicly
  distributed before - asks extra questions about
  the publishing (i.e. date / publisher)
• Enter metadata
• Upload file (/dspace-docs/RSP.pdf)
• Agree to licence
• Submit item

32
Create a workflow

• Three workflows
• Accept/reject step
• E.g. Head of research
• Should item be included in the repository?
• Accept/reject/edit metadata step
• E.g. Repository manager
• Edit metadata step
• E.g. Librarian

33
Create a workflow

• Create new collection
• Tick This submission will include and
  accept/reject/edit metadata step
• Enter name and short description
• Add Administrator group to workflow
• Submit to the new collection
• Go to My DSpace to enter the workflow
• Edit Metadata
• Approve

34
Search and browse

• Browse
• By
• Author / title / date
• Database driven
• Always up to date
• Search
• Lucene search engine
• Define fields to index in dspace.cfg
• Full texts
• Not always up to date

35
Search system initalisation

• Build indexes
• Index metadata
• Extract from database
• Index full-texts
• Extract from PDF/Doc files
• Extra MediaFilters can be written

36
Search system initalisation

• Search Aberystwyth
• No results
• Run
• bin/filter-media
• Extract full texts
• (create thumbnails)
• Build indexes
• Search Aberystwyth
• See results!

37
Scheduled background jobs

• filter-media
• Extract texts and build indexes
• sub-daily
• Email subscription emails
• checker
• checks bitstream checksums
• stat-
• statistics

38
RSS feeds and thumbnails

• Configured in dspace.cfg
• RSS feeds
• webui.feed.enable falsetrue
• webui.feed.localresolve falsetrue
• Thumbnails
• webui.item.thumbnail.show truefalse
• webui.browse.thumbnail.show falsetrue

39
RSS feeds and thumbnails

• gedit /dspace142/config/dspace.cfg
• Set webui.feed.enable to true
• Set webui.feed.localresolve to true
• sudo /etc/init.d/tomcat5.5 restart
• Upload new item with PNG file
• Upload png from /home/dspace/examples/
• /dspace142/bin/filter-media
• See thumbnail

40
Import / export

• See docs
• Bulk import command line tool
• Imports one item per directory
• Multiple files / metadata file / contents file
• Bulk exporter
• Writes same file format
• Adds file containing handle (for re-import)

41
Import / export

• archive_directory/
• item_000/
• dublin_core.xml -- qualified DC metadata
  
• contents -- one line per filename
• file_1.doc -- files to be added
  file_2.pdf
• dspace/bin/dsrun org.dspace.app.itemimport.ItemI
  mport --add
• --eperson joe_at_user.com
• --collectioncollectionID
• --sourceitems_dir
• --mapfilemapfile

42
Harvesting / OAI-PMH

• OAI-PMH interface
• Separate web application
• /dspace-oai/
• /dspace-oai/request?verb
• /dspace-oai/request?verbIdentify
• /dspace-oai/request?verbListSets
• /dspace-oai/request?verbGetRecord
• /dspace-oai/request?verbListIdentifiers
• /dspace-oai/request?verbListMetadataFormats
• /dspace-oai/request?verbListRecords

43
The end

• Incomplete
• Lots lots more!
• Email support_at_rsp.ac.uk
• Email dspace-tech email list
• Advanced tutorial this afternoon
• Or surgery / open discussion / demos