Edurep:Leermateriaal Metadata Aanbieden: verschil tussen versies

Huidige versie van 25 okt 2023 om 21:58

Simpel gezegd wordt metadata over leermateriaal aan Edurep aangeboden via het OAI-PMH protocol en in het NL LOM formaat.

Er is een eenvoudige voorbeeld use case uitgewerkt die de stappen van deze handleiding volgt.

Inrichten systeem

Hoe moet een aanbieder zijn systeem voorbereiden om metadata door te kunnen sturen naar Edurep?

Metadata, dat wil zeggen beschrijvingen van leermaterialen, moeten het formaat hebben dat is gedefinieerd door de NL LOM-standaard.
Aanbieders van leermaterialen moeten een repository creëren waarin deze metadata worden opgeslagen.
Om de Edurep repository te synchroniseren met de repositories van leermateriaalaanbieders moet gebruik worden gemaakt van het OAI-PMH metadata uitwisselingsprotocol.

Belang van Identifiers

Het correct functioneren van de metadata in Edurep hangt af van identifiers. Elk leermiddel en elk metadatarecord moet in de repository van de aanbieder voorzien zijn van een unieke identifier. Het is aanbevolen om hiervoor zogenaamde UPI's (Unieke Persistente Identifiers) te gebruiken, .

Metadata record identifiers worden in Edurep gebruikt bij het synchroniseren van binnengehaalde metadatarecords. Lees meer.
Object identifiers worden in Edurep gebruikt om verschillende metadata records aan elkaar te koppelen (bijv. beoordelingen). Lees meer.

Exporteren Metadata

De metadata over de leermiddelen moet aangeleverd worden in NL LOM of Schema.org. De standaard definieert welke metadatavelden in gebruik zijn en welke verplicht zijn, welke aanbevolen zijn en welke optionele velden zijn. We raden aan om, indien mogelijk, alle aanbevolen velden door te geven, omdat dit de doorzoekbaarheid en toegankelijkheid van leermateriaal zal vergroten.

Het is aanbevolen om de tips per veld te lezen om te zien hoe elk veld ge-exporteerd zou moeten worden. Lees meer.
Er is specifieke informatie beschikbaar over het metadateren van vakgebieden, leerniveau's en doelen uit het OBK. Lees meer.
Bij het importeren voert Edurep een aantal automatische bewerkingen uit om de metadata te valideren en waar mogelijk de kwaliteit te verbeteren. Lees hier meer over de automatische bewerkingen die Edurep uitvoert.

Wij adviseren om de OAI endpoint implementatie te starten met een minimale set metadatavelden en in de eerste fase van het project te concentreren op het correct doorsturen van metadatarecords. Wanneer het OAI endpoint goed functioneert, kan de set metadatavelden worden uitgebreid.

Uitvoeren Metadata

Om de metadata van de repository te synchroniseren met Edurep, maken we gebruik van het OAI-PMH protocol. Om de synchronisatie goed te laten verlopen, is het noodzakelijk:

dat elk metadatarecord op unieke wijze wordt geïdentificeerd
het tijdstip waarop de wijziging in het metadatarecord plaatsvindt, moet worden vastgelegd. Wijzigingen die vastgelegd moeten worden zijn niet alleen het toevoegen van een nieuw metadatarecord bij het publiceren naar Edurep, maar ook het aanpassen van bestaande metadatarecords en het ongedaan maken van de publicatie ervan.
Verder doen we een test op de "flow control", het correct gebruik van het resumptionToken en het from argument.

Op deze pagina staan de nodige tips voor de implementatie.

Aansluiting op Edurep

Wanneer de repository in staat is om via OAI-PMH de NL LOM data aan te leveren, kan deze worden bij onze servicedesk aangemeld om te testen. Wij gaan de collectie testen op onze Staging omgeving en indien succesvol en naar tevredenheid van de klant, de collectie aansluiten op de Productie omgeving.

