Inhoud documentformaat in ZDS 1.1 koppelvlak

[GreenUtil]

Beste VNG Realisatie,

Bij de koppeling tussen een vakapplicatie (VRiS) en een zaaksysteem (Djuma) op basis van het ZDS 1.1 koppelvlak bestaat verschil van inzicht over het documentformaat.

RGBZ laat de keuze vrij om als documentformaat te kiezen voor de extensie of het MimeType (Contenttype).
Het ZDS 1.1 koppelvlak kiest specifiek voor het contenttype, extensie is niet toegestaan.
Vraag aan dit forum is nu of de bovenstaande twee beweringen kloppen.

Een van beide partijen zal moeten bewegen om het berichtenverkeer goed te kunnen laten verlopen.
Daarom even deze vraag.

[michielverhoef]

Ik heb de titel even aangepast zodat deze de eigenlijke vraag beter weergeeft.

[michielverhoef]

Nu naar de vraag. Het koppelvlak Zaak- Documentservices is een aanscherping op StUF ZKN. Dit betekent dat er geen dingen in mogen staan die niet volgens StUF ZKN of RGBZ 1 toegestaan zijn maar er mag wel voor gekozen worden om minder toe te staan dan RGBZ 1 toestaat. In dit soort situaties is de koppelvlakspecificatie (in dit geval ZDS 1.1) dus leidend.

Documentformaat in RGBZ 1 staat hier beschreven: https://www.gemmaonline.nl/index.php/Rgbz_01.01/doc/attribuutsoort/enkelvoudig_document.documentformaat
In de toelichting staat:
Het gaat hier om het bestandsoort van het enkelvoudig document, zoals ‘pdf’, ‘odf’, ‘xml’, ‘gml’, etc. Het betreft het Dublin Core metadata-element ‘Format’ met als toelichting: Typically, Format will include the media-type or dimensions of the resource. Format may be used to identify the software, hardware, or other equipment needed to display or operate the resource. Examples of dimensions include size and duration. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of Internet Media Types (MIME) defining computer media formats).

In de Dublin Core https://www.dublincore.org/specifications/dublin-core/dces/ staat 'format' beschreven als "The file format, physical medium, or dimensions of the resource." en verwijst naar de IANA lijst van media-types: http://www.iana.org/assignments/media-types/

In de vraagstelling wordt gezegd:
"RGBZ laat de keuze vrij om als documentformaat te kiezen voor de extensie of het MimeType (Contenttype)."
Dit is niet correct. Waarden als "pdf", "xml" of "gml" zijn geldige waarden in de IANA lijst. Dat dit ook gebruikt wordt als extensie wil niet zeggen dat deze waarden ook daadwerkelijk extensies zijn.

In Zaak- Documentservices 1.1 staat op pagina 45 (bericht voegZaakdocumentToe):

StUF-ZKN-Elementen	RGBZ-attribuut	v/o
object . formaat	Documentformaat	v

Er wordt dus niet naar een contenttype of MimeType verwezen.

object.inhoud kent het attribuut xmime.contentType wat gevuld moet worden met een MimeType. Dit is echter niet hetzelfde als het RGBZ 1 attribuut Documentformaat. Ik kan me voorstellen dat er enige verwarring ontstaat omdat de waarde MimeType in de kolom "RGBZ-attribuut" opgenomen is terwijl dat geen RGBZ-attribuut is.

Het antwoord op de hierboven gestelde vraag is dus dat beide beweringen zoals hierboven geformuleerd niet kloppen.

[GreenUtil]

@michielverhoef

Op pagina 16 van ZDS 1.1 staat deze zin:

RGBZ laat de keuze vrij om als documentformaat te kiezen voor de extensie of het MimeType. Wel wordt aangegeven dat MimeType de aangeraden ‘best practice’ is. Vanuit deze standaard wordt gekozen om altijd voor het MimeType te kiezen, zodat dit consistent gevuld wordt.

Als ik deze zin lees, en met name "Vanuit deze standaard" (waarbij wij hier ZDS 1.1 veronderstellen) denk ik dat er toch wel een aanscherping is gemaakt in ZDS 1.1, en dat het toch verplicht is om in het element een MimeType te gebruiken.

Hoe denk jij hierover?

[michielverhoef]

@GreenUtil Dat had ik even over het hoofd gezien, sorry.

In de specificaties van ZDS 1.2 staat het veel duidelijker:

Deze specificatie schrijft daarnaast voor dat Documentformaat altijd wordt aangegeven middels een MimeType (i.t.t. een extensie). Het RGBZ beschrijft het gebruik van MimeTypes als ‘best practice’.

https://www.gemmaonline.nl/images/gemmaonline/0/0e/Specificatie_Zaak-_en_Documentservices_v1.2.pdf bovenaan pagina 13.

Er zijn echter twee attributen die zoals het er nu naar uitziet met hetzelfde gegeven gevuld zouden moeten worden:
object@formaat
object.inhoud@xmime:contentType

Aangezien Documentformaat gebruikt wordt in de CMIS koppeling (zie Bijlage B https://www.gemmaonline.nl/images/gemmaonline/d/df/BIJLAGE_B-mapping-cmis-properties-rgbz-attributen.xslx.zip) en daarmee cmis:contentStreamMimeType gevuld wordt is het ook logisch om in object@formaat een MimeType op te nemen.

In de Documenten API is dit geen punt van discussie meer, daar staat zonneklaar dat het formaat gevuld moet worden met een MediaType (voorheen MimeType): https://documenten-api.vng.cloud/api/v1/schema/#operation/enkelvoudiginformatieobject_read
Als dat een optie is ... ;-)

[michielverhoef]

Is deze vraag beantwoord? Dan kan ik het issue sluiten.

[joriswit]

Ja, de vraag is voor ons beantwoord, dit issue mag worden gesloten.