Jorum has a range of technical interfaces to help you get content, metadata and data out of Jorum, and to help us pull your content and metadata into Jorum. This page is still under development; it gives an overview of what you can expect. For more detailed information please contact us at firstname.lastname@example.org.
Overview of Basic Technical Details
Jorum is a repository for open educational resources (OERs) built on the open source repository platform DSpace 4. Users deposit to Jorum through the standard DSpace deposit interface.
Metadata and Licensing
We collect, store and make available data about views and downloads of our OERs. See our Reports for the user interface to this data- and see below under Jorum API for accessing it.
Anyone in UK Higher or Further Education can deposit resources in Jorum by logging in using their institutional Shibboleth or OpenAthens account. For those who have resources that are suitable for UK HE and FE, but no institutional login account, we offer Trusted Depositor accounts.
We have our own custom-built user interface for searching and browsing Jorum’s resources and accessing reports on usage data on the Web. This is built on our own API with DSpace, ElasticSearch and SOLR pulled together, and uses Cottage Labs FacetView. The diagram below explains Jorum’s architecture (Click on the image to enlarge).
Pulling content, metadata and data out
We offer access to Jorum resources via:
- OAI-PMH and RSS feeds to our collections. These allow you to pull out metadata about and links to our resources.
- The Jorum API
Depositing content and metadata
We have bulk deposit options:
- OAI-PMH ingest. We can pull in metadata and links from other repositories using their OAI-PMH feeds, as long as (a) the resources are Creative Commons licensed, with the licence URL in the dc.rights field; (b) you provide a link to the resource in the metadata and Â© you make your keywords or tags available in the dc.subject field. Users will be able to access your collection within Jorum under its own name, or find your resources through searching. Once they have found a resource from your collection, they click a link and end up in your repository.
- SWORD deposit. We have implemented SWORD v2 as a deposit interface, which will enable those with content creation tools to offer a Deposit to Jorum feature. This allows files and their metadata to be deposited without going through the DSpace deposit user interface. More on this soon. Please contact us if you want to work with us on this: email@example.com.
- Bulk deposit by spreadsheet. We have in the past offered bulk deposit via CSV / spreadsheet; this has not been updated yet for the new version of DSpace we are running on, but we are monitoring whether this will remain a requirement and are open to developing this further.
- RSS ingest. We have in the past offered RSS feed ingest, but this is now deprecated as it proved unsuitable for repository deposit.
What is OAI-PMH and how does Jorum use them?
OAI-PMH (Open Archives Initiative Protocol for Metadata Harvesting) is “a low-barrier mechanism for repository interoperability”. Data Providers, such as Jorum, are repositories that expose structured metadata via OAI-PMH. Other services (Service Providers) can make OAI-PMH “service requests” to harvest that metadata. Service requests are defined by the OAI-PMH specification and allow Service Providers to retrieve information about the metadata held in a repository that has been made available by a Data Provider.
OAI-PMH has a concept of “sets”. Sets are groups of records that the Data Provider has decided to expose via OAI-PMH. In the case of Jorum these sets are mapped directly to the “collections” held in the Jorum repository. OAI-PMH has a concept of “sets”. Sets are groups of records that the Data Provider has decided to expose via OAI-PMH. In the case of Jorum these sets are mapped directly to the “collections” held in the Jorum repository. Please note that currently there is one collection / set that contains resources that are not openly licensed: “College Development Network (Resources Licensed to Colleges)”. These resources do not appear in Jorum, but are in the Re:Source repository supported by Jorum as one of our Jorum Powered partners. For each of these sets, metadata records describing the resources held in that set may be retrieved and processed by a Service Provider.
Service Provider Configuration
- The Jorum OAI-PMH service may be accesed at http://dspace.jorum.ac.uk/oai/request. This is the main URL for the service and will be likely to be the one required for configuring a service that wishes to harvest all metadata records from Jorum.
- The metadata formats that can be supplied by Jorum can be accessed at http://dspace.jorum.ac.uk/oai/request?verb=ListMetadataFormats.
- The sets that are available for harvesting from Jorum are available at http://dspace.jorum.ac.uk/oai/request?verb=ListSets.
Following basic REST principals but searched via Value:Key pairs in the querystring.
A basic userguide can be found here: api.jorum.ac.uk/help/
The first public version of the Jorum API was released in April 2014.