diff --git a/02_documentbeheer.md b/02_documentbeheer.md
index b6aca8a..6e04d48 100644
--- a/02_documentbeheer.md
+++ b/02_documentbeheer.md
@@ -1,10 +1,11 @@
# Documentbeheer
-| Datum | Versie | Auteur | Opmerkingen |
-|------------|--------|--------|-------------|
-| 22-11-2011 | 1.5 | Logius | - |
-| 09-06-2014 | 1.6 | Logius | Redactioneel bijwerken |
-| 13-01-2015 | 3.0 | Logius | Redactioneel |
+| Datum | Versie | Auteur | Opmerkingen |
+|------------|--------|--------|-----------------------------------------------------------------------------|
+| 22-11-2011 | 1.5 | Logius | - |
+| 09-06-2014 | 1.6 | Logius | Redactioneel bijwerken |
+| 13-01-2015 | 3.0 | Logius | Redactioneel |
| 01-10-2017 | 3.1 | Logius | Herzien nav: - Compliance Voorziening - Begrippen ebMS2 en CPA Register |
-| 16-05-2019 | 3.2 | Logius | EB015 SyncReply toegevoegd |
-| 11/04/2022 | 3.2.1 | Logius | Vermelding REST-API koppelvlak |
+| 16-05-2019 | 3.2 | Logius | EB015 SyncReply toegevoegd |
+| 11-04-2022 | 3.2.1 | Logius | Vermelding REST-API koppelvlak |
+| 31-05-2023 | 3.2.2 | Logius | Update 2023 conform Roadmap Digikoppeling, review |
diff --git a/03_colofon.md b/03_colofon.md
index fc7050f..36086fc 100644
--- a/03_colofon.md
+++ b/03_colofon.md
@@ -3,3 +3,4 @@
| | |
|---|---|
| Logius Servicecentrum: | Postbus 96810 2509 JE Den Haag tel. 0900 555 4555 (10 ct p/m) email servicecentrum@logius.nl |
+| Logius Afdeling Standaarden: | email. digikoppeling@logius.nl |
diff --git a/ch01_Inleiding.md b/ch01_Inleiding.md
index 9253ec0..3d30856 100644
--- a/ch01_Inleiding.md
+++ b/ch01_Inleiding.md
@@ -1,4 +1,5 @@
# Inleiding
+
## Doel en doelgroep
Alle Digikoppeling profielen die op ebMS2 gebaseerd zijn, moeten zich conformeren aan de Koppelvlakstandaard ebMS2. Dit document is een aanvulling hierop. Het heeft als doel ontwikkelaars te adviseren en te informeren over de huidige werkwijze bij het toepassen van Digikoppeling Koppelvlakstandaard ebMS2 – deze informatie geldt dus alleen voor de ebMS2-variant.
@@ -16,10 +17,8 @@ Het document is bestemd voor Architecten, integratie specialisten en ontwikkelaa
Digikoppeling is beschreven in een set van documenten. Deze set is als volgt opgebouwd:
-
-
Tekstalternatief
@@ -86,26 +85,27 @@ Digikoppeling biedt de mogelijkheid om op deze gestandaardiseerde wijze berichte
De uitwisseling tussen partijen is in drie lagen opgedeeld:
-- Inhoud (gegevens): deze laag bevat afspraken over de inhoud van het uit te wisselen bericht, dus de structuur, semantiek en waardebereiken
- Digikoppeling houdt zich niet met de inhoud bezig, ' heeft geen boodschap aan de boodschap'.
+1. Inhoud (gegevens): deze laag bevat afspraken over de inhoud van het uit te wisselen bericht, dus de structuur, semantiek en waardebereiken
+Digikoppeling houdt zich niet met de inhoud bezig, '_heeft geen boodschap aan de boodschap_'.
-- Logistiek (processen): op deze laag bevinden zich de afspraken betreffende transportprotocollen (HTTP/TLS), messaging (SOAP), adressering, beveiliging (authenticatie en encryptie) en betrouwbaarheid. Dit is laag van Digikoppeling.
+2. Logistiek (processen): op deze laag bevinden zich de afspraken betreffende transportprotocollen (HTTP/TLS), messaging (SOAP), adressering, beveiliging (authenticatie en encryptie) en betrouwbaarheid. Dit is laag van Digikoppeling.
-- Transport (techniek): deze laag verzorgt het daadwerkelijke transport van het bericht (TCP/IP).
+3. Transport (techniek): deze laag verzorgt het daadwerkelijke transport van het bericht (TCP/IP).
-Digikoppeling richt zich uitsluitend op de logistieke laag.
+> Digikoppeling richt zich uitsluitend op de logistieke laag.
## Opbouw van dit document
-Hoofdstuk 1 bevat een aantal algemene inleidende onderwerpen.
-
-Hoofdstuk 2 bevat de aanbevelingen, werkwijze en best practices.
+[Hoofdstuk 1 bevat een aantal algemene inleidende onderwerpen.](#inleiding)
-Hoofdstuk 3 gaat in op de kenmerken van een CPA.
+[Hoofdstuk 2 bevat de aanbevelingen, werkwijze en best practices.](#werkwijze-aanbevelingen-best-practices)
-Hoofdstuk 4 gaat over bericht volgordelijkheid.
+[Hoofdstuk 3 gaat in op de kenmerken van een CPA.](#cpa-gebruik-en-kenmerken)
-Begrippen en afkortingen worden toegelicht in het document “DigikoppelingArchitectuur”. Deze zit in de Digikoppeling standaard.
+[Hoofdstuk 4 gaat over bericht volgordelijkheid.](#het-gebruik-van-berichtvolgordelijkheid)
-Dit document en andere documentatie is beschikbaar op [www.logius.nl/digikoppeling](http://www.logius.nl/digikoppeling).
+> Begrippen en afkortingen worden toegelicht in het document [[Digikoppeling-Architectuur]].
+> Dit document is onderdeel van de Digikoppeling standaard.
+
Dit document en alle andere Digikoppeling documentatie is beschikbaar op [de website van Logius](http://www.logius.nl/digikoppeling).
+
diff --git a/ch02_WerkwijzeAanbevelingenBest Practices.md b/ch02_WerkwijzeAanbevelingenBest Practices.md
index 75b8cef..8f6c67a 100644
--- a/ch02_WerkwijzeAanbevelingenBest Practices.md
+++ b/ch02_WerkwijzeAanbevelingenBest Practices.md
@@ -2,7 +2,7 @@
## EB001 ebMS2 Producten
-Gebruik een ebMS2 product met aantoonbare ervaring binnen het Digikoppeling domein. Op de website van Logius is een overzicht van Digikoppeling leveranciers te vinden en ook in de marktscan van KING en Logius is een overzicht te vinden van het aanbod van Digikoppeling adapters dat voldoet aan de eisen die KING stelt aan een Digikoppeling Adapter voor de gemeentelijke markt.
+Gebruik een ebMS2 product met aantoonbare ervaring binnen het Digikoppeling domein. Op de [website van Logius is een overzicht van Digikoppeling leveranciers](https://logius.nl/domeinen/gegevensuitwisseling/digikoppeling/ict-leveranciers) te vinden. De [GEMMA softwarecatalogus](https://www.softwarecatalogus.nl/pakketten?zoek=digikoppeling+ebms) van de VNG geeft een overzicht van softwareproducten voor de gemeentelijke markt die de Digikoppeling ebMS koppelvlakspecificatie ondersteunen.
## EB002 CPA Gebruik
@@ -10,9 +10,9 @@ Voor het definiëren van een CPA geldt het volgende advies:
1. Raadpleeg het hoofdstuk 3 'CPA Gebruik en Kenmerken'.
-1. Maak gebruik van het online CPA Register1, zie document 'Digikoppeling CPA Creatie Handleiding'.
+1. Maak gebruik van het online CPA Register1, zie het [CPA Register gebruikershandleiding](https://www.logius.nl/domeinen/gegevensuitwisseling/digikoppeling/documentatie/cpa-register-gebruikershandleiding)
-1: Het online CPA Register wordt gehost door Justid en is beschikbaar op [https://cparegister.minvenj.nl/logius](https://cparegister.minvenj.nl/logius)
+> 1. Het online CPA Register wordt gehost door Justid en is beschikbaar op [https://cparegister.minvenj.nl/logius](https://cparegister.minvenj.nl/logius)
## EB003 Productie- en ontwikkelomgevingen
@@ -32,7 +32,7 @@ Voorzie de PartyId van een postfix voor het onderscheid tussen test- en producti
Samenstellingen zijn ook mogelijk, bijvoorbeeld de postfix ‘_OTA’ als er één specifiek adres gebruikt wordt voor de ontwikkel-, test-, en acceptatieomgeving. Aangezien Digikoppeling een strikte scheiding tussen test en productie nastreeft zou een combinatie van productie met andere omgevingen nooit moeten voorkomen2.
-2: De scheiding komt ook. tot uitdrukking in het gebruik van een andere certificaat-root voor productie en andere omgevingen. Zie hiervoor het document “Gebruik en achtergrond Digikoppeling-certificaten”.
+> 2. De scheiding komt ook. tot uitdrukking in het gebruik van een andere certificaat-root voor productie en andere omgevingen. Zie hiervoor het document “Gebruik en achtergrond Digikoppeling-certificaten”.
## EB005 Certificaten
@@ -116,6 +116,8 @@ Laat de start- en einddatum van de CPA mede afhangen van de geldigheid van de ge
Een CPA voor testdoeleinden kan een korte geldigheidsperiode krijgen, afgestemd op de test periode.
+Een geldigheidsperiode langer dan 10 jaar is niet gebruikelijk.
+
## EB011 MessageOrder en ConversationId
Als de MessageOrder functionaliteit gebruikt wordt, moeten alle betreffende (samenhangende) berichten dezelfde ConversationId krijgen.
@@ -128,7 +130,7 @@ Als MessageOrder gebruikt wordt is dit van invloed op de overdrachtskarakteristi
## EB013 MessageId
-De Koppelvlakstandaard ebMS2 schrijft het gebruik van een MessageId voor conform RFC2822, in de vorm van “[UUID@URI](mailto:UUID@URI)”.
+De Koppelvlakstandaard ebMS2 schrijft het gebruik van een MessageId voor conform [[RFC2822]], in de vorm van “[UUID@URI](mailto:UUID@URI)”.
De URI in de MessageId kan ook het domein kan zijn van Digikoppeling messagehandler.
@@ -142,7 +144,7 @@ Het is toegestaan om op transport niveau het cliënt certificaat te gebruiken vo
Het Digikoppeling ebMS2 Reliable Messaging (RM) profiel vereist dat berichten bevestigd worden met een *acknowledgement* bericht. Binnen het Digikoppeling ebMS2 RM-profiel moet deze acknowledgement *asynchroon* worden verzonden. Een Digikoppeling oplossing houdt hiervoor een administratie bij zodat de acknowledgement aan het initiële *MessageId* van het bericht kan worden kan worden gerefereerd
-Bij het gebruik van het uitwisselen van zeer hoge volumes van berichten in beperkte tijd via het Digikoppeling ebMS RM-profiel *kan* de overhead van het asynchroon bevestigen van het bericht via asynchrone acknowledgement (te) groot worden. Vandaar dat sinds versie 3.3 van dit profiel het gebruik van SyncReply Profile in de Digikoppeling ebMS2 Specificatie wordt toegestaan voor een aantal uitzonderingsgevallen. Vanaf deze versie is het in bepaalde gevallen mogelijk om een bericht synchroon – dus in dezelfde http-sessie- te bevestigen met een acknowledgement (of een foutsituatie synchroon te beantwoorden met een *errormessage*)
+Bij het gebruik van het uitwisselen van zeer hoge volumes van berichten in beperkte tijd via het Digikoppeling ebMS RM-profiel *kan* de overhead van het asynchroon bevestigen van het bericht via asynchrone acknowledgement (te) groot worden. Vandaar dat sinds versie 3.3 van dit profiel het gebruik van SyncReply Profile in de Digikoppeling ebMS2 specificatie wordt toegestaan voor een aantal uitzonderingsgevallen. Vanaf deze versie is het in bepaalde gevallen mogelijk om een bericht synchroon – dus in dezelfde http-sessie- te bevestigen met een acknowledgement (of een foutsituatie synchroon te beantwoorden met een *errormessage*)
**Toepassen van Synchrone acknowledgement is uitzondering**
@@ -150,19 +152,22 @@ Het gebruik van Syncreply wordt in de regel afgeraden. Tot aan versie 3.3 van Di
In de praktijk blijkt dat er toch situaties bestaan waarin het synchroon bevestigen van een bericht voordeel biedt:
-Casusbeschrijving
+
### Voorwaarden voor toepassen van het synchrone bevestiging
-- Scope: Dit profiel is alleen geldig voor de Digikoppeling ebMS2 RM-profielen
-
-- Aanleiding: Door omvang van het volume van uitwisseling van berichten in beperkte tijd bestaan verwerkingsproblemen bij (een van beide) providers. Asynchrone uitwisseling van berichten binnen het ebMS profiel blijft de defaultmodus. Dus als de verwerking probleemloos verloopt is er geen reden om over te gaan op synchrone uitwisseling.
-
-- Voorwaarde: De Digikoppeling oplossing van beide partijen ondersteunen het instellen van SyncReplymode op mshSignalsOnly. Het instellen van deze mode kan dus niet eenzijdig worden opgelegd.
+- Scope:
+ - Dit profiel is alleen geldig voor de Digikoppeling ebMS2 RM-profielen
+- Aanleiding:
+ - Door omvang van het volume van uitwisseling van berichten in beperkte tijd bestaan verwerkingsproblemen bij (een van beide) providers. Asynchrone uitwisseling van berichten binnen het ebMS profiel blijft de defaultmodus. Dus als de verwerking probleemloos verloopt is er geen reden om over te gaan op synchrone uitwisseling.
+- Voorwaarde:
+ - De Digikoppeling oplossing van beide partijen ondersteunen het instellen van SyncReplymode op mshSignalsOnly. Het instellen van deze mode kan dus niet eenzijdig worden opgelegd.
-- Client Authentication over HTTP met client certificaat. Dit is verplicht. In het client certificaat staat in het subject.Serialnumber de PartyId van de ‘client’ organisatie.
+### Client Authentication over HTTP met client certificaat.
-- Endpoint
+Dit is verplicht. In het client certificaat staat in het subject.Serialnumber de PartyId van de ‘client’ organisatie.
- Deze heeft de waarde van de URL (FQDN, met pad namen) van de ebMS-adapter waarmee over Digikoppeling gegevens uitgewisseld worden. De FQDN van de URL moet overeenkomen met de FQDN die in het server certificaat vermeld staat.
+### Endpoint
-- MessageOrder
+Deze heeft de waarde van de URL (FQDN, met pad namen) van de ebMS-adapter waarmee over Digikoppeling gegevens uitgewisseld worden. De FQDN van de URL moet overeenkomen met de FQDN die in het server certificaat vermeld staat.
- De MessageOrder geeft aan of er wel of geen gebruik gemaakt wordt van ordening van berichten. De default waarde voor MessageOrder is “NotGuaranteed” en wordt als volgt opgenomen in het ebMS2 contract:
+### MessageOrder
- ```XML
- NotGuaranteed
- ```
+De MessageOrder geeft aan of er wel of geen gebruik gemaakt wordt van ordening van berichten. De default waarde voor MessageOrder is “NotGuaranteed” en wordt als volgt opgenomen in het ebMS2 contract:
+
+```XML
+ NotGuaranteed
+```
- Indien er wel gebruik gemaakt wordt van MessageOrder is de waarde:
+Indien er wel gebruik gemaakt wordt van MessageOrder is de waarde:
- ```XML
- Guaranteed
- ```
+```XML
+ Guaranteed
+```
-- ReliableMessaging
+### ReliableMessaging
- Deze heeft default een retryCount van 8 en een retryInterval van 3 uur, zonder MessageOrder:
+Deze heeft default een retryCount van 8 en een retryInterval van 3 uur, zonder MessageOrder:
- ```XML
-
- ```
+```XML
+
+```
- De waardes kunnen per CPA bepaald worden, en liggen dus niet bij voorbaat vast.
+De waardes kunnen per CPA bepaald worden, en liggen dus niet bij voorbaat vast.
- In het geval dat MessageOrder wel gebruikt wordt, komt in de CPA:
+In het geval dat MessageOrder wel gebruikt wordt, komt in de CPA:
- Guaranteed
+Guaranteed
- Conform de ebMS2 specificatie zal de applicatie dezelfde ConversationId moeten gebruiken voor de opeenvolgende berichten5.
+Conform de ebMS2 specificatie zal de applicatie dezelfde ConversationId moeten gebruiken voor de opeenvolgende berichten5.
- 5: [[EBXML-MSG]] H9.1.1 “The REQUIRED SequenceNumber element indicates the sequence a Receiving MSH MUST process messages. The SequenceNumber **is unique within** the ConversationId and MSH.”
+> 5. [[EBXML-MSG]] H9.1.1 “The REQUIRED SequenceNumber element indicates the sequence a Receiving MSH MUST process messages. The SequenceNumber **is unique within** the ConversationId and MSH.”
-- PersistDuration
+### PersistDuration
- Deze heeft default de waarde van 1 dag, maar zal anders zijn als er andere waardes voor ReliableMessaging gebruikt worden:
+Deze heeft default de waarde van 1 dag, maar zal anders zijn als er andere waardes voor ReliableMessaging gebruikt worden:
- ```XML
- P1D
- ```
+```XML
+P1D
+```
-- MessagingCharacteristic
+### MessagingCharacteristic
- Deze heeft de waarde:
+Deze heeft de waarde:
- ```XML
-
- ```
+tns:duplicateElimination="always"/>
+```
+
+Geen gebruik van Signing of (payload) Encryption. (Alleen op HTTP nivo wordt informatie beveiligd)
- Geen gebruik van Signing of (payload) Encryption. (Alleen op HTTP nivo wordt informatie beveiligd)
+### Certificaten
- Er moet gebruik gemaakt worden van certificaten die voldoen aan de eisen van de PKI Overheid.
+Er moet gebruik gemaakt worden van certificaten die voldoen aan de eisen van de PKI Overheid.
## Hoe wordt een CPA gemaakt?
diff --git a/ch05_Message Ordering in ebXML.md b/ch05_Message Ordering in ebXML.md
index 7d505d5..8b9f4f4 100644
--- a/ch05_Message Ordering in ebXML.md
+++ b/ch05_Message Ordering in ebXML.md
@@ -1,24 +1,23 @@
-# Message Ordering in ebXML
+## Message Ordering in ebXML
Een onderdeel van de ebMS 2.0 specificatie is de volgordelijkheid van berichten, aangeduid met MessageOrder. overgenomen uit hoofdstuk 9 van [[EBXML-MSG]]
-## MessageOrder Module**
+### MessageOrder Module**
-The MessageOrder module allows messages to be presented to the To Party in a particular order. This is accomplished through the use of the MessageOrder element. Reliable Messaging MUST be used when a MessageOrder element is present.
+> The MessageOrder module allows messages to be presented to the To Party in a particular order. This is accomplished through the use of the MessageOrder element. Reliable Messaging MUST be used when a MessageOrder element is present.
+> MessageOrder module MUST only be used in conjunction with the ebXML Reliable Messaging Module (section 6) with a scheme of Once-And-Only-Once (sections 6.6). If a sequence is sent and one message fails to arrive at the To Party MSH, all subsequent messages will also fail to be presented to the To Party Application (see status attribute section 9.1.1).
-MessageOrder module MUST only be used in conjunction with the ebXML Reliable Messaging Module (section 6) with a scheme of Once-And-Only-Once (sections 6.6). If a sequence is sent and one message fails to arrive at the To Party MSH, all subsequent messages will also fail to be presented to the To Party Application (see status attribute section 9.1.1).
+### MessageOrder Element**
-## MessageOrder Element**
-
-The MessageOrder element is an OPTIONAL extension to the SOAP Header requesting the preservation of message order in this conversation.
+> The MessageOrder element is an OPTIONAL extension to the SOAP Header requesting the preservation of message order in this conversation.
De ebMS standaard biedt daarmee de mogelijkheid om de volgordelijkheid van berichten te garanderen.
-Maar het is wel een OPTIONAL7 element, dus bekijk per product of het ook daadwerkelijk ondersteund wordt.
+Maar het is wel een OPTIONAL6 element, dus bekijk per product of het ook daadwerkelijk ondersteund wordt.
-7: OPTIONAL, uit [[EBXML-MSG]]: “This word means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item.”
+> 6. OPTIONAL, uit [[EBXML-MSG]]: “This word means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item.”
-## Productondersteuning
+### Productondersteuning
De ondersteuning voor de MessageOrder verschilt per product. Hermes 2.0 en OrionMsg ondersteunen het wel, AxWay ondersteunt het niet, en de recente IBM release 'WebSphere Partner Gateway V6.1' ondersteunt het wel.
@@ -28,7 +27,7 @@ Uit het test rapport van de Drummond Group, blz 18, hoofdstuk “Differing inter
> (..) The ebMS v2.0 specification requires that ConversationId be present in all messages, and requires that if you implement the optional MessageOrdering feature (not tested by DGI) that ConversationId must stay the same over all ordered messages. (..)
-## Zelfbouwoverwegingen
+### Zelfbouwoverwegingen
Als het niet mogelijk is om de MessageOrder functionaliteit te gebruiken, kan zelfbouw overwogen worden. Het is wel raadzaam om een aantal aspecten in overweging te nemen voordat de implementatie van de volgordelijkheid in een applicatie opgepakt wordt.
@@ -48,11 +47,11 @@ Als het niet mogelijk is om de MessageOrder functionaliteit te gebruiken, kan ze
- Het inregelen van dit proces is lastig en het is dan de vraag of een andere oplossing (zoals met bevestigingsberichten) een goed alternatief is.
-## Ontwerp Pattern
+### Ontwerp Pattern
Als uitgangspunt voor de realisatie van de volgordelijkheid kan het Resequencer patroon gebruikt worden: [http://www.enterpriseintegrationpatterns.com/Resequencer.html](http://www.enterpriseintegrationpatterns.com/Resequencer.html)
----
+
De oplossingsrichtingen voor berichten waarvoor een volgnummer van belang is wordt hieronder globaal beschreven. Er wordt uitgegaan van een 'push' mechanisme: de ontvangende applicatie wordt dus actief doordat de ebMS adapter een functie van de applicatie aanroept voor het afleveren van een bericht (bijvoorbeeld met behulp van een web service of JMS queue). Dit in tegenstelling tot een 'pull' mechanisme waarbij het initiatief bij de applicatie ligt om te bepalen of er een nieuw bericht is ontvangen.
-### Specificatie (Design Time)
+#### Specificatie (Design Time)
- Voeg aan de specificatie van het bericht een element 'Volgnummer' toe.
@@ -80,7 +79,7 @@ De oplossingsrichtingen voor berichten waarvoor een volgnummer van belang is wor
- Er is een 'berichtenpool' beschikbaar waar berichten met een volgnummer in bewaard worden. Hierbij is het volgnummer een sleutel om berichten uit de ‘berichtenpool' te halen.
-### Verwerking (Run Time)
+#### Verwerking (Run Time)
- Bij ontvangst van een 'Aanvang'-bericht wordt de toestand geïnitieerd voor de volgordelijke verwerking van de berichten.
diff --git a/js/config.js b/js/config.js
index e92b235..808ccd2 100644
--- a/js/config.js
+++ b/js/config.js
@@ -5,8 +5,7 @@ var respecConfig = {
} ],
authors: [ {
"mailto" : "digikoppeling@logius.nl",
- "name" : "Logius",
- "url" : "https://logius.nl/standaarden"
+ "name" : "Logius"
} ],
editors: [
{
@@ -18,16 +17,21 @@ var respecConfig = {
"company" : "Logius",
"name" : "Pieter Hering",
"url" : "https://logius.nl/standaarden"
+ },
+ {
+ "company" : "Logius",
+ "name" : "Martin van der Plas",
+ "url" : "https://logius.nl/standaarden"
}
],
github: "https://github.com/Logius-standaarden/Digikoppeling-Best-Practices-ebMS2",
previousMaturity: "DEF",
- previousPublishDate: "2019-05-16",
- previousPublishVersion: "3.2",
+ previousPublishDate: "2022-04-11",
+ previousPublishVersion: "3.2.1",
pubDomain: "dk",
- publishDate: "2022-04-11",
- publishVersion: "3.2.1",
+ publishDate: "2023-05-31",
+ publishVersion: "3.2.2",
shortName: "bpebms",
- specStatus: "DEF",
+ specStatus: "WV",
specType: "BP"
};