Edurep:Leermateriaal Metadata Aanbieden/en: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
k (version number)
k (/en)
 
Regel 1: Regel 1:
 
{{Talen}}
 
{{Talen}}
Simply put, metadata about learning material is offered to Edurep via the {{Standaard|OAI-PMH}} protocol and in the {{Standaard|NL LOM}} format.
+
Simply put, metadata about learning material is offered to Edurep via the [[Standaarden: OAI-PMH/en|OAI-PMH]] protocol and in the {{Standaard|NL LOM}} format.
   
 
A simple [[Edurep:Voorbeeld Implementatie Aanbieder/en|example use case]] has been developed that follows the steps of this manual.
 
A simple [[Edurep:Voorbeeld Implementatie Aanbieder/en|example use case]] has been developed that follows the steps of this manual.
Regel 11: Regel 11:
 
The correct functioning of the metadata in Edurep depends on identifiers. Each learning resource and each metadata record must have a unique identifier in the provider's repository. It is recommended to use so-called {{Standaard|UPI}}s (Unique Persistent Identifiers) for this.
 
The correct functioning of the metadata in Edurep depends on identifiers. Each learning resource and each metadata record must have a unique identifier in the provider's repository. It is recommended to use so-called {{Standaard|UPI}}s (Unique Persistent Identifiers) for this.
   