Zorg dat er geen blokkades zijn voor onze harvester. Wil je toch de OAI-provider beschermen? Wij harvesten vanuit de IP-reeks: 145.97.39.0/255 en onze crawler gebruikt user-agent "Meresco Harvester <versienummer>".
De voortgang en status van de import in Edurep is per aanbieder zichtbaar op de Harvester Status pagina. Lees meer.

@@ Regel 1: / Regel 1: @@
+{{Talen}}
 Simpel gezegd wordt metadata over leermateriaal aan Edurep aangeboden via het {{Standaard|OAI-PMH}} protocol en in het {{Standaard|NL LOM}} formaat.
+Er is een eenvoudige [[Edurep:Voorbeeld Implementatie Aanbieder|voorbeeld use case]] uitgewerkt die de stappen van deze handleiding volgt.
-== Koppelen Identifier ==
-Het correct functioneren van de metadata in Edurep hangt af van identifiers. Elk leermiddel en elk metadatarecord moet in de repository van de eigenaar voorzien zijn van een unieke identifier. Het is aanbevolen om hiervoor zogenaamde {{Standaard|UPI}}'s te gebruiken, Unieke Persistente Identifiers.
+== Inrichten systeem ==
-* Metadata identifiers worden in Edurep gebruikt bij het synchroniseren van binnengehaalde metadatarecords. [[Standaarden:OAI-PMH#Identifiers|Lees meer]].
+Hoe moet een aanbieder zijn systeem voorbereiden om metadata door te kunnen sturen naar Edurep?
+* Metadata, dat wil zeggen beschrijvingen van leermaterialen, moeten het formaat hebben dat is gedefinieerd door de NL LOM-standaard.
+* Aanbieders van leermaterialen moeten een repository creëren waarin deze metadata worden opgeslagen.
+* Om de Edurep repository te synchroniseren met de repositories van leermateriaalaanbieders moet gebruik worden gemaakt van het OAI-PMH metadata uitwisselingsprotocol.
+=== Belang van Identifiers ===
+Het correct functioneren van de metadata in Edurep hangt af van identifiers. Elk leermiddel en elk metadatarecord moet in de repository van de aanbieder voorzien zijn van een unieke identifier. Het is aanbevolen om hiervoor zogenaamde {{Standaard|UPI}}'s (Unieke Persistente Identifiers) te gebruiken, .
+* Metadata record identifiers worden in Edurep gebruikt bij het synchroniseren van binnengehaalde metadatarecords. [[Standaarden:OAI-PMH#Identifiers|Lees meer]].
 * Object identifiers worden in Edurep gebruikt om verschillende metadata records aan elkaar te koppelen (bijv. beoordelingen). [[Edurep:Identifiers|Lees meer]].
-== Exporteren Metadata ==
+=== Exporteren Metadata ===
-De metadata over de leermiddelen moet aangeleverd worden in het {{Standaard|NL LOM}} formaat. Deze standaard kent verplichte en aanbevolen velden. De aanbevolen velden zijn aanbevolen omdat ze de vindbaarheid en zichtbaarheid in zoekportals verbeteren.
+De metadata over de leermiddelen moet aangeleverd worden in {{Standaard|NL LOM}} of {{Standaard|Schema.org}}. De standaard definieert welke metadatavelden in gebruik zijn en welke verplicht zijn, welke aanbevolen zijn en welke optionele velden zijn. We raden aan om, indien mogelijk, alle aanbevolen velden door te geven, omdat dit de doorzoekbaarheid en toegankelijkheid van leermateriaal zal vergroten.
-* Het is aanbevolen om de tips per veld te lezen om te zien hoe elk veld ge-exporteerd zou moeten worden. [[Standaarden:NL_LOM#Tips|Lees meer]].
+* Het is aanbevolen om de tips per veld te lezen om te zien hoe elk veld ge-exporteerd zou moeten worden. [[Edurep:Metadata|Lees meer]].
-* Er is specifieke informatie beschikbaar over het metadateren van vakgebieden, leerniveau's en doelen uit het OBK. [[OBK:Metadatering Leermateriaa|Lees meer]].
+* Er is specifieke informatie beschikbaar over het metadateren van vakgebieden, leerniveau's en doelen uit het OBK. [[OBK:Metadatering Leermateriaal|Lees meer]].
-* Bij het importeren voert Edurep een aantal automatische bewerkingen uit om de kwaliteit te verbeteren. [[Edurep:Metadata verwerking|Lees meer]].
+* Bij het importeren voert Edurep een aantal automatische bewerkingen uit om de metadata te valideren en waar mogelijk de kwaliteit te verbeteren. [[Edurep:Metadata verwerking|Lees hier meer]] over de automatische bewerkingen die Edurep uitvoert.
+Wij adviseren om de OAI endpoint implementatie te starten met een minimale set metadatavelden en in de eerste fase van het project te concentreren op het correct doorsturen van metadatarecords. Wanneer het OAI endpoint goed functioneert, kan de set metadatavelden worden uitgebreid.
-== Uitvoeren Metadata ==
+=== Uitvoeren Metadata ===
-Om de metadata van de repository te synchroniseren met Edurep, maken we gebruik van het {{Standaard|OAI-PMH}} protocol.
+Om de metadata van de repository te synchroniseren met Edurep, maken we gebruik van het {{Standaard|OAI-PMH}} protocol. Om de synchronisatie goed te laten verlopen, is het noodzakelijk:
+* dat elk metadatarecord op unieke wijze wordt geïdentificeerd
-* In eerste instantie gebruiken we de online [http://ariadne.cs.kuleuven.be/validationService/validateOaiTarget.jsp Ariadne OAI-PMH Validatie] om te controleren of de OAI provider voldoet.
+* het tijdstip waarop de wijziging in het metadatarecord plaatsvindt, moet worden vastgelegd. Wijzigingen die vastgelegd moeten worden zijn niet alleen het toevoegen van een nieuw metadatarecord bij het publiceren naar Edurep, maar ook het aanpassen van bestaande metadatarecords en het ongedaan maken van de publicatie ervan.
 * Verder doen we een test op de "flow control", het correct gebruik van het ''resumptionToken'' en het ''from'' argument.
+Op [[Standaarden: OAI-PMH|deze pagina]] staan de nodige tips voor de implementatie.
-== Aanbieden aan Edurep ==
+== Aansluiting op Edurep ==
-Wanneer de repository in staat is om via OAI-PMH de NL LOM data aan te leveren, kan deze worden [https://support.kennisnet.org/index.php?/Tickets/Submit aangemeld] om te testen. Wij gaan de collectie testen op onze staging omgeving en indien succesvol en naar tevredenheid van de klant, de collectie aansluiten op de productieomgeving.
+Wanneer de repository in staat is om via OAI-PMH de NL LOM data aan te leveren, kan deze worden bij onze {{Servicedesk}} aangemeld om te testen. Wij gaan de collectie testen op onze Staging omgeving en indien succesvol en naar tevredenheid van de klant, de collectie aansluiten op de Productie omgeving.
+* Zorg dat er geen blokkades zijn voor onze harvester. Wil je toch de OAI-provider beschermen? Wij harvesten vanuit de IP-reeks: 145.97.39.0/255 en onze crawler gebruikt user-agent "Meresco Harvester <versienummer>".
-* De voortgang en status van de import bij ons kan worden bekeken op de harvester status pagina. [[Edurep:Harvester Status|Lees meer]].
+* De voortgang en status van de import in Edurep is per aanbieder zichtbaar op de Harvester Status pagina. [[Edurep:Metadata_verwerking#OAI-PMH_Harvester|Lees meer]].
 [[Category:Edurep]]