KVS:DossierValidatie: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
k
 
(34 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
−
[[Categorie:Kennisnet Validatie Service]]
  
−  
−
= User Story =
  
 
Ik ben Deelnemer en wil een Dossier valideren om de correctheid vast te stellen (voorafgaand aan verzending of verwerking)
  
Ik ben Deelnemer en wil een Dossier valideren om de correctheid vast te stellen (voorafgaand aan verzending of verwerking)
   
−
= Beschrijving =
 +
== Beschrijving ==
−
De Kennisnet Validatie Service biedt de service om een document te valideren tegen de betreffende specificatie. Zo kan een documentbron controleren of een gegenereerd document valide is alvorens het over te dragen en kan een documentdoel controleren of een overgedragen document valide is.
 +
De Kennisnet Validatie Service biedt de service om een document te valideren tegen de gespecificeerde specificatie. Zo kan een documentbron controleren of een gegenereerd document valide is alvorens het over te dragen en kan een documentdoel controleren of een overgedragen document valide is.
  +
  +
{{Info|(Delen van) dossiers worden NIET langer bewaard dan strikt noodzakelijk voor validatie.}}
   
 
== Scenario ==
  
== Scenario ==
   
 
{| class="wikitable"
  
{| class="wikitable"
−
|1
 +
|Stap 1
−
|Documentbron stuurt een document naar het KVS via de interactie validerenDocument.
 +
|Documentbron stuurt een document naar het KVS via de aliderenDocument aanroep. In de aanroep specificeert de Documentbron tegen welk schema(versie) het KVS het document moet valideren.
  +
|
 
|-
  
|-
−
|2
 +
|Stap 2
  +
|Het KVS controleer of gespecificeerde schemaversie bekend (beschikbaar als testset binnen KVS) is. Indien dit niet het geval is, voert het KVS geen validatie uit.
−
|Het KVS antwoordt dat het document valide is.
  
  +
|
  +
|-
  +
|Stap 3
  +
|<s>Het KVS controleert of de grootte van het dossier binnen de marges van de specificatie valt.Indien dit niet het geval is, voert het KVS geen verdere validatie uit.</s>
  +
| Deze stap is nog niet geïmplementeerd in het KVS.
  +
|-
  +
|Stap 4
  +
|Het KVS voert validatie uit.
  +
|
  +
|-
  +
|Stap 5
  +
|Het KVS retourneert de uitkomst van de validatie.
  +
|
 
|}
  
|}
   
 
=== Preconditie ===
  
=== Preconditie ===
 
* De betrokken leverancier van Documentbron heeft een bewerkingsovereenkomst afgesloten met Kennisnet.
 
* De betrokken leverancier van Documentbron heeft een bewerkingsovereenkomst afgesloten met Kennisnet.
−
* Documentbron heeft toegang tot KVS
 +
* Documentbron heeft toegang tot KVS (Zie ook de [[KVS:Technische_Documentatie/Omgevingen|KVS omgevingen]] pagina).
   
  +
===validatieVersiesRequest: Aanroep en antwoord===
−
=== Controles en foutwaarden ===
  
  +
  +
*Request
  +
  +
<syntaxhighlight lang="xml">
  +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Validatieservice/20140519">
  +
<soapenv:Header/>
  +
<soapenv:Body>
  +
<ns:validatieVersiesRequest/>
  +
</soapenv:Body>
  +
</soapenv:Envelope>
  +
</syntaxhighlight>
  +
  +
  +
*Response
  +
  +
<syntaxhighlight lang="xml">
  +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  +
<SOAP-ENV:Header/>
  +
<SOAP-ENV:Body>
  +
<over:validatieVersiesResponse xmlns:over="http://xml.eld.nl/schemas/Validatieservice/20140519">
  +
<over:versie>overstapdossier_2016.1_20160226</over:versie>
  +
<over:versie>overstapdossier_1.1_20140221</over:versie>
  +
<over:versie>overstapdossier_2016.1.2.20160429</over:versie>
  +
<over:versie>overstapdossier_1.2.2_20151119</over:versie>
  +
<over:versie>overstapdossier_1.0_20140331</over:versie>
  +
<over:versie>overstapdossier_1.2_20150302</over:versie>
  +
<over:versie>overstapdossier_1.2.2_20150716</over:versie>
  +
<over:versie>overstapdossier_1.1.1_20140530</over:versie>
  +
<over:versie>overstapdossier_1.1.1_20140919</over:versie>
  +
<over:versie>overstapdossier_1.2.2_20150529</over:versie>
  +
</over:validatieVersiesResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
</syntaxhighlight>
  +
  +
  +
===documentvalidatieRequest: Aanroep en antwoord===
  +
  +
  +
  +
*Request
  +
  +
<syntaxhighlight lang="xml">
  +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Validatieservice/20140519">
  +
<soapenv:Header/>
  +
<soapenv:Body>
  +
<ns:documentvalidatieRequest>
  +
<ns:dossier>
  +
<dossier xmlns="http://www.edustandaard.nl/oso_gegevensset/2016/dossier">
  +
...
  +
</dossier>
  +
</ns:dossier>
  +
<ns:versie>overstapdossier_2016.1.2.20160429</ns:versie>
  +
</ns:documentvalidatieRequest>
  +
</soapenv:Body>
  +
</soapenv:Envelope>
  +
</syntaxhighlight>
  +
  +
==== Aanroep parameters ====
  +
{|class="wikitable"
  +
! style="text-align:left;"| I/O
  +
! style="text-align:left;"| Parameter
  +
! style="text-align:left;"| Opmerkingen
  +
|-
  +
|input
  +
|dossier
  +
|dossier (in xml formaat) inclusief attachments
  +
|-
  +
|input
  +
|standaardversie
  +
|versie waartegen dossier gevalideerd wordt
  +
|-
  +
|output
  +
|uitkomst validatie
  +
|valide/niet valide
  +
|-
  +
|output
  +
|foutmeldingen (optioneel)
  +
|zie [[KVS:DossierValidatie#Controles en foutwaarden|foutwaarden]]
  +
|-
  +
|<strike>output</strike>
  +
|<strike>controle waarde (optioneel)</strike>
  +
|<strike>hashwaarde (md5) van gevalideerd dossier</strike>
  +
|-
  +
|output
  +
|standaardversie
  +
|versie waartegen dossier gevalideerd is
  +
|}
  +
  +
*Response
  +
  +
  +
<syntaxhighlight lang="xml">
  +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  +
<SOAP-ENV:Header/>
  +
<SOAP-ENV:Body><over:documentvalidatieResponse xmlns:over="http://xml.eld.nl/schemas/Validatieservice/20140519">
  +
<over:isValide>true</over:isValide>
  +
<over:versie>overstapdossier_2016.1.2.20160429</over:versie>
  +
<over:systemTime>2016-06-14T09:32:38</over:systemTime>
  +
<over:resultaat>DocumentValide</over:resultaat>
  +
</over:documentvalidatieResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
</syntaxhighlight>
  +
  +
==== Responsewaarden ====
  +
{|class="wikitable"
  +
! style="text-align:left;"|
  +
! style="text-align:left;"| Controle
  +
! style="text-align:left;"| Uitkomst
  +
! style="text-align:left;"| Response
  +
! style="text-align:left;"| Registratie in log
  +
|-
  +
|1
  +
|validatie van het document op structuur(xsd) en inhoudelijk (xslt)
  +
|document blijkt valide
  +
|bevestiging geslaagde validatie
  +
|"Dossier is valid"
  +
|-
  +
|2
  +
|validatie van het document tegen overstapdossier.xsd en valideerOverstapdossier.xsl
  +
|document blijkt niet valide
  +
|melding(en) zoals gegenereerd tijdens validatie
  +
|"Document is niet valide volgens standaard <StandaardVersie> - <melding(en) zoals gegenereerd tijdens validatie>"
  +
|}
  +
  +
==== Alternatieve flows ====
  +
  +
{| class="wikitable"
  +
|-
  +
|Stap 3b
  +
| Het KVS constateert dat de opgegeven testversie niet correct is. Het KVS retourneert dit zoals gespecificeerd.
  +
| Het scenario eindigt.
  +
|-
  +
|Stap 4b
  +
| Het KVS constateert dat de grootte van het dossier het maximum overschreidt. Het KVS retourneert dit zoals gespecificeerd.
  +
| Het scenario eindigt.
  +
|-
  +
|Stap 5b
  +
| Het KVS constateert dat het document niet valide is. Het KVS retourneert dit zoals gespecificeerd. Het antwoord bevat ook een lijst met bij de validatie in het dossier geconstateerde fouten.
  +
| Het scenario eindigt.
  +
|}
  +
  +
==== Controles en foutwaarden ====
 
{|class="wikitable"
  
{|class="wikitable"
 
! style="text-align:left;"|
  
! style="text-align:left;"|
Regel 29: Regel 186:
 
|-
  
|-
 
| 1
  
| 1
−
| versienummer schema wordt ondersteund
+
| versienummer schema
 
| validatie wordt niet uitgevoerd
  
| validatie wordt niet uitgevoerd
 
| “Versie standaard uit aanroep wordt niet ondersteund”
  
| “Versie standaard uit aanroep wordt niet ondersteund”
−
|}
  
−  
−
== Alternatieve flows ==
  
−
* Het KVS constateert dat het document niet valide is. Het KVS retourneert een foutcode zoals gespecificeerd in paragraaf “responsewaarden” van validerenDocument. Het antwoord bevat ook een lijst met geconstateerde fouten.
  
−
* Het scenario eindigt.
  
−  
−
=== Responsewaarden ===
  
−
{|class="wikitable"
  
−
! style="text-align:left;"|
  
−
! style="text-align:left;"| Resultaat
  
−
! style="text-align:left;"| Omschrijving
  
−
|-
  
 
|-
  
|-
 
| 2
  
| 2
  +
| grootte dossier
−
|validatie van het document tegen ELDDocument.xsd en ValiderenDocument.xsl
  
  +
| validatie wordt niet uitgevoerd
−
|isValide = false meldingen zoals gegenereerd door ValiderenDocument.xsl
  
  +
| “Soap message too big: "<size in bytes>”
−
|"Document is niet valide - <melding zoals gegenereerd door ValiderenDocument.xsl"
  
 
|}
  
|}
  +
  +
== Logging ==
  +
{{:KVS:Logging}}
  +
  +
[[Categorie:Kennisnet Validatie Service]]
  +
[[Categorie:Handleiding]]

Huidige versie van 3 mei 2017 om 12:10

Ik ben Deelnemer en wil een Dossier valideren om de correctheid vast te stellen (voorafgaand aan verzending of verwerking)

Beschrijving

De Kennisnet Validatie Service biedt de service om een document te valideren tegen de gespecificeerde specificatie. Zo kan een documentbron controleren of een gegenereerd document valide is alvorens het over te dragen en kan een documentdoel controleren of een overgedragen document valide is.

Info.gif (Delen van) dossiers worden NIET langer bewaard dan strikt noodzakelijk voor validatie.

Scenario

Stap 1 Documentbron stuurt een document naar het KVS via de aliderenDocument aanroep. In de aanroep specificeert de Documentbron tegen welk schema(versie) het KVS het document moet valideren.
Stap 2 Het KVS controleer of gespecificeerde schemaversie bekend (beschikbaar als testset binnen KVS) is. Indien dit niet het geval is, voert het KVS geen validatie uit.
Stap 3 Het KVS controleert of de grootte van het dossier binnen de marges van de specificatie valt.Indien dit niet het geval is, voert het KVS geen verdere validatie uit. Deze stap is nog niet geïmplementeerd in het KVS.
Stap 4 Het KVS voert validatie uit.
Stap 5 Het KVS retourneert de uitkomst van de validatie.

Preconditie

  • De betrokken leverancier van Documentbron heeft een bewerkingsovereenkomst afgesloten met Kennisnet.
  • Documentbron heeft toegang tot KVS (Zie ook de KVS omgevingen pagina).

validatieVersiesRequest: Aanroep en antwoord

  • Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Validatieservice/20140519">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:validatieVersiesRequest/>
   </soapenv:Body>
</soapenv:Envelope>


  • Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<over:validatieVersiesResponse xmlns:over="http://xml.eld.nl/schemas/Validatieservice/20140519">
  <over:versie>overstapdossier_2016.1_20160226</over:versie>
  <over:versie>overstapdossier_1.1_20140221</over:versie>
  <over:versie>overstapdossier_2016.1.2.20160429</over:versie>
  <over:versie>overstapdossier_1.2.2_20151119</over:versie>
  <over:versie>overstapdossier_1.0_20140331</over:versie>
  <over:versie>overstapdossier_1.2_20150302</over:versie>
  <over:versie>overstapdossier_1.2.2_20150716</over:versie>
  <over:versie>overstapdossier_1.1.1_20140530</over:versie>
  <over:versie>overstapdossier_1.1.1_20140919</over:versie>
  <over:versie>overstapdossier_1.2.2_20150529</over:versie>
</over:validatieVersiesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


documentvalidatieRequest: Aanroep en antwoord

  • Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Validatieservice/20140519">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:documentvalidatieRequest>
         <ns:dossier>
             <dossier xmlns="http://www.edustandaard.nl/oso_gegevensset/2016/dossier">
             ...
             </dossier>
         </ns:dossier>
         <ns:versie>overstapdossier_2016.1.2.20160429</ns:versie>
      </ns:documentvalidatieRequest>
   </soapenv:Body>
</soapenv:Envelope>

Aanroep parameters

I/O Parameter Opmerkingen
input dossier dossier (in xml formaat) inclusief attachments
input standaardversie versie waartegen dossier gevalideerd wordt
output uitkomst validatie valide/niet valide
output foutmeldingen (optioneel) zie foutwaarden
output controle waarde (optioneel) hashwaarde (md5) van gevalideerd dossier
output standaardversie versie waartegen dossier gevalideerd is
  • Response


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body><over:documentvalidatieResponse xmlns:over="http://xml.eld.nl/schemas/Validatieservice/20140519">
  <over:isValide>true</over:isValide>
  <over:versie>overstapdossier_2016.1.2.20160429</over:versie>
  <over:systemTime>2016-06-14T09:32:38</over:systemTime>
  <over:resultaat>DocumentValide</over:resultaat>
</over:documentvalidatieResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Responsewaarden

Controle Uitkomst Response Registratie in log
1 validatie van het document op structuur(xsd) en inhoudelijk (xslt) document blijkt valide bevestiging geslaagde validatie "Dossier is valid"
2 validatie van het document tegen overstapdossier.xsd en valideerOverstapdossier.xsl document blijkt niet valide melding(en) zoals gegenereerd tijdens validatie "Document is niet valide volgens standaard <StandaardVersie> - <melding(en) zoals gegenereerd tijdens validatie>"

Alternatieve flows

Stap 3b Het KVS constateert dat de opgegeven testversie niet correct is. Het KVS retourneert dit zoals gespecificeerd. Het scenario eindigt.
Stap 4b Het KVS constateert dat de grootte van het dossier het maximum overschreidt. Het KVS retourneert dit zoals gespecificeerd. Het scenario eindigt.
Stap 5b Het KVS constateert dat het document niet valide is. Het KVS retourneert dit zoals gespecificeerd. Het antwoord bevat ook een lijst met bij de validatie in het dossier geconstateerde fouten. Het scenario eindigt.

Controles en foutwaarden

controle resultaat bij fout log entry
1 versienummer schema validatie wordt niet uitgevoerd “Versie standaard uit aanroep wordt niet ondersteund”
2 grootte dossier validatie wordt niet uitgevoerd “Soap message too big: "<size in bytes>”

Logging

Het KVS registreert gebeurtenissen met betrekking tot het valideren van overstapdossiers. Deze registratie is aanvullend op de 'normale' logging van de systemen waarop het KVS is gehost. Het KVS registreert de volgende acties:

Deze registraties wordt gebruikt om een rapportage voorziening binnen Kennisnet te voorzien van gegevens om de dienst KVS de kunnen besturen en verbeteren. In deze rapportages en in de registraties worden GEEN persoonsgegevens of delen van overstapdossiers overgenomen. Alleen metagegevens over de controle (uitkomst, aanbiedend systeem, controleschema, etc.) worden gebruikt.

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=KVS:DossierValidatie&oldid=7247"