CS:Metadata Aanbieden: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
 
(17 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 1: Regel 1:
−
Een partij kan standaard '''metadata aanbieden''' volgens de {{Standaard|ECK-DT}} standaard. In bepaalde gevallen kan hierop een uitzondering worden gemaakt.
 +
Een partij kan standaard '''metadata aanbieden''' volgens de {{Standaard|ECK-DT}} standaard.
   
 
== Aanleveren catalogusinformatie op basis van de ECK DT standaard ==
  
== Aanleveren catalogusinformatie op basis van de ECK DT standaard ==
  +
In dit aansluittype sluiten ons Koppelpunt aan op de ECK DT CatalogService webservice '''van de aanbieder''', en harvesten wij de aangeboden records.
  +
* Wij ondersteunen 2 versies van de standaard, [[CS:Versies|Lees meer]].
  ⚫
* Onze harvester kan alleen maar data harvesten die valide is conform de geleverde XSD's; [[Standaarden:ECK-DT#Documentatie|Lees meer]].
   
−
=== Aansluitingsproces ===
 +
=== SOAP endpoint ===
  ⚫
Via een SOAP endpoint worden alle catalogusinformatie aangeboden volgens de specificaties van de ECK DT standaard; [[Standaarden:ECK-DT#SOAP|Lees meer]].
−
=== Ondersteunde versies van de standaard ===
  
−
[[CS:Versies|Lees meer]] over welke ECK-DC standaardversie we ondersteunen. <br/>
  
−
Momenteel kunnen wij ECK-DT CatalogService versies 2.1.1 en 2.2 harvesten. We gaan binnenkort ondersteuning bieden voor versies 2.2 en 2.3.
 
   
  ⚫
Wij harvesten door middel van een publieke WSDL definitie. Er hoeft slechts één WSDL te worden gemaakt voor alle records.
−
=== Harvester ===
  
−
Wij harvesten door middel van een WSDL definitie. <br/>
  
⚫
Er hoeft slechts één WSDL te worden gemaakt voor alle records.
 
   
−
We hebben een template, waarbij alleen de <nowiki>{{SERVICE_ENDPOINT_URI}}</nowiki> vervangen moet worden met de eigen SOAP endpoint locatie:
 +
We hebben een template voor de WSDL, waarbij alleen de <nowiki>{{SERVICE_ENDPOINT_URI}}</nowiki> vervangen moet worden met de eigen SOAP endpoint locatie:
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
 
<soap:address location="{{SERVICE_ENDPOINT_URI}}"/>
  
<soap:address location="{{SERVICE_ENDPOINT_URI}}"/>
 
</syntaxhighlight>
  
</syntaxhighlight>
−
Voor elke versie van de standaard moet een afzonderlijk eindpunt worden gemaakt.
 +
Voor elke versie van de standaard moet een afzonderlijk WSDL en webservice endpoint worden gemaakt.
 
{| class="wikitable"
  
{| class="wikitable"
 
|-
  
|-
Regel 22: Regel 21:
 
!template
  
!template
 
|-
  
|-
−
|Versie 2.2
 +
|Versie 2.5.2 recommends
−
|[https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.2.wsdl https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.2.wsdl]
 +
|[https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.2.wsdl https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.2.wsdl]
 
|-
  
|-
−
|Versie 2.3
 +
|Versie 2.5.1 allows
−
|[https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.3.wsdl https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.3.wsdl]
 +
|[https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.1.wsdl https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.1.wsdl]
−  
 
|}
  
|}
   
−
=== SOAP endpoint ===
 +
=== Harvesting ===
  ⚫
De ECK-DT standaard en Catalogus Service Harvester ondersteunen '''incrementele harvesting''' via het ReadCatalog ''Since'' argument. De implementatie hiervan door de server is niet verplicht maar vanuit ons als harvestende partij wel aanbevolen.
⚫
Via een SOAP endpoint worden alle records aangeboden volgens de specificaties van de standaard.
 
−
Lees meer [[Standaarden:ECK-DT#SOAP]]
  
−
=== Metadata ===
  
−
In versie 2.3 van de ECK-DT standaard zijn de velden ''PriceVATHigh'' en ''PriceVATLow'' vervangen door de container '''''Prices''''' waarin meerdere bedragen opgenomen kunnen worden. <br/>
  
−
Elke ''Prices'' container moet één ''Currency'' element en ten minste één ''Price'' container bevatten indien ''IsCatalogItem'' veld de waarde “TRUE” heeft. <br/>
  
−
Het kan optioneel een ''Consumerprice'' element bevatten.<br/>
  
   
  ⚫
Via incrementele harvesting kunnen '''nieuwe records''' worden aangeboden maar ook '''updates''' op reeds gestuurde records. Onze harvester zal deze dan '''periodiek''' bij de bron endpoint ophalen. In geval van een update dient de '''volledige''' laatste versie een record entry te worden aangeboden.
−
Elke '''''Price''''' container moet de volgende elementen bevatten:
 
−
*''Amount'': De prijs in centen ( excl. BTW) en
  
−
*''VAT'': Het BTW percentage . <br/>
  
−
Op deze manier kunnen ook belastingvrije producten worden toegevoegd. <br/>
  
−
Lees meer [[Standaarden:ECK-DT/CatalogService#Entry]]
  
   
  ⚫
Wij zullen, met behulp van de ''firstEntry'' en ''Amount'' velden, entries gepagineerd bij de bron endpoint opvragen; [[Standaarden:ECK-DT/CatalogService#Transport|Lees meer]].
−
=== Transport ===
  
−
 
⚫
De ECK-DT standaard en Catalogus Service Harvester ondersteunen '''incrementele harvesting''' via het ReadCatalog ''Since'' '''Vetgedrukte tekst'''argument.<br/>
 
−
De implementatie hiervan door de server is niet verplicht maar vanuit ons als harvestende partij wel aanbevolen. <br/>
  
⚫
Via incrementele harvesting kunnen '''nieuwe records''' worden aangeboden maar ook '''updates''' op reeds gestuurde records. Alle nieuwe records of wijzigingen worden doorgevoerd omdat Catalogus Service Harvester zal ze '''periodiek''' bij de bron endpoint ophalen.
  
−
In geval van een update dient de '''volledige''' laatste versie een record te worden gestuurd. <br/>
  
⚫
Wij zullen, met behulp van de ''firstEntry'' en ''Amount'' velden, entries gepagineerd bij de bron endpoint opvragen.
 
−
[[Standaarden:ECK-DT/CatalogService#Transport]]
  
−
=== Validatie ===
  
⚫
Catalogus Service Harvester kunt alleen maar data harvesten die valide is conform de geleverde XSD's. [[Standaarden:ECK-DT#Documentatie]]<br/>
  
−
Een gratis software https://www.soapui.org/ kan worden gebruikt om het WSDL / SOAP-eindpunt te valideren. [[Standaarden:SOAP]]<br/>
  
−
Valideer de uitvoer voordat het harvestverzoek ingediend wordt.
  
   
−
=== Harvestverzoek ===
 +
=== Proces ===
  +
Een nieuw of versievervangend aansluitproces kan worden gestart via onze {{servicedesk}}. Let daarbij op de volgende punten.
−  
  ⚫
* Er moet een openbare WSDL-locatie worden meegedeeld.
−
Een harvestverzoek kan worden ingediend via onze {{servicedesk}}.<br/>
  
  ⚫
* Optioneel kunnen zowel een ''OrganisationId'' als een ''wachtwoord'' worden gegeven. [[Standaarden:ECK-DT#Request]]<br/>
⚫
Er moet een openbare WSDL-locatie worden meegedeeld.<br/>
  
  +
* Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
⚫
Optioneel kunnen zowel een ''OrganisationId'' als een ''wachtwoord'' worden gegeven. [[Standaarden:ECK-DT#Request]]<<br/>
  
−
We zullen alle records die we op die locatie harvesten via de WSDL valideren tegen het xsd-schema. <br/>
 +
* We zullen alle records die we op die locatie harvesten via de WSDL en valideren tegen het xsd-schema.
  +
** We raden aan dit harvest en validatieproces eerst zelf uit te voeren met bijv [https://www.soapui.org/ SoapUI].
−
Als alle gegevens correct zijn, regelen we de aansluiting met Catalogus Service Harvester.
  
  +
* Als de gegevens valide zijn, sluiten we collectie eerst aan op onze publiek [https://harvester-a.catalogusservice.edurep.nl/ Staging omgeving] en bevestigen we de correctheid van de aansluiting met de aanbieder voordat we overgaan op de [https://harvester.catalogusservice.edurep.nl/ Productiekoppeling].
   
 
== Aanleveren catalogusinformatie op basis van een CSV ==
  
== Aanleveren catalogusinformatie op basis van een CSV ==
Regel 71: Regel 50:
   
 
=== Conversie ===
  
=== Conversie ===
−
Een gespecialiseerde uitgever hoeft geen ECK-DT Catalogusservice webservice te bouwen, maar genereert een statische versie 2.2 XML uitvoer op basis van een CSV export van de catalogusinformatie.
 +
Een gespecialiseerde uitgever hoeft geen ECK-DT Catalogusservice webservice te bouwen, maar genereert een statische '''versie 2.5.2 XML''' uitvoer op basis van een CSV export van de catalogusinformatie.
−
Voor dit proces hebben we een conversie applicatie gebouwd waarmee aanbieders dit zelf kunnen doen.
 +
Voor dit proces hebben we een conversie applicatie gebouwd waarmee aanbieders dit zelf kunnen doen. Download het [https://developers.wiki.kennisnet.nl/images/2/28/Voorbeeld_Koppelpunt_CSV_Import.xlsx '''voorbeeld spreadsheet'''] voor een uitgebreide uitleg '''welke velden verplicht zijn''' en welke '''toegestane waarden''' kunnen worden gebruikt.
 
* [https://csv-converter.catalogusservice.edurep.nl conversie tool]
  
* [https://csv-converter.catalogusservice.edurep.nl conversie tool]
 
* [https://csv-converter.catalogusservice.edurep.nl/readme.php conversie tool uitleg]
  
* [https://csv-converter.catalogusservice.edurep.nl/readme.php conversie tool uitleg]
Regel 81: Regel 60:
 
* Een verzoek kan worden ingediend via onze {{servicedesk}}, waarbij het gemaakte XML bestand wordt toegevoegd.
  
* Een verzoek kan worden ingediend via onze {{servicedesk}}, waarbij het gemaakte XML bestand wordt toegevoegd.
 
* Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
  
* Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
−
* Als alle gegevens correct zijn, regelen we de aansluiting met het Koppelpunt via onze [https://harvester.catalogusservice.edurep.nl/ harvester].
 +
* Als alle gegevens correct zijn, regelen we de aansluiting met het Koppelpunt via onze [https://harvester.catalogusservice.edurep.nl/ Harvester].
  +
  +
[[Categorie:Catalogus Service]]

Huidige versie van 10 sep 2024 om 09:19

Een partij kan standaard metadata aanbieden volgens de ECK-DT standaard.

Aanleveren catalogusinformatie op basis van de ECK DT standaard

In dit aansluittype sluiten ons Koppelpunt aan op de ECK DT CatalogService webservice van de aanbieder, en harvesten wij de aangeboden records.

  • Wij ondersteunen 2 versies van de standaard, Lees meer.
  • Onze harvester kan alleen maar data harvesten die valide is conform de geleverde XSD's; Lees meer.

SOAP endpoint

Via een SOAP endpoint worden alle catalogusinformatie aangeboden volgens de specificaties van de ECK DT standaard; Lees meer.

Wij harvesten door middel van een publieke WSDL definitie. Er hoeft slechts één WSDL te worden gemaakt voor alle records.

We hebben een template voor de WSDL, waarbij alleen de {{SERVICE_ENDPOINT_URI}} vervangen moet worden met de eigen SOAP endpoint locatie: 

<soap:address location="{{SERVICE_ENDPOINT_URI}}"/>

Voor elke versie van de standaard moet een afzonderlijk WSDL en webservice endpoint worden gemaakt.

template
Versie 2.5.2 recommends https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.2.wsdl
Versie 2.5.1 allows https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.5.1.wsdl

Harvesting

De ECK-DT standaard en Catalogus Service Harvester ondersteunen incrementele harvesting via het ReadCatalog Since argument. De implementatie hiervan door de server is niet verplicht maar vanuit ons als harvestende partij wel aanbevolen.

Via incrementele harvesting kunnen nieuwe records worden aangeboden maar ook updates op reeds gestuurde records. Onze harvester zal deze dan periodiek bij de bron endpoint ophalen. In geval van een update dient de volledige laatste versie een record entry te worden aangeboden.

Wij zullen, met behulp van de firstEntry en Amount velden, entries gepagineerd bij de bron endpoint opvragen; Lees meer.

Proces

Een nieuw of versievervangend aansluitproces kan worden gestart via onze servicedesk. Let daarbij op de volgende punten.

  • Er moet een openbare WSDL-locatie worden meegedeeld.
  • Optioneel kunnen zowel een OrganisationId als een wachtwoord worden gegeven. Standaarden:ECK-DT#Request
  • Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
  • We zullen alle records die we op die locatie harvesten via de WSDL en valideren tegen het xsd-schema.
    • We raden aan dit harvest en validatieproces eerst zelf uit te voeren met bijv SoapUI.
  • Als de gegevens valide zijn, sluiten we collectie eerst aan op onze publiek Staging omgeving en bevestigen we de correctheid van de aansluiting met de aanbieder voordat we overgaan op de Productiekoppeling.

Aanleveren catalogusinformatie op basis van een CSV

We hebben het voor de gespecialiseerde uitgevers mogelijk gemaakt om op basis van CSV relatief eenvoudig catalogusinformatie in te dienen.

  • Het gaat in principe om een relatief klein aantal records die lange tijd ongewijzigd blijven.
  • Of een uitgever in aanmerking komt voor een dergelijke uitzondering, moet worden besproken met onze relatiemanagers.

Conversie

Een gespecialiseerde uitgever hoeft geen ECK-DT Catalogusservice webservice te bouwen, maar genereert een statische versie 2.5.2 XML uitvoer op basis van een CSV export van de catalogusinformatie. Voor dit proces hebben we een conversie applicatie gebouwd waarmee aanbieders dit zelf kunnen doen. Download het voorbeeld spreadsheet voor een uitgebreide uitleg welke velden verplicht zijn en welke toegestane waarden kunnen worden gebruikt.

Proces

Voordat het gegenereerde XML ECK-DT Catalogusservice bestand beschikbaar is in ons Koppelpunt, moet deze eerst door ons worden gekoppeld. Het proces hiervoor werkt als volgt:

  • Een verzoek kan worden ingediend via onze servicedesk, waarbij het gemaakte XML bestand wordt toegevoegd.
  • Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
  • Als alle gegevens correct zijn, regelen we de aansluiting met het Koppelpunt via onze Harvester.
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=CS:Metadata_Aanbieden&oldid=13010"