Koppelvlak Documentcreatie

Uit JOIN wiki
Versie door E.visser (overleg | bijdragen) op 3 jan 2019 om 05:23 (Vrije inhoud)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Ga naar: navigatie, zoeken

Inleiding

StUF-DCR (documentcreatie services) is gebaseerd op StUF-ZKN en StUF-BG. Het is een berichtenstandaard voor de uitwisseling van de gegevens, ten behoeve van het documentcreatieproces.  

Met het documentcreatieproces wordt het samenvoegen van sjablonen met registratiegegevens bedoeld. Deze registratiegegevens worden uit JOIN opgehaald; de sjablonen kunnen in JOIN worden aangemaakt en beheerd, maar wanneer sjablonen in een ander pakket worden gemaakt en beheerd zorgt StUF-DCR voor het samenvoegen van gegevens uit JOIN Zaak & Document, de Documentcreatieverzoeker (DCV) met het sjabloon van de Documentcreatie-applicatie (DCA).

StUF-DCR heeft als voordeel dat gegevens één op één worden overgenomen. Er worden minder fouten gemaakt, omdat gegevens niet handmatig overgetikt worden; ook kan er op deze manier efficiënter gewerkt worden, doordat een deel van het documentcreatieproces geautomatiseerd wordt. 

Daarnaast sluiten de documentcreatieservices goed aan op het zaakgericht werken, doordat de zaakgerelateerde documenten na creatie geautomatiseerd (via de Zaak- en Documentservices) in het zaakdossier opgeslagen kunnen worden.

Randvoorwaarden

De StUF-DCR berichtenservice kan ingezet worden als aan de volgende randvoorwaarden kan worden voldaan:

  • JOIN Zaak & Document versie 6.0.8 en hoger
  • Decos oplossing zaakgericht werken (zaaktypen.nl)
  • Beschikbaarheid en bereikbaarheid van de StUF-DCR berichtenservice van JOIN Zaak & Document vanuit DCA en vice versa 

Werking

In deze sectie wordt de werking van het koppelvlak beschreven.

Documentcreatie

Documentcreatie kan op drie verschillende manieren plaatsvinden; dit kan per sjabloon ingesteld worden in de DCA. JOIN Zaak & Document heeft dus geen invloed op de methode die de DCA hanteert voor het samenvoegen van een gekozen sjabloon. Het gedrag binnen JOIN Zaak & document is wel bij elke methode anders.

Vanuit de specificatie Documentcreatie services (zie referentiedocument II) worden twee verplicht te ondersteunen mogelijkheden beschreven voor het samenvoegingsproces. Dit zijn het synchrone en asynchrone proces. Daarnaast beschrijft de specificatie “Optionele Variant #3 - Gebruikersinteractie tijdens het aanmaken”. De JOIN StUF-DCR integratie ondersteunt deze variant ook. 

Hieronder worden de drie verschillende methodes besproken.

Synchroon

Het gekozen sjabloon wordt direct samengevoegd met de gegevens uit JOIN Zaak & Document. De uitwisseling van StUF berichten vindt onmiddellijk plaats zonder tussenkomst van een gebruiker.

Synchrone samenvoeging.png

  1. JOIN Zaak & Document roept de DCA aan t.b.v. het starten van de documentcreatie
  2. Het resultaat komt in de respons van de aanroep direct terug

Het samengevoegde resultaat wordt direct geopend middels de JOIN Client componenten.

Voor het openen van het document direct uit JOIN Zaak & Document zijn de Decos Document Control componenten nodig op de werkplek van de gebruiker en heeft de gebruiker ook Decos bewerk-rechten op dit document nodig. Daarnaast dient JOIN Zaak & Document bereikbaar te zijn vanaf de werkplek van de gebruiker.

Asynchroon (uitgestelde samenvoeging)

Het gekozen sjabloon wordt niet direct samengevoegd met de gegevens van JOIN Zaak & Document. Het samenvoegen wordt onderbroken (bijvoorbeeld door de gebruiker) en op een later tijdstip hervat. In JOIN zal een bestandsregistratie aangemaakt worden, waarbij de ‘Samenvoeg status’ op Uitgesteld zal staan totdat deze vanuit JOIN Zaak & Document of de DCA voltooid wordt. Het StUF bericht wordt in dit geval dus met uitstel verstuurd. 

