Module OAI-PMH
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 website.
Metadata prefix
The metadata prefixes indicate two different metadata collections:
-
OpenOlat specific (learning resource URL is included in the title): www.yourwebsite.com/oaipmh?verb=listRecords&metadataprefix=oai_oo
-
Dublin Core 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 Dublin Core |
|---|---|---|
| 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 (contributor) |
| 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 > SEO / OAI-PMH metadata. 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.
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 the API endpoint by clicking the button beneath the URL.
Identifier format
The identifier format can be used to set the format of the identifier. Either you use the Dublin Core namespace or OpenOlat's own identifier, which also contains the resource info, where you also see the info page.
Licence restrictions
Learning resources can be restricted by licence. Either only learning resources with a licence or learning resources with a specific licence type are shared through the interface. If licences for learning resources are not activated, no learning resources are indexed when a restriction is applied.
API Configuration
Sets
Different sets can be selected. Sets categorize the metadata of learning resources of different types.
- Taxonomy-based set
- Organisation-based set (based on administrative org relationship)
- OER-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: sitemap.xml, 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, enter its URL under "Custom".
When "Search Engine publish" is switched on, two additional fields for the search engine metadata appear. Both fields are optional; if left empty, the system uses the default values.
Organisation name
Overrides the organisation name used in the search engine metadata (for example in the Open Graph field "og:site_name"). If left empty, the name of the default organisation is used.
Keywords
Override the global meta keywords (meta tag "keywords") output on all pages. If left empty, the system uses the preset keywords.
Further information
Mentioned on this page
Open Archives website
indexNow