You are here
Frequently Asked Questions - Metadata in CLARIN: harvesting and VLO
If you have many metadata records or records that frequently change:
- Use OAI-PMH
- Provide them preferrably as CMDI (click here for details about how to serve CMDI over OAI-PMH)
- If that is not possible provide them as OLAC
- Depending on the situation your endpoint has to be added to the centre registry (in case of a registered CLARIN centre), or added manually to our harvester
- In case of a CLARIN centre
- if your centre has already been registered in the Centre Registry, contact the Centre Registry administration via e-mail. Make sure to provide the name of your centre and the complete URL of the endpoint.
- if your centre has not yet been registered in the Centre Registry, fill in the Centre Registry registration form.
- Send a mail to firstname.lastname@example.org to notify us about your OAI-PMH access point
- In case of a CLARIN centre
If you have only a few static records and setting up an OAI-PMH access point is not feasible:
- Submit your records to the Language Resource Inventory (for data, corpora, lexica, web services, software, ...)
- All the records in the LRT inventory will be automatically converted into CMDI records. Note that this process can take a while.
Data provided over OAI-PMH or via the LRT inventory will be made available and searchable via the Virtual Language Observatory.
No, we are not. It is a term used for gathering metadata descriptions from several locations and storing it in a central database. You can find the results of such a harvesting process at https://vlo.clarin.eu
More information about harvesting metadata can be found at http://en.wikipedia.org/wiki/Open_Archives_Initiative_Protocol_for_Metad...
There are several packages available to setup an OAI provider, some popular examples:
file-based, Tomcat web application written in Java: jOAI (some centres have good experiences with this one)
database-based, written in PHP: oai-pmh-2
- library to connect to a Java application: OAIProvider
More tools to setup an OAI data provider can be found at the OAI webpage.
The metadata harvester runs with different configurations at different starting times:
- Monday and Thursday 20:00 CET/CEST: harvesting of CLARIN providers
- Friday 20:00 CET/CEST: harvesting of non-CLARIN providers
The VLO importer for the production VLO runs after every completed harvest (importing all current metadata, both CLARIN and non-CLARIN).
Combined, harvester/import runs typically take about 12-20 hours to complete, depending primarily on the response rate of the metadata providers.
Because of this schedule, it can take a couple of days before provided metadata becomes available in the VLO. If it takes longer than that, please send a message to email@example.com.
Be aware that the harvester and VLO schedule may be subject to change in the future!
Some or most of my records seem to have been harvested and imported in the VLO fine. However, some records seem to have been omitted. How come?
If some or most of your records have been harvested and imported in the VLO fine, but some records seem to have been omitted, they were probably explicitly skipped by the VLO importer process. Records with no (valid) resource proxies are omitted from the import process. Make sure to always include at least one resource proxy, for example a landing page or link to a resource (see "How does the Resources section work?"). The VLO import process also skips records that are too large. The limit currently lies at 50 megabytes. If you have larger metadata records that you think should be included, please contact us at firstname.lastname@example.org.
Note that metadata files that are not in the CMDI 1.2 version get converted before import. The limit applies to the converted file, so certain records may get skipped even if the original file is within the size limit. Typically a converted record should not be more than twice the size of the original file, depending on the formatting. Typically the file size difference is 20% or less.
If files seem to be omitted from hierarchies, but do appear in the VLO in isolation, the most likely reason is that the Resource Proxy reference value (a URL or PID) used in the parent record does not match the self link value (in the MdSelfLink header item) in the referenced record. The VLO will only consider a record to be a parent of another record if it uses the exact self link of the latter to link to it.
The CLARIN Curation Module analyses the metadata harvested for inclusion in the VLO. It creates reports for metdata collections on basis of a schedule. Collection reports are generated on Tuesday and Saturday beginning at 7 p.m CET. At the end of the procedure which takes about 2 hours, the curation module web site is reinitialised. This takes a few minutes to complete, after which the latest reports are available. The data and time of analysis is included in the collection report.
The link checking information is read by the VLO when importing resources and regularly updated. The VLO discards any information that is too old (more than 100 days). Resources that were found to either be unavailable or require special permissions to access are marked with an icon to indicate either unavailability (warning sign) or restricted access (lock icon). This classification happens on basis of the encountered HTTP response code (for example 404 or 503 is classified as unavailable, 401 or 403 as restricted). These icons are shown in the VLO search results for records with one or more problematic linked resources. The resources detail panel of record pages show a status per link. Each link can be expanded to reveal details regarding the last check: status code and time of checking.
Note that the link checking information may be outdated at the time it is displayed in the VLO. The link checker can only check the status of each resource location with a certain frequency, and the availability status may change.
If you find that a resource found in the VLO is actually unavailable or has restricted access but would like to access it, contact its provider via the landing page (if available) or look for contact information in the 'All metadata' tab.
If you are a resource provider and believe that the displayed accessability status information shown for your resources is incorrect, please contact the VLO developers (email@example.com).