Asynchrone samenvoeging.png

  1. JOIN Zaak & Document roept de DCA aan t.b.v. het starten van de documentcreatie
  2. De DCA geeft in de respons alleen de status ‘Ontvangen’ terug.
  3. Na het samenvoegen stuurt de DCA een bericht met de status ‘Klaar’ en de bestandsinhoud van het samengevoegde resultaat naar de berichtenservice van JOIN Zaak & Document.

Omdat het voor JOIN Zaak & Document niet voorspelbaar is wanneer de samenvoeging wordt voltooid, wordt het document niet automatisch geopend wanneer de samenvoeging is voltooid.

User Interface (Optionele Variant #3)

Na het kiezen van het sjabloon wordt door JOIN Zaak & Document de gebruikersinterface van de documentcreatie applicatie geopend. Hier kunnen door de gebruiker gegevens aangevuld worden. Hierna wordt het sjabloon samengevoegd met zowel de gegevens uit JOIN Zaak & Document als de aangevulde gegevens. Het resultaat wordt via het asynchrone proces teruggeschreven naar JOIN Zaak & Document.

User interface.png

  1. JOIN Zaak & Document roept de DCA aan t.b.v. het starten van de documentcreatie
  2. De DCA geeft in de respons de status ‘Ontvangen’ en link naar de gebruikersinterface van de DCA terug.
  3. JOIN Zaak & Document opent de link naar de gebruikersinterface van de DCA waarna de gebruiker de samenvoeging kan afronden binnen de applicatie van de DCA.
  4. Na het samenvoegen stuurt de DCA een bericht met de status ‘Klaar’ en de bestandsinhoud van het samengevoegde resultaat naar de berichtenservice van JOIN Zaak & Document die de bestandsregistratie bijwerkt met deze gegevens.

Documentcreatie vindt altijd plaats vanuit JOIN. Het gecreëerde bestand wordt vanuit de sjabloonapplicatie weer teruggeschreven naar de bestandsregistratie in JOIN, wanneer de gebruiker klaar is met het bewerken van het bestand.

Omdat het voor JOIN Zaak & Document niet voorspelbaar is wanneer de samenvoeging wordt voltooid, wordt het document niet automatisch geopend wanneer de samenvoeging is voltooid.

Randvoorwaarden

Om van deze optionele variant #3 gebruik te maken dient de DCA aan de volgende randvoorwaarden te voldoen.

  • De DCA ondersteunt ook optionele variant #3.
  • De DCA maakt gebruik van een web-based gebruikersinterface die middels een URL (Link) is aan te roepen.

Combinate Zaak- en Documentservices

De specificatie Documentcreatie services (Zie referentiedocument II) beschrijft een ‘Optionele Variant #1  - Opslag door DCA in DMS via Zaak- en Documentservices. Deze variant beschrijft een keten van 3 applicaties:

  • Documentcreatie applicatie (DCA)
  • Documentcreatie verzoeker (DCV)
  • Zaaksysteem en DMS (Zs-DMS)

In deze keten is niet JOIN Zaak & Document de DCV, maar neemt een backoffice applicatie deze rol aan.

 De keten werk dan als volgt:

Keten met zaak en documentservices.png

  1. DCV stuurt startbericht naar DCA, DCA geeft alleen het resultaat ‘Ontvangen’ terug.
  2. DCA slaat gecreëerde document (zonder tussenkomst van DCV) op in JOIN Zaak & Document via de Zaak- en Documentservices.
  3. DCA stuurt bericht met resultaat ‘Klaar’ zonder bestandsinhoud naar DCV

De DCV kan via de Zaak- en Documentservices het gecreëerde document o.b.v. relevante metadata ophalen uit JOIN Zaak & Document. Zie voor meer informatie de specificatie Zaak- en Documentservices van KING en van Decos (Referentiedocumenten IV).

Randvoorwaarden

Om deze keten te laten functioneren moet aan een aantal randvoorwaarden worden voldaan.

  • De backoffice applicatie (DCV) in deze keten ondersteunt ‘Extensie #3’ van de specificatie Documentcreatieservices. (Niet opnemen document.inhoud (ZKN:EDC) in bericht - leverDocumentcreatieResultaatDu02).
  • De backoffice applicatie (DCV) in deze keten is in staat om in bericht 1 de zaakidentificatie mee te geven aan de DCA.
  • De documentcreatieapplicatie in deze keten ondersteunt het opslaan van zaakdocumenten middels de Zaak- en documentservices.
  • De backoffice applicatie in deze keten heeft ook zelf reeds een Zaak- en Documentservices aansluiting gerealiseerd op de JOIN StUF-ZKN integratie.

Gegevensuitwisseling

Binnen de Documentcreatie services zijn een aantal velden gespecificeerd die zowel de DCA als de DCV verplicht moet ondersteunen (zie referentiedocument II). Daarnaast zijn er in deze specificatie een aantal optionele velden gespecificeerd. 

Gegevens

De JOIN StUF-DCR integratie ondersteunt de volgende velden en informatie. Bij elk gegeven staat aangegeven of de DCA toegestaan is de metadata in het resultaatbericht bij te werken in JOIN Zaak & Document (kolom ‘T’).

Veld Omschrijving T
Parameters
sjabloonidentificatie Identificatie van het sjabloon x
jobidentificatie Unieke sleutel voor de samenvoegopdracht x
Documentspecificatie
identificatie Unieke sleutel voor de bestandsregistratie x
uwBriefDatumOntvangst Ontvangstdatum x
uwBriefDatum Document datum x
onsKenmerk Document kenmerk x
betreft Document onderwerp x
heeft.gerelateerde.betrokkene (ZKN:BTR) Gegevens gekoppelde betrokkene x
Natuurlijke persoon Indien gekoppelde persoon x
inp.bsn Burger service nummer x
geslachtsnaam Geslachtsnaam van de persoon x
voorletters Voorletters van de persoon x
voornamen Voornamen van de persoon x
geslachtsaanduiding Geslachtsaansuiding (‘M’ / ‘V’ / ‘O’) x
verblijfsadres Gegevens verblijfsadres x
wpl.woonplaatsNaam Woonplaatsnaam x
gor.straatnaam Straatnaam x
aoa.postcode Postcode x
aoa.huisnummer Huisnummer x
aoa.huisletter Huisletter x
aoa.huisnummertoevoeging Huisnummertoevoeging x
Vestiging (organisatie) Indien gekoppelde vestiging x
vestigingsNummer Vestigingsnummer x
handelsnaam Handelsnaam x
verblijfsadres Gegevens verblijfsadres x
wpl.woonplaatsNaam Woonplaatsnaam x
gor.straatnaam Straatnaam x
aoa.postcode Postcode x
aoa.huisnummer Huisnummer x
aoa.huisletter Huisletter x
aoa.huisnummertoevoeging Huisnummertoevoeging x
heeft.gerelateerde.aard Aard betrokkene (vast ‘Geadresseerde’) x
heeftBetrekkingOp.gerelateerde.zaak (ZKN:ZAK) Gekoppelde zaak x
                identificatie Zaak identificatie x
omschrijving Omschrijving x
toelichting Toelichting op omschrijving x
kenmerk Zaak kenmerk x
Startdatum Startdatum van de zaak x
registratiedatum Registratiedatum x
einddatumGepland Geplande einddatum (servicenorm) x
uiterlijkeEinddatum Uiterlijke einddatum (wettelijke termijn) x
einddatum Eindatum van de zaak x
isSpecificatieVan.gerelateerde.document (ZKN:EDC) Gegevens van document
identificatie Document identificatie x
dct.omschrijving Documenttype omschrijving x
creatiedatum Creatiedatum v
ontvangstdatum Ontvangstdatum x
titel Onderwerp van het document v
beschrijving Beschrijving van de bestandsregistratie v
link Link naar de bestandsregistratie in JOIN Z&D x
documentkenmerk Document kenmerk x
barcode Decos Barcode x
Vrijeinhoud (zie paragraaf 2.1)
Groep ‘document’ Alle ‘legacy’ itemprofiel velden van gekoppelde documenten x
Groep ‘folder’ Alle ‘legacy’ itemprofiel velden van gekoppelde dossiers / zaken x
Groep ‘address’ Alle ‘legacy’ itemprofiel velden van gekoppelde adressen x

Vrije inhoud

De vrije inhoud kan gebruikt worden om gegevens te ontsluiten die buiten de standaard vallen. De verwijzingen in het sjabloon naar de velden in JOIN Zaak & Document zullen de applicatiebeheerders van de DCA en JOIN Zaak & Document met elkaar moeten afstemmen. 

Zie hieronder een voorbeeld van de door de integratie ‘vertaalde’ JOIN Zaak & Document itemprofiel elementen naar de vrije inhoud structuur in het StUF-DCR bericht. 

JOIN Zaak & Document structuur

 <ITEM TYPE="DOCUMENT">
  <ITEM_KEY>123456</ITEM_KEY>
  <SEQUENCE>1</SEQUENCE>
  <MARK>D-1</MARK>
  <SUBJECT1>Test</SUBJECT1>
  <ITEMS TYPE="ADDRESS">
    <ITEM>
      <ITEM_KEY>234567</ITEM_KEY>
      <SEQUENCE>2</SEQUENCE>
      <MARK>A-2</MARK>
      <SUBJECT1>Test</SUBJECT1>
    </ITEM>
  </ITEMS>
</ITEM>

StUF-DCR vrije inhoud structuur

<DCr:vrijeInhoud>
  <DCr:groep type="DOCUMENT" xsi:type="DCr:VrijeInhoudGroep">
    <DCr:element naam="ITEM_KEY" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">123456</DCr:element>
    <DCr:element naam="SEQUENCE" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">1</DCr:element>
    <DCr:element naam="MARK" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">D-1</DCr:element>
    <DCr:element naam="SUBJECT1" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">Test</DCr:element>
    <DCr:groep type="ADDRESS" xsi:type="DCr:VrijeInhoudGroep">
      <DCr:element naam="ITEM_KEY" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">234567</DCr:element>
      <DCr:element naam="SEQUENCE" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">2</DCr:element>
      <DCr:element naam="MARK" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">A-2</DCr:element>
      <DCr:element naam="SUBJECT1" formaat="string" xsi:type="DCr:VrijeInhoudElement-e">Test</DCr:element>
    </DCr:groep>
  </DCr:groep>
</DCr:vrijeInhoud>

Gegevens collecties

De StUF-DCR integratie kan aangesloten worden op 1 collectie voor zaken en 1 collectie voor documenten. Mede om deze reden is het gebruik van een Zaaktypen.nl inrichting sterk aanbevolen aangezien deze inrichting werkt met 1 collectie voor beide entiteit-typen. 

Daarnaast kan er gebruik gemaakt worden van 1 collectie voor natuurlijke personen en 1 collectie voor organisaties. Het is aan te raden de collecties voor deze gegevens te gebruiken die zijn aangesloten op de bron voor de basisgegevens middels de JOIN StUF-BG integratie.

Gebruik en Inrichting

De sjablonen worden in de DCA opgemaakt en ingericht. Voor uitleg over het opmaken en inrichten van dergelijke sjablonen verwijzen wij naar de leverancier van de DCA. 

Specificeren externe sjablonen

Het sjabloon kan in Admin worden ingevoerd onder het onderdeel Applicatiebeheer > Sjablonen in admin.  

De omschrijving is de omschrijving van het sjabloon die gebruikers zien wanneer ze een sjabloon kunnen selecteren.

Verder worden hier de bestandsnamen + extensie ingevoerd in het veld bestandsnaam. De te gebruiken extensie voor de StUF-DCR sjablonen is altijd ‘.dcr’. Bijvoorbeeld: ontvangstbevestiging.dcr. Het invoeren van deze bestandsnamen zorgt ervoor dat StUF-DCR het sjabloon herkent en dat dit sjabloon in de juiste applicatie wordt geopend.    

Schermafdruk sjabloon specificeren.png

Per documenttype wordt er tot en met versie 6.0.7 een nieuw sjabloon aangemaakt. Bijvoorbeeld: als documenttype Vergunningverlening aan twee zaaktypen wordt gekoppeld, wordt het daaraan gekoppelde sjabloon gedupliceerd. Vanaf versie 6.0.8 is de functionaliteit gewijzigd en wordt er wel naar een en dezelfde sjabloon verwezen, wanneer deze bekend is in JOIN. Het is wenselijk om minstens 6.0.8 geïnstalleerd te hebben. 

Autorisatie

In Admin wordt ook de autorisatie per sjabloon geregeld. Standaard is elk nieuw sjabloon onder elk itemprofiel beschikbaar. Dit houdt in het geval van een zaaktypen.nl inrichting in dat een sjabloon onder elk documenttype beschikbaar is.

Het is mogelijk om specifiek in te stellen bij welk documenttype een sjabloon samengevoegd mag worden.

Onder het tabblad itemprofielen van een specifiek sjabloon geef je aan bij welk profiel en het daaraan gekoppelde documenttype een sjabloon opgeroepen mag worden. 

Omdat er meerdere gelijknamige documenttypen onder een zaakdocumentprofiel te vinden zijn, kun je de optie Toon het volledige pad naar de boeken aanvinken, waardoor het zichtbaar wordt welk documenttype aan welk zaaktype gekoppeld is.

In onderstaande schermprint zie je dat de optie niet aan is gevinkt. Het is nu niet duidelijk welk documenttype Advies bij welk zaaktype hoort.  

Schermafdruk itemprofiel sjabloon 1.png

In onderstaande schermprint is de optie aangevinkt. Het sjabloon Gunningsbrief is nu beschikbaar bij documenttype Advies dat gerelateerd is aan zaaktype Opleveringscontrole.  

Schermafdruk itemprofiel sjabloon 2.png

Naast het vastleggen van de autorisatie op documenttypeniveau, is het ook mogelijk om een autorisatie op gebruikersprofielniveau vast te leggen. Hiermee geef je aan welke gebruikersgroep een sjabloon mag aanroepen. 

Vastleggen standaard sjabloon

In Zaaktypen.nl kun je per ingevoerd documenttype een standaardsjabloon opgeven. Dit doe je door in het veld Model de omschrijving van het sjabloon in te voeren.

Schermafdruk zt.nl standaard sjabloon.png

Wanneer het sjabloon bekend is in JOIN (dus wanneer de omschrijving gelijk is), wordt er naar de bestaande sjabloonregistratie verwezen. Is het sjabloon niet bekend, dan wordt er een nieuwe sjabloonregistratie aangemaakt. De applicatiebeheerder dient dan nog wel het juiste sjabloon aan de registratie te koppelen. Het sjabloon wordt dan het standaardsjabloon bij dat documenttype. Dit betekent dat het sjabloon standaard wordt geselecteerd bij gebruik van de antwoordknop vanuit de werkvoorraad, of dat het sjabloon bij de documentregistratie opgeroepen kan worden met de briefknop.  

Samenvoeginformatie

De StUF-DCR integratie schrijft informatie terug naar de bestandsregistratie over de status van de samenvoeging. Hiervoor wordt standaard het veld ‘TEXT2’ gebruikt. Indien gewenst kan dit veld worden toegevoegd aan het standaard itemprofiel voor bestanden. Het veld NUM6 wordt gebruikt om de numerieke status vast te leggen. 

De mogelijke statussen zijn:

  • ontvangen (job is ontvangen door DCA)
  • bezig (de job loopt nog)
  • onderbroken (betekent dat de job in de toekomst verder zal gaan)
  • geannuleerd (betekent dat de job definitief niet verder zal gaan)
  • klaar (job is afgerond, document is klaar)
  • onbekend (voor overige gevallen)
  • fout (niet toegestaan in dit bericht) 

Deze statussen worden door de DCA aan JOIN Zaak & Document doorgegeven. Niet elke DCA is in staat al deze statussen door te geven.

Samenvoeging starten

Het starten van een samenvoeging is beschreven in de help pagina van JOIN Zaak & Document. De methode voor het aanroepen van een extern StUF-DCR sjabloon is hetzelfde als voor een intern sjabloon. Zie voor meer informatie de handleiding van JOIN Zaak & Document voor de mogelijkheden tot sjabloon samenvoeging (referentiedocument IV). 

Samenvoeging hervatten

Een samenvoeging hervatten kan door op de ‘openen bestand’ functies te gebruiken op de verschillende plaatsen in JOIN Zaak & Document, bij een nog niet afgeronde samenvoeging. Deze functie zorgt ervoor dat de samenvoeging weer wordt hervat. Zie voor meer informatie de handleiding van JOIN Zaak & Document over het openen van bestanden (referentiedocument IV). 

Foutafhandeling

Het is mogelijk dat de DCA een foutmelding teruggeeft bij het aanroepen van de documentsamenvoeging. Indien deze foutmelding volgt op de synchrone aanroep voor het starten of hervatten van de documentsamenvoeging, wordt de foutmelding getoond op het scherm van de gebruiker. 

De foutmelding bestaat uit de tekst ‘Samenvoeging met extern sjabloon mislukt:’, aangevuld met een tekstuele melding die één op één overeenkomt met de foutmelding die van de DCA werd ontvangen.