* Metadata record identifiers are used in Edurep when synchronizing retrieved metadata records. [[Standaarden:OAI-PMH#Identifiers|Read more]].
+
* Metadata record identifiers are used in Edurep when synchronizing retrieved metadata records. [[Standaarden:OAI-PMH/en#Identifiers|Read more]].
* Object identifiers are used in Edurep to link different metadata records (e.g. reviews). [[Edurep:Identifiers|Read more]].
+
* Object identifiers are used in Edurep to link different metadata records (e.g. reviews). [[Edurep:Identifiers/en|Read more]].
   
 
=== Export Metadata ===
 
=== Export Metadata ===
 
Metadata about learning resources must be specified according to the {{Standaard|NL LOM}} or {{Standaard|Schema.org}} standard. The standard defines which metadata fields are in use, which are mandatory, which are recommended, and which are optional fields. We recommend that you fill in the data, if possible, for all the recommended fields, as this will increase the probability that the material will be found and thus become more accessible to users.
 
Metadata about learning resources must be specified according to the {{Standaard|NL LOM}} or {{Standaard|Schema.org}} standard. The standard defines which metadata fields are in use, which are mandatory, which are recommended, and which are optional fields. We recommend that you fill in the data, if possible, for all the recommended fields, as this will increase the probability that the material will be found and thus become more accessible to users.
* It is recommended to read the tips per field to see how each field should be exported. [[Edurep:Metadata|Read more]].
+
* It is recommended to read the tips per field to see how each field should be exported. [[Edurep:Metadata/en|Read more]].
 
* Specific information on how to metadata subject areas, learning levels and objectives is available in the OBK. [[OBK:Metadatering Leermateriaal|Read more]].
 
* Specific information on how to metadata subject areas, learning levels and objectives is available in the OBK. [[OBK:Metadatering Leermateriaal|Read more]].
 
* When importing, Edurep performs a number of automatic operations to validate the metadata and improve the quality where possible. Read more about the automatic operations that Edurep performs [[Edurep:Metadata verwerking|here]].
 
* When importing, Edurep performs a number of automatic operations to validate the metadata and improve the quality where possible. Read more about the automatic operations that Edurep performs [[Edurep:Metadata verwerking|here]].
 
We recommend starting the OAI endpoint implementation with a minimal set of metadata fields and focusing on correctly forwarding metadata records in the first phase of the project. When the OAI endpoint functions properly, the set of metadata fields can be expanded.
 
We recommend starting the OAI endpoint implementation with a minimal set of metadata fields and focusing on correctly forwarding metadata records in the first phase of the project. When the OAI endpoint functions properly, the set of metadata fields can be expanded.
 
=== Synchronize Metadata ===
 
=== Synchronize Metadata ===
To synchronize the repository metadata with Edurep, we use the {{Standaard|OAI-PMH}} protocol. For synchronization to proceed properly, it is necessary:
+
To synchronize the repository metadata with Edurep, we use the [[Standaarden: OAI-PMH/en|OAI-PMH]] protocol. For synchronization to proceed properly, it is necessary:
 
* that each metadata record is uniquely identified
 
* that each metadata record is uniquely identified
 
* the time at which the change in the metadata record takes place must be recorded. Changes that need to be recorded include not only adding a new metadata record when publishing to Edurep, but also modifying existing metadata records and unpublishing them.
 
* the time at which the change in the metadata record takes place must be recorded. Changes that need to be recorded include not only adding a new metadata record when publishing to Edurep, but also modifying existing metadata records and unpublishing them.
 
* we also test the "flow control", the correct use of the ''resumptionToken'' and the ''from'' argument.
 
* we also test the "flow control", the correct use of the ''resumptionToken'' and the ''from'' argument.
[[Standaarden: OAI-PMH|This page]] contains the necessary tips for implementation.
+
[[Standaarden: OAI-PMH/en|This page]] contains the necessary tips for implementation.
 
== Connection to Edurep ==
 
== Connection to Edurep ==
 
If the repository can offer the NL LOM data via OAI-PMH, it can be registered for testing with our {{Servicedesk}}. We test the collection in our Staging environment and, if successful and to the customer's satisfaction, we link the collection to the Production environment.
 
If the repository can offer the NL LOM data via OAI-PMH, it can be registered for testing with our {{Servicedesk}}. We test the collection in our Staging environment and, if successful and to the customer's satisfaction, we link the collection to the Production environment.

Huidige versie van 26 okt 2023 om 15:53

Nl.gif Nederlands En.gif English

Simply put, metadata about learning material is offered to Edurep via the OAI-PMH protocol and in the NL LOM format.

A simple example use case has been developed that follows the steps of this manual.

Setting up the system

How should a provider prepare their system to offer metadata to Edurep?

  • Metadata, i.e. descriptions of learning materials, must be in the format defined in the NL LOM standard.
  • Providers of learning materials must create a repository in which these metadata are stored.
  • To synchronize the Edurep repository with the repositories of various providers, it is necessary to use the OAI-PMH protocol for the exchange of metadata.

Importance of Identifiers

The correct functioning of the metadata in Edurep depends on identifiers. Each learning resource and each metadata record must have a unique identifier in the provider's repository. It is recommended to use so-called UPIs (Unique Persistent Identifiers) for this.

  • Metadata record identifiers are used in Edurep when synchronizing retrieved metadata records. Read more.
  • Object identifiers are used in Edurep to link different metadata records (e.g. reviews). Read more.

Export Metadata

Metadata about learning resources must be specified according to the NL LOM or Schema.org standard. The standard defines which metadata fields are in use, which are mandatory, which are recommended, and which are optional fields. We recommend that you fill in the data, if possible, for all the recommended fields, as this will increase the probability that the material will be found and thus become more accessible to users.

  • It is recommended to read the tips per field to see how each field should be exported. Read more.
  • Specific information on how to metadata subject areas, learning levels and objectives is available in the OBK. Read more.
  • When importing, Edurep performs a number of automatic operations to validate the metadata and improve the quality where possible. Read more about the automatic operations that Edurep performs here.

We recommend starting the OAI endpoint implementation with a minimal set of metadata fields and focusing on correctly forwarding metadata records in the first phase of the project. When the OAI endpoint functions properly, the set of metadata fields can be expanded.

Synchronize Metadata

To synchronize the repository metadata with Edurep, we use the OAI-PMH protocol. For synchronization to proceed properly, it is necessary:

  • that each metadata record is uniquely identified
  • the time at which the change in the metadata record takes place must be recorded. Changes that need to be recorded include not only adding a new metadata record when publishing to Edurep, but also modifying existing metadata records and unpublishing them.
  • we also test the "flow control", the correct use of the resumptionToken and the from argument.

This page contains the necessary tips for implementation.

Connection to Edurep

If the repository can offer the NL LOM data via OAI-PMH, it can be registered for testing with our servicedesk. We test the collection in our Staging environment and, if successful and to the customer's satisfaction, we link the collection to the Production environment.

  • Make sure there are no blocks for our harvester. Would you like to protect your OAI endpoint? We harvest from the IP range: 145.97.39.0/255 and our crawler uses user-agent "Meresco Harvester <version number>".
  • The progress and status of the import into Edurep can be seen per provider on the Harvester Status page. Read more.