Modules: OAI-PMH
available on Release 17.2
The purpose of the "Open Archives Initiative - Protocol for Metadata Harvesting" (OAI-PMH): access to digital resources, in our case published learning resources for metadata sharing with portals, search engines or catalogues. More information can be found on the Open Archives web site.
Administration
The module can be switched on under 'Administration-> Modules -> OAI PMH'. It is deactivated by default on every instance. If the module is switched on, the API end-point is also available, where all published resources are available via XML.
API Endpoint
This is the application interface from which the metadata is retrieved. Different parameters can be used to filter for different learning resources. You can test die API endpoint, by clicking onto the button beneath the URL.
Metadata prefix
The metadata prefixes indicate two different metadata collections:
-
OpenOlat specific (Learningressource URL is included in the title): www.yourwebsite.com/oaipmh?verb=listRecords&metadataprefix=oai_oo
-
Dublincore metadata: www.yourwebsite.com/oaipmh?verb=listRecords&metadataprefix=oai_dc
The respective XML element in the corresponding metadata collection is described in brackets.
| Metadaten | OAI OpenOlat | OAI DublinCore |
|---|---|---|
| identifier | x | x |
| url | x | -- |
| info_url | x | x (source) |
| title | x (displayname) | x |
| taxonomy | x | x (subject) |
| resourcename | x | -- |
| initialauthor | x | x (creator) |
| softkey | x | -- |
| location | x | -- |
| description | x | x |
| publisher | x | x |
| requirements | x | -- |
| credits | x | -- |
| allowtoleave | x | -- |
| authors | x | x (contributer) |
| Date | x (creationDate) | x |
| r_identifier | x | -- |
| resname | x | x (format) |
| expenditureofwork | x | -- |
| teaser | x | x (coverage) |
| teaserImage | x | -- |
| canDownload | x | -- |
| canCopy | x | -- |
| canReference | x | -- |
| status_published_date | x | -- |
| language | x (mainlanguage) | x |
| license_name | x | x (rights = + license_licensor) |
| license_licensor | x | -- |
| sets | x | x |
| deleted | x | x |
Administration
The module can be switched on under 'Administration-> Modules -> OAI PMH'. It is deactivated by default on every instance. If the module is switched on, the API endpoint, where all published resources are listed via XML, is also available.
Identifier Type
The identifier type can be set with the identifier type. Either you use the DublinCore namespace or OpenOlat's own identifier, which also contains the resource info, where you also see the info page.
License restrictions
One can restrict learning resources. Either only learning resources with licences or learning resources with a specific licence type will send their metadata through the interface.
API Configuration
Sets
Different sets can be selected. Sets categorise the metadata of learning resources of different types.
- Taxonomy-based set
- Organisation-based set, based on administrative org relationship).
- Licence-based set, sorted by licence type
- Type-based set, sorted by learning resource types such as course, video, podcast.
- Offer-based set, sorted by the offer types such as private, bookable with account, guest.
Search Engine Optimization
This allows you to actively make shared learning resources accessible to search engines. There are two methods: sitemapxml which is mainly used by google and indexnow by bing and others. This collection is actively triggered once a week.
If you have your own search engine index, you can enter its url under "custom".