Procesbeschrijving:
e-Factureren
Niveau: 0.1 Versie 1.0
Pagina 1 van 46
Documentinformatie Versiehistorie Versie
Datum
Beschrijving
0.0
30-03-2010
Eerste opzet Logius.
0.8
28-06-2010
Eerste uitwerking e-Factureren na focusgroep kickoff
0.9
18-08-2010
Niveau -
1.0
20-08-2010
Definitieve versie met de volgende kanttekening van de opdrachtgever: Onze interpretatie van het document met betrekking tot de drie belangrijkste deelprocessen:
0.1 aanpassingen: E-mail (aflever) koppelvlak toegevoegd UBL (&HR-XML) validatie toegevoegd Gewijzigde AuSP functionaliteit
•
Aanleverproces (AuSP): De controle bij de aanleverservice zal geen AuSP controle bevatten.
•
Verwerkproces: De validatieservice controleert of het aangeleverde bericht voldoet aan de vereiste van de desbetreffende berichtstandaard op basis van de Nederlands invulling van deze standaard (Bijvoorbeeld SETU en UBL/NL). Het betreft dus een technische berichtvalidatie en geen inhoudelijke factuurvalidatie.
•
Afleverproces per Email: Digipoort kan de factuurberichten die zij ontvangen van de aanleverende partij als bijlage versturen aan een email adres van de ontvangende overheidsorganisatie. Het gaat hierbij om een normale emailbox die de eigen systeembeheerder kan worden ingericht. Verder aangescherpt met een schatting van volumes en verwerkingstijden in paragraaf 2.5. Teksten verduidelijkt op basis van opmerkingen van de opdrachtgever.
Pagina 2 van 46
Inhoud 1
2
3
4
5
6
7
8
Inleiding....................................................................................................................... 7 1.1
Aanleiding ............................................................................................................ 7
1.2
Doel van het document .......................................................................................... 7
1.3
Scope en reikwijdte ............................................................................................... 7
1.4
Leeswijzer ............................................................................................................ 7
Proceskarakteristieken ................................................................................................... 8 2.1
Context ................................................................................................................ 8
2.2
Volwassenheidsniveau............................................................................................ 8
2.3
BPMN................................................................................................................... 9
2.4
Audittrail .............................................................................................................. 9
2.5
Technische Karakteristieken en berichtkarakteristieken .............................................. 9
2.6
Deelprocessen .................................................................................................... 12
2.7
Monitoring .......................................................................................................... 13
Aanleverproces E-factuur ............................................................................................. 14 3.1
Kenmerken van het deelproces ............................................................................. 14
3.2
Audittrail ............................................................................................................ 14
3.3
Configuraties ...................................................................................................... 14
Verwerkproces E-factuur .............................................................................................. 16 4.1
Kenmerken van het deelproces ............................................................................. 16
4.2
Audittrail ............................................................................................................ 16
4.3
Configuraties ...................................................................................................... 16
Statusinformatieproces ................................................................................................ 18 5.1
Kenmerken van het deelproces ............................................................................. 18
5.2
Audittrail ............................................................................................................ 18
5.3
Configuraties ...................................................................................................... 19
Mededelingenproces .................................................................................................... 21 6.1
Kenmerken van het deelproces ............................................................................. 21
6.2
Audittrail ............................................................................................................ 21
6.3
Configuraties ...................................................................................................... 22
Bezorgproces .............................................................................................................. 24 7.1
Kenmerken van het deelproces ............................................................................. 24
7.2
Audittrail ............................................................................................................ 24
7.3
Configuraties ...................................................................................................... 24
Afleverproces.............................................................................................................. 26
Pagina 3 van 46
9
8.1
Kenmerken van het deelproces ............................................................................. 26
8.2
Audittrail ............................................................................................................ 26
8.3
Configuraties ...................................................................................................... 26
Servicecatalogus ......................................................................................................... 28 9.1
Aanleverservice................................................................................................... 28
9.1.1
Functionaliteit en werking ................................................................................. 28
9.1.2
Weergave en beschrijving ................................................................................. 28
Activiteit 1: Controle geldigheid certificaat en integriteit ................................................... 29 Activiteit 2: Controleren elementen................................................................................ 29 Activiteit 3: Base64 decoderen ...................................................................................... 29 Activiteit 4: Controle berichtgrootte ............................................................................... 29 Activiteit 5: Controle aanwezigheid kenmerk................................................................... 30 Activiteit 6: Controle aanwezigheid bedrijfsnummer......................................................... 30 Activiteit 7: Validiteitscontrole berichtsoort ..................................................................... 30 Activiteit 8: Aanmaken kenmerk.................................................................................... 31 Activiteit 9: Aanmaken audittrail ................................................................................... 31 Activiteit 10: Registreren resultaat in audittrail ............................................................... 31 9.2
Afleverservice ..................................................................................................... 32
9.2.1
Functionaliteit en werking ................................................................................. 32
9.2.2
Weergave en beschrijving ................................................................................. 32
Activiteit 1: Opzetten SSL-verbinding............................................................................. 32 Activiteit 2: Afleveren bericht........................................................................................ 32 Activiteit 3: Registreren resultaat in audittrail ................................................................. 33 9.3
Verwerken procesresultaat ................................................................................... 34
9.3.1
Functionaliteit en werking ................................................................................. 34
9.3.2
Weergave en beschrijving ................................................................................. 34
Activiteit 1: Opslaan statusinformatie............................................................................. 34 Activiteit 2: Registreren resultaat in audittrail ................................................................. 34 9.4
Mededelingenservice............................................................................................ 35
9.4.1
Functionaliteit en werking ................................................................................. 35
9.4.2
Weergave en beschrijving ................................................................................. 35
Activiteit 1: Controle geldigheid certificaat en integriteit ................................................... 36 Activiteit 2: Controleren elementen................................................................................ 36 Activiteit 3: Vergelijking Kvk nr. .................................................................................... 36 Default flow ................................................................................................................ 36 Activiteit 4: Controleren mededelingverzoek ................................................................... 36 Activiteit 5: Controleren aanwezigheid kenmerk .............................................................. 37 Activiteit 6: Controleren validiteit berichtsoort en bedrijfsnummer ..................................... 37
Pagina 4 van 46
Activiteit 7: Registreren resultaat in audittrail ................................................................. 37 9.5
Statusservice ...................................................................................................... 37
9.5.1
Functionaliteit en werking ................................................................................. 37
9.5.2
Weergave en beschrijving ................................................................................. 38
Activiteit 1: Controle geldigheid certificaat en integriteit ................................................... 39 Activiteit 2: Controleren elementen................................................................................ 39 Activiteit 3: Vergelijking Kvk nr. .................................................................................... 39 Default flow ................................................................................................................ 39 Activiteit 4: Controleren statusinformatieverzoek............................................................. 39 Activiteit 5: Controleren aanwezigheid kenmerk .............................................................. 40 Activiteit 6: Controleren validiteit bedrijfsnummer ........................................................... 40 Activiteit 7: Controleren validiteit berichtsoort................................................................. 40 Activiteit 8: Registreren resultaat in audittrail ................................................................. 40 9.6
Ophalen statusinformatie/mededeling informatie..................................................... 41
9.6.1
Functionaliteit en werking ................................................................................. 41
9.6.2
Weergave en beschrijving ................................................................................. 41
Activiteit 1: Ophalen statusinformatie of mededeling(en).................................................. 41 Activiteit 2: Registreren resultaat in audittrail ................................................................. 41 9.7
Bezorgservice ..................................................................................................... 42
9.7.1
Functionaliteit en werking ................................................................................. 42
9.7.2
Weergave en beschrijving ................................................................................. 42
Activiteit 1: Controleer conformiteit koppelvlak ............................................................... 42 Activiteit 2: Controle berichtgrootte ............................................................................... 43 Activiteit 3: Controleren validiteit van berichtsoort........................................................... 43 Activiteit 4: Controleren aanwezigheid kenmerk .............................................................. 43 Activiteit 5: Registreren mededeling .............................................................................. 43 Activiteit 6: Registreren resultaat in audittrail ................................................................. 44 9.8
Validatieservice ................................................................................................... 44
9.8.1
Functionaliteit en werking ................................................................................. 44
9.8.2
Weergave en beschrijving ................................................................................. 44
Activiteit 1: Constateren UBL/ HRXML ............................................................................ 44 Activiteit 2: XSD validatie ............................................................................................. 45 Activiteit 3: Schematron............................................................................................... 45 Activiteit 4: Registreren resultaat in de audit-trail............................................................ 45 9.9
Mail transfer agent .............................................................................................. 45
9.9.1
Functionaliteit en werking ................................................................................. 45
9.9.2
Weergave en beschrijving ................................................................................. 45
Activiteit 1: Verzenden email aan ontvangende partij....................................................... 46
Pagina 5 van 46
Activiteit 2: Ontvangen email........................................................................................ 46 Activiteit 3: Ontvangen bevestiging ............................................................................... 46
Pagina 6 van 46
1 Inleiding 1.1
Aanleiding
Logius handelt met Digipoort in opdracht van publieke partijen op eenduidige wijze informatieprocessen af. Hierbij wordt zoveel mogelijk gebruik gemaakt van services. De karakteristieken van het proces kunnen echter per ‘berichtsoort’ verschillen. In het kader van een goed afsprakenstelsel is het van belang dat alle betrokken partijen voor ieder ‘berichtsoort’ een eenduidig en gedragen beeld hebben over het geïmplementeerde proces.
1.2
Doel van het document
Dit document geeft de proceskarakteristieken weer van het berichtsoort 'e-Factureren'. Het is een voorstelling van de processen en services zoals die momenteel beschikbaar zijn binnen Digipoort. De processen moeten worden vastgesteld door de betrokkenen en stake-holders.
1.3
Scope en reikwijdte
In dit document worden de processtappen in Digipoort in detail beschreven. Informatieprocessen die door derden worden uitgevoerd vallen buiten de scope. Verder vallen berichtkarakteristieken buiten de scope. Hiervoor wordt verwezen naar de koppelvlakspecificaties, specificaties van foutcodes en specificatie van status.
1.4
Leeswijzer
Het document gaat eerst in op de achtergrond en eigenaar van het proces dat hoort bij een berichtsoort. Vervolgens volgt een overzicht met technische en berichtkarakterisiteken. Achtereenvolgens worden de deelprocessen die gelinkt zijn aan het e-Factuur proces weergegeven en beschreven. Waar deze deelprocessen gebruik maken van generieke services wordt naar deze services verwezen. In het slothoofdstuk van het document is de servicecatalogus weergeven. Voor de weergave van de processen wordt gebruik gemaakt van BPMN. BPMN (Business Process Modelling Notation) is een grafische standaard om (bedrijfs)processen methodologisch in kaart te brengen. De standaard wordt door de Object Management Group (OMG) beheerd en verder ontwikkeld. Het doel van BPMN is om, zowel voor technische gebruikers als voor gebruikers met een bedrijfsmatige blik, een intuïtieve en inzichtelijke weergave te tonen van complexe processen. De BPMN platen zijn een communicatie middel om inzicht te krijgen in alle details van een proces en kunnen daarnaast ook direct worden omgezet naar een implementatie taal als Business Process Execution Language (BPEL). BPMN dient als gemeenschappelijke taal om het gat tussen procesontwerpers en technici te dichten.
Pagina 7 van 46
2 Proceskarakteristieken 2.1
Context
De eigenaar van het berichtsoort e-Factureren is het ministerie van Economische Zaken. Het programma E-Factureren is gericht op de invoering van een eenduidig kanaal voor het elektronisch factureren aan de (Rijks)overheid. De inrichting van het eenduidige kanaal gebeurt langs de dimensies gegevens, processen en techniek. Door binnen deze dimensies gebruik te maken van generieke componenten kunnen aanzienlijke efficiencyvoordelen behaald worden. Kenmerkend voor E-Factureren in Nederland is verder het gebruik van een generieke procesinfrastructuur – de Digipoort. De Digipoort is een technische voorziening die aanleverende partijen in staat stelt voor verschillende communicatiestromen met de overheid gebruik te maken van hetzelfde aanleverpunt. De procesinfrastructuur bepaalt op basis van het berichtkenmerk hoe een aangeleverd bericht – bijvoorbeeld een elektronische factuur- afgehandeld moet worden. Bij aanlevering van een elektronische factuur worden een aantal basale technische controles uitgevoerd. Hierbij wordt vastgesteld of het aangeleverde bericht voldoet aan vooraf vastgestelde vormvereisten. Indien dit niet het geval is ontvangt de aanleverende partij een foutmelding. Bij een succesvolle aflevering aan digipoort wordt het aangeleverde bericht omgezet in een afleverbericht. Voor het opvragen van statusinformatie (informatie over de wijze waarop berichten zijn afgehandeld) en retourinformatie (informatie van een uitvragende partij naar aanleiding van een aanlevering) zijn ook generieke processen in gebruik. Vooralsnog vertonen de processen die in de infrastructuur zijn geïmplementeerd grote overeenkomsten. Zij maken veelal gebruik van dezelfde services. Er zijn wel nuanceverschillen. Het aanleverproces voor E-Factureren bevat geen validatie op berichten- (factuur)niveau. Dit is bij de meeste andere processen in Digipoort wel het geval.
2.2
Volwassenheidsniveau
Binnen Digipoort worden voor processen in productie verschillende volwassenheidsniveaus onderscheiden. Deze zijn in onderstaande tabel opgenomen: Volwassenheidsniveau 0
0.1
1
2
3
Beschrijving Productievariant voor gecontroleerde en relatief beperkt gebruik. Toekomstige wijzigingen in het proces noodzakelijk Productievariant voor gecontroleerd en matig gebruik. Toekomstige wijzigingen in het proces voorzien binnen 1 jaar. Productievariant voor ongecontroleerde en grootschalige afhandeling. Significante wijzigingen in het proces voorzien binnen 1 tot 2 jaar. Productievariant voor ongecontroleerde en grootschalige afhandeling. Significante wijzigingen in het proces binnen 1 tot 2 jaar mogelijk. Productievariant voor ongecontroleerde en grootschalige afhandeling. Significante wijzigingen in het proces binnen 1 tot 2 jaar onwaarschijnlijk.
Pagina 8 van 46
Het proces e-Factureren heeft volwassenheidsniveau 0.1
2.3
BPMN
Dit document bevat zowel een grafische weergave van processen en services in BPMN als een tekstuele toelichting. De BPMN-platen zijn op twee niveaus getekend: procesniveau en serviceniveau. In de tekstuele beschrijving op serviceniveau is per activiteit aangegeven hoe het proces verder loopt: de default en alternative flow. In de gevallen waar geen alternative flow is beschreven bestaat altijd de alternative flow op procesniveau, waar door middel van een ‘intermediate error event’ of ‘intermediate timer event’ een alternatief pad wordt aangegeven. Voor een overzicht van de BPMN elementen en de betekenissen hiervan verwijzen wij naar de site: http://www.bpmn.org
2.4
Audittrail
Wanneer bij de audittrail gesproken wordt over tijdsstempel is dit het moment van registratie. Doordat de registratie onderdeel uitmaakt van de services, is dit tevens het moment van afsluiten van de service en vallen deze tijdstippen samen.
2.5
Technische Karakteristieken en berichtkarakteristieken
Kenmerk Formele naam berichtsoort: Bedrijfsnummer: Koppelvlakken aanleveren: Koppelvlakken opvragen status/mededelingen: Koppelvlakken afleveren:
Koppelvlak bezorgen bezorgen mededeling: Aanlevercertificaat: Verbinding certificaat: Payload: Maximale duur van de verwerking Normale duur van de verwerking (95%) Maximale duur van de aflevering Verwachte load Maximale piekbelasting gedurende 1 uur
2.6
Karakteristiek E-Factuur KVK nummer Webservices Bedrijven - WUS 2.0 Aanleverservice Webservices Bedrijven - WUS 2.0 – Statusinformatie-service Digikoppeling ebMs – afleverservice of Digikoppeling WUS – afleverservice Mail transfer agent Digikoppeling ebMs – bezorgservice of Digikoppeling WUS – bezorgservice Base x.509 PKIoverheid certificaat G1 niveau Base x.509 PKIoverheid certificaat G1 niveau UBL2.0 of HR-XML invoice op basis van de Nederlandse Taxonomie 1 dag 2 min 2 min 1.000.000 berichten per jaar (ofwel 2 per minuut) 100.000 berichten in één uur (ofwel 27 per seconde gedurende 1 uur)
Karakteristieken ten aanzien van het ebMS koppelvlak
Kenmerk / element Beveiliging Versie Gebruikt element: Berichtkenmerk Verplicht element: Kenmerk Verplicht element: Aanleverkenmerk
Karakteristiek De voorkeur gaat uit naar osb-rm-s ebMS 2.0 specificatie De GUID die door Digipoort is afgegeven aan de aanleveraar van het bericht. De GUID die door Digipoort is afgegeven te identificatie van het verwerkingsproces. Het Kenmerk dat door de aanleveraar is
Pagina 9 van 46
Verplicht element: Berichtsoort Verplicht element: Bedrijfsnummer
Gebruikt element: identificatienummer/type
2.7
Dit bevat het nummer en het type van het nummer van de aanleveraar bijv de waarde 123456 en KvK Dit bevat de waarde KvK bij berichten van bedrijven en de waarde OIN bij berichten van de overheden.
Karakteristieken ten aanzien van het HTTPS en WUS koppelvlak
Kenmerk / element Beveiliging Versie authenticatie
Gebruikte protocollen in het bericht Gebruik van het auspEndpoint Optioneel element: Kenmerk
Verplicht element: overheidsnummer
Verplicht element: Aanleverkenmerk Verplicht element: Berichtsoort Verplicht element: Bedrijfsnummer
Gebruikt element: identificatienummer/type
2.8
meegegeven aan het bericht Vaste waarde E-Factuur
Karakteristiek HTTPS ofwel SSL/TLS op transportniveau WUS2.0 de authenticiteit van bedrijven wordt bepaald aan de hand van het PKIOverheid clientcertificaat WS-Adressing WS-Security Dit is vanaf deze versie optioneel Deze moet leeg worden gelaten bij een nieuw factuurbericht. Bij het opnieuw aanleveren van een eerder bericht kan het kenmerk worden overgenomen en herbruikt. Hier moet door de aanleveraar het OIN nummer van de geadresseerde overheid worden opgenomen. Het Kenmerk dat door de aanleveraar wordt meegegeven aan het bericht Vaste waarde E-Factuur Dit bevat het nummer en het type van het nummer van de aanleveraar bijv de waarde 123456 en KvK Dit bevat de waarde KvK bij berichten van bedrijven.
Karakteristieken ten aanzien van het Mail koppelvlak
Kenmerk / element Beveiliging Opzet van het bericht Maximale grootte van het bericht incl. bijlagen Zekerheid van afleveren
Karakteristiek Geen Gelijk aan de opzet van WUS 20MB De MTA van Digipoort verwacht een bevestiging van afleveren van het SMTP bericht van de ontvangende MTA. Dit is standaard verwerking op basis van SMTP
Pagina 10 van 46
Pagina 11 van 46
2.9
Deelprocessen
Het e-Facturatieproces kent 6 deelprocessen: 1. Aanleverproces: Het afleveren van een e-Factuur aan Digipoort door een aanleveraar Startpunt van dit deelproces is het middels een SOAP-request aanbieden van een UBL2.0 of HR-XML van de SETU invoice op basis van de Nederlandse Taxonomie, verpakt in een SOAP-envelope door een aanleveraar aan de aanleverservice. Het eindpunt van dit deelproces is een afleverbericht, een SOAP-response, waarin aangegeven wordt of de aflevering gelukt of mislukt is. Indien afleveren mislukt, betreft het een zogenaamde SOAP-fault. Afhankelijk van de reden waarom aflevering mislukt is, varieert de inhoud van de SOAP-fault. 2. Verwerkproces: Het verwerken van een e-Factuur binnen Digipoort. Startpunt van dit deelproces is een binnengekomen e-Factuur in de Digipoort. Het eindpunt van dit deelproces is een afleverbericht, een SOAP-response, waarin aangegeven wordt of de verwerking gelukt of mislukt is. Indien verwerken mislukt, betreft het een zogenaamde SOAP-fault. Afhankelijk van de reden waarom verwerking mislukt is, varieert de inhoud van de SOAP-fault. 3. Statusinformatieproces: Het ophalen van statusinformatie ten aanzien van de aanlevering van een e-Factuur door een aanleveraar Startpunt hierbij is het middels een SOAP-request aanbieden van een statusinformatieverzoek door de aanleveraar aan de statusservice. Het eindpunt van dit deelproces is een SOAP-response met, indien de statusinformatie succesvol is opgehaald, daarin de statusinformatie. Indien het ophalen van statusinformatie mislukt is, betreft het een zogenaamde SOAP-fault. Afhankelijk van de reden waarom het ophalen mislukt is, varieert de inhoud van de SOAP-fault. 4. Mededelingenproces: Het ophalen van een mededeling met betrekking tot een eFactuur door een aanleveraar Startpunt is hierbij het middels een SOAP-request aanbieden van een mededelingverzoek door de aanleveraar aan de aanleverservice. Het eindpunt van dit deelproces is een SOAPresponse met, indien de mededeling succesvol is opgehaald, daarin de mededeling. Indien het ophalen van de mededeling mislukt is, betreft het een zogenaamde SOAP-fault. Afhankelijk van de reden waarom het ophalen mislukt is, varieert de inhoud van de SOAPfault. 5. Het bezorgen van een mededeling door een overheidspartij, naar aanleiding van een binnengekomen e-Factuur. Startpunt hierbij is het middels een SOAP-request aanbieden van een mededeling aan de bezorgservice. Het eindpunt van dit deelproces is een SOAP-response waarin aangegeven wordt of de bezorging van de mededeling aan de Digipoort gelukt of mislukt is. Indien afleveren mislukt, betreft het een zogenaamde SOAP-fault. Afhankelijk van de reden waarom aflevering mislukt is, varieert de inhoud van de SOAP-fault. 6. Afleverproces, waarmee het bericht door de Digipoort aan de overheid wordt verzonden. Startpunt hierbij is het middels een SOAP-request aanbieden van een bericht aan de overheidspartij. Het eindpunt is een afgeleverd bericht bij de overheid. Indien het mislukt, ontstaat een SOAP-fault. Afhankelijk van de reden waarom het afleveren mislukt is, varieert de inhoud van de SOAP-fault. Pagina 12 van 46
2.10 Monitoring Binnen Digipoort is real-time monitoring op alle deelprocessen mogelijk. Afhankelijk van de wensen van de uitvragende partij worden door de beheerpartij periodiek queries uitgevoerd ten einde vastgestelde performance indicatoren te checken. Het is ook mogelijk dat de uitvragende partij zelf toegang krijgt tot de monitoringomgeving. Zij kunnen dan bepaalde performance indicatoren periodiek controleren. Daarnaast wordt er op aanleverniveau met behulp van een zogenaamde ‘datapower doos’ afwijkende aanleverpatronen gesignaleerd. Bij ‘verdachte’ aanleveringen (bijvoorbeeld onrealistisch grootschalige aanlevering vanaf één of meerdere ipadressen) wordt de bandbreedte voor aanlevering automatisch ‘afgeknepen’. Er worden nog geen automatische warnings gegeven bij het uitblijven van aanleveringen, of afwijkende mate van berichtafkeuring. Dit is technisch wel mogelijk, echter er dient dan wel aan de volgende randvoorwaarde te worden voldaan: 1. De stromen dienen een stabiel aanleverpatroon te kennen, dit is thans nog niet het geval. 2. De uitvragende partijen dienen aan te geven waarop zij een ‘warning’ willen.
Pagina 13 van 46
3 Aanleverproces E-factuur 3.1
Kenmerken van het deelproces
Doel van het deelproces is de aflevering in enge zin van een bericht, de e-Factuur, bij de ontvangende partij. Betrokken actor bij dit deelproces is in actieve zin, de aanleveraar. Dit betreft de aanleveraar zelf of een door hem gemachtigde intermediair die bericht wil doen. Betrokken actoren in passieve zin is de leverancier van de Digipoort. De aanleveraar wordt herkend aan het certificaat dat is gebruikt voor het tekenen van de WS-security header van het SOAP-bericht. Betrokken actoren
Rol
Vorm
Bedrijf
Aanleveraar
actief
Leverancier Digipoort
Verwerker
passief
Overheidspartij
Ontvanger
passief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMNweergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus staan deze services in meer detail beschreven. Services Aanleveren bericht Aanleverservice
Verwerken resultaat
Beschrijving Aanleveraar verstuurt SOAP-bericht aan de aanleverservice De aanleverservice voert de eerste essentiële controles uit, maakt een uniek berichtkenmerk aan waarmee het bericht ter controle herleidbaar is en opent de audittrail indien deze controles succesvol voltooid worden. De binnengekomen meldingen van services worden via het juiste SOAP bericht teruggekoppeld aan de aanleveraar.
De foutmeldingen staan in de subprocessen van de services beschreven en zijn terug te vinden in de service catalogus aan het einde van het document.
3.2
Audittrail
Gedurende het aanleverproces wordt van elke processtap in de digipoort informatie opgeslagen. Voor iedere procesafhandeling (de specifieke afhandeling van een soap-bericht) wordt na de eerste controles een uniek kenmerk aangemaakt: dit kenmerk wordt weggeschreven in de audittrail. Alle resultaten die na dit moment volgen (karakteristieken van het specifieke procesverloop) worden bij dit unieke nummer weggeschreven. De karakteristieken bestaan dus uit de gedefinieerde soapfaults, statussen (aangeleverd, afgeleverd, etc.) en tijdstempels. Bij elke aanlevering hoort een uniek bedrijfsnummer en een uniek aanlevercertificaat.
3.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services en de ontvangende partij: 2 minuten • de bewaartermijn van het kenmerk: 5 jaar • de bewaartermijn van de audittrail: 5 jaar • de bewaartermijn van de statusinformatie: 5 jaar • de bewaartermijn van het aanleverkenmerk: 5 jaar
Pagina 14 van 46
Pagina 15 van 46
4 Verwerkproces E-factuur 4.1
Kenmerken van het deelproces
Doel van het deelproces is de verwerking van een bericht dat is aangeleverd door een bedrijf binnen de Digipoort. Betrokken actoren in actieve zin de Digipoort en de leverancier van de Digipoort. Betrokken actoren
Rol
Vorm
Leverancier Digipoort
Verwerker
actief
Overheidspartij
Ontvanger
passief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMNweergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus staan deze services in meer detail beschreven. Services Validatieservice Verwerken procesresultaat
Beschrijving De validatieservice voert controles uit op het bericht. De uitkomsten van de validatieservice worden verwerkt en opgeslagen.
De foutmeldingen staan in de subprocessen van de services beschreven en zijn terug te vinden in de service catalogus aan het einde van het document.
4.2
Audittrail
Gedurende het verwerkproces wordt van elke processtap in de digipoort informatie opgeslagen. Alle resultaten (karakteristieken van het specifieke procesverloop) worden bij het unieke nummer weggeschreven. De karakteristieken bestaan dus uit de gedefinieerde SOAP-faults, statussen en tijdstempels.
4.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services en de ontvangende partij: 2 minuten • de bewaartermijn van het kenmerk: 5 jaar • de bewaartermijn van de audittrail: 5 jaar • de bewaartermijn van de SOAP-response van de autorisatieservice: 5 jaar • de bewaartermijn van de statusinformatie: 5 jaar • de bewaartermijn van het aanleverkenmerk: 5 jaar
Pagina 16 van 46
Pagina 17 van 46
5 Statusinformatieproces 5.1
Kenmerken van het deelproces
Doel van het deelproces is de opvrager (bedrijf) te voorzien van informatie over het verloop van een doorlopen aanleverproces binnen de infrastructuur. De opvrager is de actief betrokken actor bij dit deelproces. De leverancier van de Digipoort is de passieve actor. De opvrager wordt herkend aan het certificaat uit de WS-security header. Het ophalen van de statusinformatie kan afhankelijk van het verzoek betrekking hebben op: a) De statusinformatie behorende bij een specifiek kenmerk. b) De statusinformatie behorende bij een ingestuurd bericht, die nog niet eerder bij een zeker certificaat zijn opgehaald. Dit gebeurt met behulp van het kenmerk. c) De statusinformatie behorende bij een ingestuurd bericht, die nog niet eerder bij een zeker certificaat zijn opgehaald. Dit gebeurt met behulp van de combinatie berichtsoort en bedrijfsnummer. Tevens kan een bedrijf alle processen en alle relevante berichtsoorten aan de hand van de volgende SOAP-requests opvragen: d) Geeft alle processen voor een bepaald bedrijf met een specifiek berichtsoort. De processen die aangemaakt zijn voor een algemene e) mededeling worden niet teruggegeven. Geeft alle berichtsoorten waarin een bepaald bedrijf verantwoordingsinformatie heeft verstuurd. Betrokken actoren
Rol
Vorm
Bedrijf
Opvrager
actief
Leverancier Digipoort
Verwerker
passief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMN-weergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus aan het einde van dit document staan deze services in meer detail beschreven. Services Aanleveren statusverzoek Statusservice
Ophalen statusinformatie Verwerken procesresultaat
5.2
Beschrijving Opvrager verstuurt statusinformatieverzoek aan de statusservice De aanleverservice voert de eerste essentiële controles uit, identificeert het type verzoek en heropent de audittrail, horend bij het kenmerk waar de statusinformatie op van toepassing is indien deze controles succesvol voltooid worden. Deze service haalt de juiste informatie op en registreert het resultaat in de audittrail Verwerkt de binnengekomen meldingen van de andere services en koppelt vervolgens het juiste SOAP bericht terug aan de opvrager.
Audittrail
Gedurende het statusinformatieproces wordt in de audittrail informatie opgeslagen voor alle pogingen om status op te vragen bij een bedrijfsnummer, waar een kenmerk voor bestaat. De informatie betreft het certificaat-ID van de opvrager van de
Pagina 18 van 46
statusinformatie, het resultaat van de autorisatieservice en of de opgevraagde status aan de opvrager is afgeleverd of niet.
5.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services; 2 minuten • de bewaartermijn van een nieuw aangemaakt kenmerk; 5 jaar • de bewaartermijn van de audittrail; 5 jaar • de bewaartermijn van de SOAP-response van de autorisatieservice; 5 jaar • de bewaartermijn van de door de statusservice opgeslagen gegevens; 5 jaar
Pagina 19 van 46
Pagina 20 van 46
6 Mededelingenproces 6.1
Kenmerken van het deelproces
Doel van dit deelproces is het aanleveren van mededelingen die door een uitvragende partij (een overheidspartij) zijn gedaan over een ingezonden instance. Een bedrijf (de opvragende partij) controleert bij Digipoort of er mededelingen zijn. Digipoort levert de aanwezige mededelingen aan, bij de opvrager. De opvragende partij is de enige actieve actor in dit proces. De leverancier van de Digipoort is de passieve actor. Het ophalen van de mededeling kan afhankelijk van het verzoek betrekking hebben op: a) Alle mededelingen voor een bepaald bedrijf die gekoppeld zijn aan een proces met een specifiek berichtsoort. b) De mededelingen behorende bij een bepaald proces. c) Alle mededelingen van het gegeven proces die nog niet eerder bij dit certificaat opgehaald zijn (alle mededelingen waarmee voor het betreffende kenmerk en certificaat nog geen relatie is vastgelegd.) d) Alle mededelingen voor het gegeven bedrijf die nog niet eerder bij dit certificaat opgehaald zijn (alle mededelingen waarmee voor het betreffende bedrijfsnummer en certificaat nog geen relatie is vastgelegd). Betrokken actoren
Rol
Vorm
Bedrijf
Opvrager
actief
Leverancier Digipoort
Verwerker
passief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMN-weergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus aan het einde van dit document staan deze services in meer detail beschreven. Services Aanleveren statusverzoek Mededelingenservice
Ophalen mededelingeninformatie Verwerken procesresultaat
6.2
Beschrijving De opvrager verstuurt verzoek tot bezorgen aan de mededelingenservice De mededelingenservice voert de eerste essentiële controles uit en heropent de audittrail, horend bij het kenmerk waar de mededeling(en) op van toepassing zijn, indien deze controles succesvol voltooid worden. Deze service haalt de juiste informatie op en registreert het resultaat in de audittrail bij de relevante kenmerken. Verwerkt de binnengekomen meldingen van de andere services en koppelt vervolgens het juiste SOAP bericht terug aan de opvrager.
Audittrail
Gedurende het mededelingenproces wordt in de audittrail informatie opgeslagen voor alle pogingen om mededelingen op te vragen bij een bedrijfsnummer, waar een kenmerk voor bestaat. De informatie betreft het certificaat-ID van de opvrager van de mededeling, het resultaat van de autorisatieservice en of de opgevraagde mededeling aan de opvrager is afgeleverd of niet.
Pagina 21 van 46
6.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services; 2 minuten • de bewaartermijn van een nieuw aangemaakt kenmerk; 5 jaar • de bewaartermijn van de audittrail; 5 jaar • de bewaartermijn van de SOAP-response van de autorisatieservice; 5 jaar • de bewaartermijn van de door de statusservice opgeslagen gegevens; 5 jaar
Pagina 22 van 46
Pagina 23 van 46| versie 1.0
7 Bezorgproces 7.1
Kenmerken van het deelproces
Doel van dit deelproces is het overbrengen van mededelingen over een bericht door de mededeler (de overheidspartij). Dit proces ziet alleen op een mededeling die betrekking heeft op een proces dat reeds in gang is gezet door een aanleveraar. Er dient altijd naar een bestaand kenmerk verwezen wordt. De ontvangende partij is de enige actieve actor in dit proces. De leverancier van de infrastructurele dienst, is de enige passieve actor. Betrokken actoren
Rol
Vorm
Overheidspartij
Mededeler
actief
Leverancier Digipoort
Verwerker
passief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMN-weergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus aan het einde van dit document staan deze services in meer detail beschreven. Services Versturen bezorgenverzoek Bezorgservice
Verwerken resultaat
7.2
Beschrijving De mededeler verstuurt verzoek tot bezorgen aan de bezorgservice De bezorgservice voert de eerste essentiële controles uit, registreert de mededeling en opent de audittrail indien deze controles succesvol voltooid worden. Verwerkt de binnengekomen meldingen van de andere services en koppelt vervolgens het juiste SOAP bericht terug aan de mededeler.
Audittrail
Gedurende het bezorgproces wordt van elke processtap in de procesinfrastructuur informatie opgeslagen. Deze informatie wordt toegevoegd aan de audittrail waar de mededeling betrekking op heeft.
7.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services; 2 minuten • de bewaartermijn van een nieuw aangemaakt kenmerk; 5 jaar • de bewaartermijn van de audittrail; 5 jaar • de bewaartermijn van de SOAP-response van de autorisatieservice; 5 jaar • de bewaartermijn van de door de bezorgservice opgeslagen gegevens; 5 jaar • de bewaartermijn van de door de overheidspartij aangeleverde mededeling: 5 jaar.
Pagina 24 van 46
Pagina 25 van 46
8 Afleverproces 8.1
Kenmerken van het deelproces
Doel van dit deelproces is het afleveren van een bericht, de E-factuur, verstuurder (de leverancier van Digipoort). Dit proces ziet alleen op een E-factuur die betrekking heeft op een proces dat reeds in gang is gezet door een aanleveraar. Er dient altijd naar een bestaand kenmerk verwezen wordt. De versturende partij is de enige actieve actor in dit proces. De overheid is de enige passieve actor. Betrokken actoren
Rol
Vorm
Overheid
Ontvanger
passief
Leverancier Digipoort
Verstuurder
actief
Op de volgende pagina wordt het beschreven proces in BPMN weergegeven. In deze BPMN-weergave staan de generieke services benoemd. Hieronder volgt een overzicht van de services met een korte beschrijving. In de servicecatalogus aan het einde van dit document staan deze services in meer detail beschreven. Services Afleverservice Ontvangstservice Mail transfer agent
8.2
Beschrijving De Digipoort verstuurt het bericht aan de ontvangstservice van de overheid De ontvangstservice voert koppelvlakcontroles uit en accepteert het bericht Digipoort verstuurt mail via mail transfer agent van de Digipoort aan de mail transfer agent van de overheid
Audittrail
Gedurende het afleverproces wordt van elke processtap in de procesinfrastructuur informatie opgeslagen. Deze informatie wordt toegevoegd aan de audittrail waar de mededeling betrekking op heeft.
8.3
Configuraties
Belangrijke configuraties betreffen: • de maximale responstijd van de services; 2 minuten • de bewaartermijn van een nieuw aangemaakt kenmerk; 5 jaar • de bewaartermijn van de audittrail; 5 jaar • de bewaartermijn van de SOAP-response van de autorisatieservice; 5 jaar • de bewaartermijn van de door de bezorgservice opgeslagen gegevens; 5 jaar • de bewaartermijn van de door de overheidspartij aangeleverde mededeling: 5 jaar.
Pagina 26 van 46
Pagina 27 van 46
9 Servicecatalogus 9.1
Aanleverservice
9.1.1
Functionaliteit en werking
De aanleverservice stelt vast of het in het kader van de betrouwbare werking van Digipoort verantwoord is een aangeleverd bericht te accepteren. De aanleverservice voert hiertoe de eerste essentiële controles uit. Indien deze controles succesvol voltooid worden opent de aanleverservice de audittrail. Het is hiermee de voordeur van Digipoort, waar de toegang verleend of geweigerd wordt op basis van het voldoen aan de toegangseisen, zoals geldig certificaat en hanteerbare berichtgrootte. 9.1.2
Weergave en beschrijving
Activiteit
Input
Output
SOAP-aanleverbericht
Juiste koppelvlakspecificatie of ALS130
2 3 4
Controle geldigheid certificaat en integriteit Controleren elementen Base64 decoderen Controle berichtgrootte
SOAP-aanleverbericht SOAP-aanleverbericht SOAP-aanleverbericht
5
Controle aanwezigheid kenmerk
SOAP-aanleverbericht
Juiste koppelvlakspecificatie of ALS100 Geconverteerd SOAP-aanleverbericht SOAP-bericht, waarvan berichtgrootte < 20 MB is of ALS 110 Geen kenmerk of ALS160
6
Controle aanwezigheid en conformiteit bedrijfsnummer
SOAP-aanleverbericht
SOAP-bericht, waarvan bedrijfsnummer klopt of ALS 150
7
Validiteitscontrole berichtsoort
SOAP-aanleverbericht
Herkend berichtsoort of ALS140
8
Aanmaken kenmerk
Aangemaakt kenmerk
9
Aanmaken Audittrail
Audittrail uniek record
1
Pagina 28 van 46
10
Registreren resultaat in audittrail
kenmerk Bedrijfsnummer Certificaat-ID
Velden audittrail met tijdsstempel
Activiteit 1: Controle geldigheid certificaat en integriteit Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: het certificaat en de signature. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault ALS130 Bestaansreden Voordat het bericht aangeleverd wordt aan de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken. De ontvangende partij zal alleen integere en ondertekende(geldig certificaat) berichten kunnen verwerken. Activiteit 2: Controleren elementen Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: de invulling van elementen in het bericht. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault ALS100 Bestaansreden Voordat het bericht aangeleverd wordt de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken Activiteit 3: Base64 decoderen Default flow De aanleverservice decodeert het in Base64 binnengekomen bericht naar UTF-8 formaat. Bestaansreden Voor verdere verwerking in het proces is een Base64 conversie noodzakelijk. Activiteit 4: Controle berichtgrootte Default flow De aanleverservice controleert of de omvang van het aangeleverde bericht kleiner of gelijk is aan 20 MB. Doordat een bericht na base64 conversie in omvang toe kan
Pagina 29 van 46
nemen en de feitelijke controle na deze conversie plaatsvindt, wordt er bij de controle rekening gehouden met de relatieve toename in berichtgrootte. Alternative flow Indien de verantwoordingsinformatie groter is dan 20 MB, volgt een SOAP-fault 110. Bestaansreden Deze limiet voor berichtgrootte is gemaakt om te voorkomen dat foutieve berichten voor vertragingen zorgen bij andere aanleveraars. Activiteit 5: Controle aanwezigheid kenmerk Default flow De aanleverservice controleert of er een kenmerk in het SOAP-bericht aanwezig is. Alternative flow Indien dit het geval is volgt een SOAP-fault ALS-160. Bestaansreden Berichten waarvan al een kenmerk aanwezig is kunnen niet in behandeling worden genomen, het kenmerk is niet herbruikbaar. Activiteit 6: Controle aanwezigheid bedrijfsnummer Default flow De aanleverservice controleert de aanwezigheid van een bedrijfsnummer in de SOAPbody dat voldoet aan de karakteristieken die voor bedrijfsnummers zijn toegestaan. Alternative flow Indien het bedrijfsnummer niet aanwezig is of niet voldoet aan de karakteristieken die voor bedrijfsnummers zijn toegestaan ALS150 met daarin opgenomen de relevante foutmelding naar de result service. Bestaansreden Berichten met een foutief bedrijfsnummer of een bedrijfsnummer dat niet voldoet aan de hiervoor geldende karakteristieken kunnen niet worden verwerkt. Activiteit 7: Validiteitscontrole berichtsoort Default flow De aanleverservice controleert of er specificaties aanwezig zijn voor het meegegeven berichtsoort. Indien dit het geval is bepaalt de aanleverservice op basis van het berichtsoort welk specifiek proces afgehandeld dient te worden. Alternative flow Indien dit niet het geval is volgt er een SOAP-fault ALS-140. Bestaansreden
Pagina 30 van 46
Omdat er berichten voor meerdere partijen en verschillende processen binnenkomen is het noodzakelijk te bepalen welke proces bij een aangeleverd bericht afgehandeld moet worden en waar het bericht uiteindelijk wordt afgeleverd. Activiteit 8: Aanmaken kenmerk Default flow De aanleverservice maakt een uniek kenmerk aan voor de aanlevering. Bestaansreden Het kenmerk wordt gebruikt om aanleveringen te identificeren. Activiteit 9: Aanmaken audittrail Default flow Er wordt een audittrail aangemaakt voor de bericht aflevering op basis van het certificaat van de aanleveraar. Bestaansreden Na de voorgaande controles is het op dit punt mogelijk om een ID te verbinden aan een aanlevering. Vandaar dat hier de audittrail aangemaakt wordt, om vervolgens elke aanlevering te kunnen volgen. Activiteit 10: Registreren resultaat in audittrail Default flow De aanleverservice registreert een tijdsstempel en het kenmerk in de audittrail. Het tijdsstempel is gebaseerd op het succesvol ontvangen van een bericht, dus het eindresultaat van de aanleverservice. Bestaansreden Hiermee is elke aanlevering die geaccepteerd wordt door de aanleverservice geregistreerd en herleidbaar in de audittrail.
Pagina 31 van 46
9.2
Afleverservice
9.2.1
Functionaliteit en werking
De afleverservice verstuurt het bericht aan de juiste partij verzonden en registeert het resultaat in de audittrail 9.2.2
1 2 3
Weergave en beschrijving
Activiteit Opzetten SSL-verbinding Afleveren bericht
Input SOAP-aanleverbericht SOAP-aanleverbericht
Registreren resultaat in audittrail
Resultaat, kenmerk
Output SSL-verbinding of AFS400 SOAP-afleverbericht of AFS600 Geregistreerd resultaat, met tijdstempel
Activiteit 1: Opzetten SSL-verbinding Default flow Er wordt een beveiligde SSL-verbinding opgezet. Indien de verbinding succesvol tot stand is gekomen gaat het proces verder. Alternative flow Wanneer de SSL-verbing niet kan worden opgezet volgt er een SOAP-fault AFS400. Bestaansreden Er dient een beveiligde verbinding opgezet te worden om berichten af te leveren bij de ontvangende partij. Activiteit 2: Afleveren bericht Default flow De afleverservice verstuurt de bericht aan de ontvangende partij Alternative flow
Pagina 32 van 46
Indien de ontvangende partij niet beschikbaar is, of er na 2 minuten geen reactie is van de ontvangende partij (2 minuten time-out), volgt er een SOAP-fault AFS600. Bestaansreden Berichten afleveren aan een ontvangende partij is inherent aan de werking van de afleverservice. Activiteit 3: Registreren resultaat in audittrail Default flow De afleverservice registreert het resultaat en een tijdsstempel in de audittrail. Bestaansreden Hiermee is elke aanlevering die behandeld is door de afleverservice geregistreerd en herleidbaar in de audittrail.
Pagina 33 van 46
9.3
Verwerken procesresultaat
9.3.1
Functionaliteit en werking
Bij het verwerken van het procesresultaat wordt de statusinformatie opgeslagen en het resultaat daarvan geregistreerd in de audittrail 9.3.2
1 2
Weergave en beschrijving
Activiteit Opslaan statusinformatie Registreren resultaat in audittrail
Input Status-aanvulling Resultaat, kenmerk
Output Aangevulde status Geregistreerd resultaat, met tijdstempel
Activiteit 1: Opslaan statusinformatie Default flow Op basis van het binnengekomen statuswijziging wordt deze statusinformatie bijgevoegd Bestaansreden Hiermee wordt een overzicht van de statushistorie opgebouwd om daarmee het doorlopen proces te kunnen herleiden. Activiteit 2: Registreren resultaat in audittrail Default flow De resultservice registreert het resultaat en een tijdsstempel in de audittrail. Bestaansreden Hiermee is elke aanlevering die behandeld is door de resultservice geregistreerd en herleidbaar in de audittrail.
Pagina 34 van 46
9.4
Mededelingenservice
9.4.1
Functionaliteit en werking
De mededelingenservice controleert het verzoek en identificeert het type verzoek op basis van het kenmerk of het berichtsoort. De service controleert ook of de opvrager van het verzoek ook de oorspronkelijke aanleveraar van het bericht was. Het verzoek wordt verstuurd zodat het opgehaald kan worden. Het verzoek betreft specifieke kenmerken van mededelingen en de controle op de kenmerken is uniek voor het mededelingenproces. Het ophalen van de mededeling kan afhankelijk van het verzoek betrekking hebben op: a) Alle mededelingen voor een bepaald bedrijf die gekoppeld zijn aan een proces met een specifiek berichtsoort. b) De mededelingen behorende bij een bepaald proces. c) Alle mededelingen van het gegeven proces die nog niet eerder bij dit certificaat opgehaald zijn (alle mededelingen waarmee voor het betreffende kenmerk en certificaat nog geen relatie is vastgelegd.) d) Alle mededelingen voor het gegeven bedrijf die nog niet eerder bij dit certificaat opgehaald zijn (alle mededelingen waarmee voor het betreffende bedrijfsnummer en certificaat nog geen relatie is vastgelegd). 9.4.2
1 2 3
4 5 6 7
Weergave en beschrijving
Activiteit Controle geldigheid certificaat en integriteit Controleren elementen
Input SOAP-aanleverbericht
Vergelijking KvK nr. van aanleveraar is gelijk aan KvK nr. van request-certificaat Controleren mededelingverzoek Controleren aanwezigheid kenmerk Controleren validiteit berichtsoort/bedrijfsnummer Registreren resultaat in
KvK nummers
Output Juiste koppelvlakspecificatie of MDS130 Juiste koppelvlakspecificatie of MDS100 Vastgestelde overeenkomst
Inhoud verzoek
Vastgesteld type verzoek
kenmerk
Bestaand kenmerk of SOAPfault MDS300 Bestaand berichtsoort of SOAP-fault MDS100 Geregistreerd resultaat, met
SOAP-aanleverbericht
Berichtsoort / bedrijfsnummer Resultaat, kenmerk
Pagina 35 van 46
audittrail
tijdstempel
Activiteit 1: Controle geldigheid certificaat en integriteit Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: het certificaat en de signature. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault MDS130 Bestaansreden Voordat het bericht aangeleverd wordt de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken Activiteit 2: Controleren elementen Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: de invulling van elementen in het bericht. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault MDS100 Bestaansreden Voordat het bericht aangeleverd wordt de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken Activiteit 3: Vergelijking Kvk nr. Default flow De service vergelijkt het Kvk nr van het request certificaat met het Kvk nummer van de oorspronkelijke aanleveraar van het bericht. Bestaansreden Hiermee wordt voorkomen dat er mededelingen of statussen worden opgevraagd door partijen die niet het oorspronkelijke bericht hebben aangeleverd. Activiteit 4: Controleren mededelingverzoek Default flow De mededelingenservice controleert het mededelingverzoek en bepaalt of het type a,b,c of d-verzoek betreft. Indien het type a of d betreft gaat het proces verder volgens de default flow. Indien het type b of c betreft gaat het proces verder met activiteit 7 'controleren validiteit berichtsoort/bedrijfsnummer'. Bestaansreden Het type verzoek kan op basis van kenmerk of op basis van specifiek berichtsoort plaatsvinden, die allebei op een andere manier gecontroleerd moeten worden. Om
Pagina 36 van 46
deze reden controleert de mededelingenservice welk type het is om te bepalen welk type controle noodzakelijk is. Activiteit 5: Controleren aanwezigheid kenmerk Default flow De mededelingenservice controleert of het kenmerk bekend is. Indien dit het geval is gaat het proces verder. Alternative flow Indien de mededelingenservice het kenmerk niet kan terugvinden, volgt een SOAPfault MDS300. Bestaansreden Een type verzoek a of d moet een geldig kenmerk bezitten, om mededelingen hirebij op te zoeken. Activiteit 6: Controleren validiteit berichtsoort en bedrijfsnummer Default flow Indien de aanvraag op type b of c (berichtsoort en bedrijfsnummer) plaatsvindt, controleert de mededelingenservice of het berichtsoort bestaat. Indien dit bekend is gaat het proces verder. Alternative flow Indien het berichtsoort en bedrijfsnummer onbekend is volgt een SOAP-fault MDS100. Bestaansreden Een type verzoek b of c moet een geldige berichtsoort en bedrijfsnummer bezitten, om mededelingen hierbij op te zoeken. Activiteit 7: Registreren resultaat in audittrail Default flow De mededelingenservice registreert een tijdsstempel, een verwijzing naar het certificaat waarmee het verzoek is opgevraagd en een verwijzing naar de opgevraagde mededeling in de audittrail. Bestaansreden Hiermee is elke mededelingverzoek dat behandeld is door de mededelingenservice geregistreerd en herleidbaar in de audittrail.
9.5 9.5.1
Statusservice Functionaliteit en werking
De statusservice verwerkt een statusinformatieverzoek. De service controleert ook of de opvrager van het verzoek ook de oorspronkelijke aanleveraar van het bericht was. Het controleert het type verzoek op basis van het kenmerk of het berichtsoort en verstuurt een bericht bij een geldig verzoek. De volgende typen verzoek zijn mogelijk.
Pagina 37 van 46
a) Geeft de statussen die bij een bepaald proces hoort. b) Geeft alle statussen van het gegeven proces, die nog niet eerder bij dit certificaat opgehaald zijn (alle statussen waarmee voor het betreffende kenmerk en het meegegeven certificaat nog geen relatie is vastgelegd.) c) Geeft alle statussen voor het gegeven bedrijf die nog niet eerder bij dit certificaat opgehaald zijn (alle statussen waarmee voor het betreffende bedrijfsnummer en het meegegeven certificaat nog geen relatie is vastgelegd). Tevens kan een bedrijf alle processen en alle relevante berichtsoorten aan de hand van de volgende SOAP-requests opvragen: d) Geeft alle processen voor een bepaald bedrijf met een specifiek berichtsoort. De processen die aangemaakt zijn voor een algemene mededeling worden niet teruggegeven. e) Geeft alle berichtsoorten waarin een bepaald bedrijf verantwoordingsinformatie heeft verstuurd. 9.5.2
1 2 3
4 5 6 7 8
Weergave en beschrijving
Activiteit Controle geldigheid certificaat en integriteit Controleren elementen
Input SOAP-aanleverbericht
Vergelijking KvK nr. van aanleveraar is gelijk aan KvK nr. van request-certificaat Controleren statusinformatieverzoek Controleren aanwezigheid kenmerk Controleren validiteit bedrijfsnummer Controleren validiteit berichtsoort Registreren resultaat in audittrail
KvK nummers
Output Juiste koppelvlakspecificatie of MDS130 Juiste koppelvlakspecificatie of MDS100 Vastgestelde overeenkomst
Inhoud verzoek
Vastgesteld type verzoek
kenmerk
Bestaand kenmerk of SOAP-fault STS300 Bestaand bedrijfsnummer of SOAP-fault STS100 Bestaand berichtsoort of SOAPfault STS100 Geregistreerd resultaat, met tijdstempel
SOAP-aanleverbericht
Berichtsoort Berichtsoort Resultaat, kenmerk
Pagina 38 van 46
Activiteit 1: Controle geldigheid certificaat en integriteit Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: het certificaat en de signature. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault MDS130 Bestaansreden Voordat het bericht aangeleverd wordt de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken Activiteit 2: Controleren elementen Default flow De aanleverservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties: de invulling van elementen in het bericht. Indien het SOAP-bericht voldoet vervolgt de aanleverservice de controleactiviteiten. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt er een SOAP-fault MDS100 Bestaansreden Voordat het bericht aangeleverd wordt de ontvangende partij, wordt gekeken of de ontvangende partij het bericht überhaupt kan verwerken Activiteit 3: Vergelijking Kvk nr. Default flow De service vergelijkt het Kvk nr van het request certificaat met het Kvk nummer van de oorspronkelijke aanleveraar van het bericht. Bestaansreden Hiermee wordt voorkomen dat er mededelingen of statussen worden opgevraagd door partijen die niet het oorspronkelijke bericht hebben aangeleverd. Activiteit 4: Controleren statusinformatieverzoek Default flow De statusservice controleert het statusinformatieverzoek en bepaalt of het type a,b, c, d of e-verzoek betreft. Indien het type a of b betreft gaat het proces verder volgens de default flow. Indien het type c, d, of e betreft gaat het proces verder met activiteit 7 'controleren validiteit bedrijfsnummer. Bestaansreden Het type verzoek kan op basis van kenmerk of op basis van specifiek berichtsoort plaatsvinden, die allebei op een andere manier gecontroleerd moeten worden. Om deze reden controleert de statusservice welk type het is om te bepalen welk type controle noodzakelijk is.
Pagina 39 van 46
Activiteit 5: Controleren aanwezigheid kenmerk Default flow De statusservice controleert of het kenmerk bekend is. Indien dit het geval is gaat het proces verder. Alternative flow Indien de statusservice het kenmerk niet kan terugvinden, volgt een SOAP-fault STS300. Bestaansreden Een type verzoek a of b moet een geldig kenmerk bezitten, om de status hierbij op te zoeken. Activiteit 6: Controleren validiteit bedrijfsnummer Default flow Indien de aanvraag op type c, d of e (bedrijfsnummer) plaatsvindt, controleert de statusservice of het bedrijfsnummer bestaat. Indien dit bekend is gaat het proces verder. Alternative flow Indien het berichtsoort onbekend is volgt een SOAP-fault STS100. Bestaansreden Een type verzoek c, d, of e moet een geldige bedrijfsnummer bezitten, om de status hierbij op te zoeken. Activiteit 7: Controleren validiteit berichtsoort Default flow Indien de aanvraag op type c of d (berichtsoort) plaatsvindt, controleert de statusservice of het berichtsoort bestaat. Indien dit bekend is gaat het proces verder. Alternative flow Indien het berichtsoort onbekend is volgt een SOAP-fault STS100. Bestaansreden Een type verzoek c moet een geldige berichtsoort bezitten, om de status hierbij op te zoeken. Activiteit 8: Registreren resultaat in audittrail Default flow De statusservice registreert een tijdsstempel, een verwijzing naar het certificaat waarmee het verzoek is opgevraagd en een verwijzing naar de opgevraagde status in de audittrail. Bestaansreden Hiermee is elke statusinformatieverzoek dat behandeld is door de statusservice geregistreerd en herleidbaar in de audittrail.
Pagina 40 van 46
9.6
Ophalen statusinformatie/mededeling informatie
9.6.1
Functionaliteit en werking
Deze service haalt de juiste gegevens op, op basis van het eerder geïdentificeerde type verzoek. 9.6.2
1 2
Weergave en beschrijving
Activiteit Ophalen statusinformatie of mededeling(en) Registreren resultaat in audittrail
Input kenmerk of bedrijfsnummer. Resultaat, kenmerk
Output Statusinformatie of mededeling(en) Geregistreerd resultaat, met tijdstempel
Activiteit 1: Ophalen statusinformatie of mededeling(en) Default flow Ophalen statusinformatie of mededeling uit database doormiddel van een query op basis van het kenmerk of het meegegeven bedrijfsnummer. Bestaansreden De statusinformatie of medelingen waarom verzocht wordt dienen geïdentificeerd te worden. Activiteit 2: Registreren resultaat in audittrail Default flow De service registreert het resultaat in de audittrail van het kenmerk, of de verschillende kenmerken, waar het verzoek betrekking op heeft, dat de informatie geïdentificeerd is voor uitlevering met een tijdsstempel. Bestaansreden Hiermee is elk verzoek dat behandeld is door deze service geregistreerd en herleidbaar in de audittrail.
Pagina 41 van 46
9.7 9.7.1
Bezorgservice Functionaliteit en werking
De bezorgservice voert een serie controles uit om te bepalen dat een bericht aan de vereiste kwaliteitscriteria voldoet en dat het bericht aan de juiste partij verzonden wordt. 9.7.2
Weergave en beschrijving
1
Activiteit Controle conformiteit koppelvlak
Input SOAP-bericht
2
Controle berichtsgrootte
SOAP-bericht
3
Controleren validiteit berichtsoort
SOAP-bericht
4
Controleren aanwezigheid kenmerk en bedrijfsnummer
SOAP-bericht
5 6
Registreren mededeling Registreren resultaat in audittrail
Mededeling en bezorgkenmerk Resultaat, ID-mededeling en kenmerk
Output Juiste koppelvlakspecificatie of BZG100 Juiste berichtgrootte BZG110 Valide berichtsoort BZG140 Aanwezig kenmerk en bedrijfsnummer BZG 150/160 Geregistreerde mededeling Geregistreerd resultaat, met tijdstempel
Activiteit 1: Controleer conformiteit koppelvlak Default flow De bezorgservice controleert of het SOAP-bericht voldoet aan de koppelvlakspecificaties. Indien het voldoet gaat het proces verder. Alternative flow Wanneer de koppelvlakspecificaties onjuist zijn volgt een SOAP-fault BZG100.
Pagina 42 van 46
Bestaansreden Voordat het bericht verwerkt wordt, wordt gekeken of de bezorgservice het bericht kan verwerken. Activiteit 2: Controle berichtgrootte Default flow De aanleverservice controleert of de omvang van het aangeleverde bericht, voordat de base64 conversie plaatsvindt, kleiner of gelijk is aan 20 MB. Doordat een bericht na base64 conversie in omvang toe kan nemen en de feitelijke controle na deze conversie plaatsvindt, wordt er bij de controle rekening gehouden met de relatieve toename in berichtgrootte Alternative flow Indien de verantwoordingsinformatie groter is dan 20 MB, volgt een SOAP-fault BZG110. Bestaansreden Deze limiet voor berichtgrootte is gemaakt om te voorkomen dat foutieve berichten voor vertragingen zorgen bij andere aanleveraars. Activiteit 3: Controleren validiteit van berichtsoort Default flow De bezorgservice controleert of de berichtsoort in het bezorgenverzoek voldoet aan de specificaties in het "berichtsoorten" document. Indien dit inderdaad klopt gaat het proces verder met de volgende controle. Alternative flow Indien dit niet het geval is volgt een SOAP-fault BZG140. Bestaansreden Omdat er berichten voor meerdere partijen binnenkomen is het noodzakelijk te bepalen welk bericht voor welke partij is. Activiteit 4: Controleren aanwezigheid kenmerk Default flow De bezorgservice controleert of het kenmerk en bedrijfsnummer bekend zijn in de Digipoort en of zij aan elkaar gerelateerd zijn. Alternative flow Indien dit het geval is volgt een SOAP-fault BZG150 of BZG160. Bestaansreden Er kunnen alleen mededelingen bezorgd worden die gerelateerd zijn aan een kenmerk dat bekend is in Digipoort. Activiteit 5: Registreren mededeling Default flow
Pagina 43 van 46
De bezorgservice registreert bij het betreffende kenmerk de volgende gegevens in de database: berichtsoort, bedrijfsnummer, bezorgkenmerk en berichtinhoud. Bestaansreden Het bezorgenkenmerk is het kenmerk dat door de uitvragende partij aan de mededeling is
toegekend. Activiteit 6: Registreren resultaat in audittrail Default flow De bezorgservice registreert het resultaat en een tijdsstempel. Bestaansreden Hiermee is elke mededeling die behandeld is door de bezorgservice geregistreerd en herleidbaar in de audittrail.
9.8
Validatieservice
9.8.1
Functionaliteit en werking
Deze service voert een aantal validaties uit op het bericht 9.8.2
Weergave en beschrijving
1
Activiteit Constateren UBL/ HRXML
2 3
XSD validaties Schematron
4
Registreren resultaat in audittrail
Input Bericht waarvan UBL of HRXML nog onbekend is XSD-Ongevalideerd bericht Ongevalideerd bericht op Schematron regels Resultaat, kenmerk
Activiteit 1: Constateren UBL/ HRXML Default flow Het bericht wordt geidentificeerd als UBL of HRXML bericht.
Pagina 44 van 46
Output UBL of HRXML geïdentificeerd bericht XSD gevalideerde berichten Gevalideerd bericht op Schematron regels Geregistreerd resultaat, met tijdstempel
Bestaansreden Deze differentiatie is noodzakelijk om de juiste XSD-validatie te kunnen uitvoeren Activiteit 2: XSD validatie Default flow De service valideert op XSD specificaties Bestaansreden Hiermee is elk verzoek gevalideerd op XSD.
Activiteit 3: Schematron Default flow De service valideert op Schematron-regels Bestaansreden Hiermee is elk verzoek gevalideerd op Schematron-regels.
Activiteit 4: Registreren resultaat in de audit-trail Default flow De service registreert het resultaat in de audittrail van het kenmerk, of de verschillende kenmerken, waar het verzoek betrekking op heeft, dat de informatie geïdentificeerd is voor uitlevering met een tijdsstempel. Bestaansreden Hiermee is elk verzoek dat behandeld is door deze service geregistreerd en herleidbaar in de audittrail.
9.9 9.9.1
Mail transfer agent Functionaliteit en werking
Deze service is een alternatief binnen de afleverservice waarbij het bericht per mail aan de overheid wordt verstuurd door Digipoort. 9.9.2
Weergave en beschrijving
Pagina 45 van 46
1 2 3
Activiteit Verzenden email aan ontvangende partij Ontvangen email Ontvangen bevestiging
Input Email met bericht Ontvangen van email Bevestiging van overheid aan digipoort
Output Verzonden email aan de mail transfer agent van de overheid Ontvangen email bij de overheid Ontvangstbevestiging van de overheid
Activiteit 1: Verzenden email aan ontvangende partij Default flow Een email wordt verzonden door de digipoort met het bericht aan de overheid. Bestaansreden Alternatief wat gewenst is door de betrokken partijen voor hen die dit niet via WUS koppelvlakken doen. Activiteit 2: Ontvangen email Default flow De overheid ontvangt in haar mail transfer agent het emailbericht van de mail transfer agent van digipoort Bestaansreden Alternatief wat gewenst is door de betrokken partijen voor hen die dit niet via WUS koppelvlakken doen.
Activiteit 3: Ontvangen bevestiging Default flow De overheid levert een ontvangstbevestiging aan de mail transfer agent van Digipoort. Dit gebeurt op basis van de standaard bevestiging in het SMTP protocol. Bestaansreden Alternatief wat gewenst is door de betrokken partijen voor hen die dit niet via WUS koppelvlakken doen.
Pagina 46 van 46