You are here

Frequently Asked Questions - Metadata in CLARIN: harvesting and VLO

Yes - bringing all metadata descriptions together ("harvesting") and making them searchable ("indexing")  is an important part of the infrastructure that CLARIN is building. When you provide CMDI metadata CLARIN can harvest it and make it available via the Virtual Language Observatory.

If you have many metadata records or records that frequently change:

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.

More (technical) details about the harvesting process and results can be found in the OAI Harvest Viewer.

The VLO uses concepts from the CMDI profiles (and in some cases XPaths as a fallback). A detailed overview is available at:

https://vlo.clarin.eu/mapping

More information about this topic can be found in this paper

The harvester uses the namespace url to detect the provided metadata format (http://www.clarin.eu/cmd/ for CMDI), so all prefixes get included automatically. If you nevertheless encounter unexpected behaviour, please contact harvester@clarin.eu.

You can use the harvester yourself. Its source code is available at GitHub.

By the way, if you only need access to the harvested files, you can also download these as a tarball.

Yes. If you contact cmdi@clarin.eu we can try to import your newly created CMDI metadata in the VLO Alpha instance, so that you get an idea how well the mapping to the VLO facets works.

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 vlw@clarin.eu.

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 cmdi@clarin.eu.

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 result ranking is based on relevancy with respect to the query (if applicable) and a number of general record properties. This is further explained in the section Understanding Search Results of the VLO's help page.

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.

All resources linked to from records that appear in the VLO are checked for accessibility at a regular basis as part of the processing by the CLARIN Curation Module.

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 (vlo@clarin.eu).