Koppelingen: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(Key2Burgerzaken)
 
(169 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
 
__TOC__
 
__TOC__
 
 
= Algemeen =
 
= Algemeen =
De volgende koppelingen kunnen beheerd worden vanuit het zaaksysteem:<br>
+
Binnen zaaksysteem.nl is er een generiek koppelplatform met koppelprofielen.. een koppelprofiel bevat logica en mogelijkheden om de koppeling te beheren. Koppelingen die ontwikkeld worden voor organisaties die gebruik maken van het zaaksysteem, worden als koppelprofiel toegevoegd. Dit betekent dat ze vanaf dat moment ook beschikbaar zijn voor andere organisaties. Hoewel het organisaties geheel vrij staat om nieuwe koppelingen in te richten op basis van een koppelprofiel, is er bij veel koppelingen specifieke kennis nodig voor het werkend opleveren van de koppeling. Wij adviseren dan ook om contact op te nemen met Mintlab voor eventuele ondersteuning.
<ul>
 
<li>BAG import via CSV</li>
 
<li>Key2Finance</li>
 
<li>Key2Burgerzaken</li>
 
<li>StUF Koppeling Configuratie</li>
 
<li>StUF Koppeling (PRS)</li>
 
<li>StUF Koppeling (NNP)</li>
 
<li>StUF Koppeling (ADR)</li>
 
<li>StUF Koppeling (VBO)</li>
 
</ul>
 
=== Transactieoverzicht ===
 
In dit overzicht worden alle transacties en basisgegevens weergegeven. Er kan gefilterd worden per koppeling en op fouten, zodat de beheerder eventuele problemen snel kan ontdekken en actie ondernemen. Door op de transactie te klikken kan deze in meer detail worden bekeken.<br>
 
  
=== Configuratiescherm ===
+
Het onderdeel 'koppelingen' bestaat uit de volgende drie overzichten:
Op het configuratiescherm worden de instellingen van de koppelingen beheerd en kunnen nieuwe koppelingen worden aangemaakt.
 
 
 
Instellingen die elke koppeling heeft zijn:<br>
 
 
<ul>
 
<ul>
<li>API</li>
+
<li>[[Transactieoverzicht|Transactieoverzicht]]</li>
<li>Zaaktype</li>
+
<li>[[Koppelingconfiguratie|Koppelingconfiguratie]]</li>
<li>Gegevensmapping</li>
+
<li>[[Gegevensmagazijn|Gegevensmagazijn]]</li>
<li>Status (actief / niet actief)</li>
 
 
</ul>
 
</ul>
  
=== Afnemerindicaties ===
+
= Lijst van koppelingen =
&&&aanvullen<br>
 
<br>
 
  
=== Screenshots ===
+
{| class="wikitable sortable" border="1"
<gallery widths=200px heights=200px>
+
|+ - Koppelingen -
File:Koppelingen transactieoverzicht.png|Transactieoverzicht
+
|-
File:Koppelingen configuratiescherm.png|Configuratiescherm
+
! scope="col" class="sortable" width="170pt"| Naam
File:Koppelingen afnemerindicaties.png|Afnemerindicaties
+
! scope="col" class="sortable" width="100pt"| Versie
</gallery>
+
! scope="col" class="sortable" width="100pt"| Status
 
+
! scope="col" class="unsortable" width="600pt"| Toelichting
= Koppelingen =
+
|-
 
+
|[[Koppelprofiel_Active_directory|Active directory]]
=== Active Directory ===
+
|1.0
 
+
|In gebruik
 
+
|Voor het importeren van gebruikers
Usergegevens worden door de beheerserver opgehaald met een readonly account. Deze heeft enkel leesrechten nodig op de Active Directory. Hiermee worden alle gebruikers opgehaald uit de Users OU of applicatiegroep. Dit gebeurt om de vijf minuten.  De data van de gebruikers worden d.m.v. de Windows Service ‘Password synchronization for Unix systems’ gesynchroniseerd met de OpenLDAP van het zaaksysteem. Zodra een gebruiker wordt aangemaakt, zijn wachtwoord wijzigt of wordt verwijderd wordt deze actie ook verstuurd naar de beheerserver. Wijzigingen m.b.t. wachtwoorden zullen live worden gepushed naar de beheerserver op port 6677. De wachtwoorden worden direct gehashed opgeslagen voor verwerking.
+
|-
 
+
|[[Koppelprofiel_Afspraken|Afspraken]]
Deze worden ‘gemerged’ met de wachtwoorden, en worden direct in een beveiligde XML verstuurd naar de omgeving in de overheidscloud. De beheerserver maakt gebruik van een HTTPS verbinding die alleen met behulp van een API-Key kan worden opgezet.
+
|1.0
 
+
|In gebruik
[[bestand:AD-koppeling_archi_2013.png]]
+
|Voor koppelingen met Lamson, Qmatic, SuperSaaS
 
+
|-
=== BAG-import ===
+
|[[Koppelprofiel_BAG_import|BAG-import]]
Maak eerst een koppeling aan:<br>
+
|1.0
<ul>
+
|In gebruik
<li>Ga naar het configuratiescherm en klik op de plusknop</li>
+
|Voor het importeren van de BAG-objecten, met name de adressen
<li>Selecteer het type 'Key2Finance'</li>
+
|-
<li>Geef eventueel een eigen naam op</li>
+
|[[Koppelprofiel_BuitenBeter|BuitenBeter]]
</ul>
+
|1.6
<br>
+
|In gebruik
[[bestand:Koppeling nieuw bag import.png]]<br>
+
|Meldingen die worden gedaan via de [http://www.buitenbeter.nl BuitenBeter] App worden als zaken aangemaakt
<br>
+
|-
Activeer vervolgens de koppeling.<br>
+
|[[Koppelprofiel_GWS4ALL|GWS4ALL]]
<br>
+
|1.0
Nu kunnen CSV bestanden op twee manieren worden toegevoegd:<br>
+
|In gebruik
<ul>
+
|Voor het uitwisselen van gegevens tussen het zaaksysteem en de GWS4ALL applicatie
<li>Op het transactieoverzicht via de plusknop</li>
 
<li>Op het configuratiescherm door bij de naam van de koppeling op het tandwieltje te klikken en 'handmatige upload' te selecteren</li>
 
</ul>
 
Selecteer de BAG-koppeling en voeg een bestand toe via de upload knop.<br>
 
<br>
 
[[bestand:Koppeling bag uploaddialog.png]]<br>
 
<br>
 
Een voorbeeld CSV kan gedownload worden vanuit het configuratiescherm van de koppeling. De inhoud van dit bestand is:
 
<div style="height: 128px; width: 1000px; overflow: scroll; resize:both; border:1px outset #003399;">
 
<pre>
 
woonplaats_identificatie,woonplaats_begindatum,woonplaats_einddatum,woonplaats_naam,woonplaats_status,woonplaats_inonderzoek,openbareruimte_identificatie,openbareruimte_begindatum,openbareruimte_einddatum,openbareruimte_naam,openbareruimte_type,openbareruimte_inonderzoek,openbareruimte_status,nummeraanduiding_identificatie,nummeraanduiding_begindatum,nummeraanduiding_einddatum,nummeraanduiding_huisnummer,nummeraanduiding_huisletter,nummeraanduiding_huisnummertoevoeging,nummeraanduiding_postcode,nummeraanduiding_inonderzoek,nummeraanduiding_type,nummeraanduiding_status,verblijfsobject_identificatie,verblijfsobject_begindatum,verblijfsobject_einddatum,verblijfsobject_oppervlakte,verblijfsobject_status,verblijfsobject_inonderzoek,verblijfsobject_gebruiksdoel,pand_identificatie,pand_begindatum,pand_einddatum,pand_status,pand_inonderzoek,pand_bouwjaar
 
1331,2007-11-13,,Bussum,Woonplaats aangewezen,N,0381300000100001,2009-07-01,,Aaltje Noordewierlaan,Weg,N,Naamgeving uitgegeven,0381200000100500,1992-03-24,,1,A,1-R,1403JA,J,Verblijfsobject,Naamgeving uitgegeven,0381010000020398,1994-03-17,,67,Verblijfsobject in gebruik,N,woonfunctie,0381100000118244,1994-03-17,,Pand in gebruik,N,1992
 
1331,2007-11-13,,Bussum,Woonplaats aangewezen,N,0381300000100002,2009-07-02,,dr. Abraham Kuyperlaan,Weg,N,Naamgeving uitgegeven,0381200000105490,2010-09-21,,124,,,1402HR,N,Verblijfsobject,Naamgeving uitgegeven,0381010000024346,2002-12-27,,89,Verblijfsobject in gebruik,N,woonfunctie,0381100000117125,2002-12-27,,Pand in gebruik,N,2004
 
1331,2007-11-13,,Bussum,Woonplaats aangewezen,N,0381300000100003,2009-07-03,,Achtermeulenlaan,Weg,N,Naamgeving uitgegeven,0381200000100308,2010-09-21,,17,,,1402SW,N,Verblijfsobject,Naamgeving uitgegeven,0381010000020282,2010-05-12,,92,Verblijfsobject in gebruik,N,kantoorfunctie,0381100000105985,2010-05-12,,Pand in gebruik,N,1904
 
1331,2007-11-13,,Bussum,Woonplaats aangewezen,N,0381300000100233,2009-07-01,,Hooftlaan,Weg,N,Naamgeving uitgegeven,0381200000105209,1994-03-28,,30,,WS3,1401EE,N,Ligplaats,Naamgeving uitgegeven,0381020000100003,2010-10-05,,,Plaats aangewezen,N,woonfunctie,,,,,,
 
1331,2007-11-13,,Bussum,Woonplaats aangewezen,N,0381300000100308,2009-07-01,,Zanderijweg,Weg,N,Naamgeving uitgegeven,0381200000117616,1982-04-21,,7,,,1403XW,N,Standplaats,Naamgeving uitgegeven,0381030000100001,2010-10-05,,,Plaats aangewezen,N,woonfunctie,,,,,,
 
</pre>
 
</div>
 
<br>
 
 
 
=== BuitenBeter ===
 
=== DigiD ===
 
Een burger kan via DigiD inloggen op het zaaksysteem om:<br>
 
<ol>
 
<li>Een zaak aan te vragen</li>
 
<ul>
 
<li>De burger wordt bij het starten van de aanvraag omgeleid naar de inlogpagina van digid en wordt vervolgens (bij succesvolle inlog) omgeleid naar het webformulier</li>
 
<li>Het zaaksysteem ontvangt hierbij enkel het BSN-nummer van DigiD. Wanneer deze burger reeds als contact in het zaaksysteem aanwezig is zal het systeem de gegevens van de burger weergeven op de contactgegevenspagina van het webformulier. Wanneer deze burger nog niet als contact in het zaaksysteem aanwezig is verplicht het systeem de burger om deze gegevens zelf in te vullen op de contactgegevenspagina van het webformulier.</li>
 
</ul>
 
<li>De persoonlijke internetpagina in te zien</li>
 
<ul>
 
<li>De burger wordt bij het inloggen op de PIP omgeleid naar de inlogpagina van digid en wordt vervolgens (bij succesvolle inlog) omgeleid naar zijn/haar PIP</li>
 
<li>Het zaaksysteem ontvangt hierbij enkel het BSN-nummer van DigiD. Wanneer deze burger als contact in het zaaksysteem aanwezig is zal het systeem de gegevens van de burger weergeven. Wanneer deze burger nog niet als contact in het zaaksysteem aanwezig is verplicht het systeem de burger om deze gegevens zelf in te vullen alvorens de PIP te tonen.</li>
 
</ul>
 
</ol>
 
<br>
 
 
 
=== eHerkenning ===
 
=== Key2Burgerzaken ===
 
Dit is een feature die enkele acties uitvoert ten behoeve van verhuizingzaaktypen. De volgende acties kunnen vervolgens automatisch worden uitgevoerd:<br>
 
<ul>
 
<li>Kenmerken in het zaakdossier invullen</li>
 
<li>Bij status BVH07: resultaat invullen</li>
 
<li>Bij status BVH07: zaak afhandelen</li>
 
<li>BAG-adres gebruiken</li>
 
</ul>
 
<br>
 
Een uitleg voor het instellen van deze koppeling:<br>
 
<ol>
 
<li>In de configuratie van de koppeling moet de volgende URL worden ingevoerd bij 'Url key2burgerzaken':<br>
 
<pre>
 
http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx
 
</pre>
 
[[bestand:Koppeling verhuizing voorbeeld url.png]]<br>
 
<li>Op basis van de invoer voor kenmerken in de registratiefase worden kenmerken in de rest van de zaak ingevoerd:<br>
 
<ul>
 
<li>De volgende kenmerken moeten in het verhuiszaaktype aanwezig zijn:<br>
 
{| class="wikitable"
 
 
|-
 
|-
!Titel
+
|[[Koppelprofiel_Key2Burgerzaken|Key2Burgerzaken]]
!Registratiefase
+
|2.1
!Fase 2+
+
|In gebruik
!Toelichting
+
|Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Burgerzaken applicatie
 
|-
 
|-
|Verhuisdatum
+
|[[Koppelprofiel_Key2Financien|Key2Financien]]
!X
 
 
|
 
|
|Datumkenmerk
+
|Niet meer in gebruik
 +
|Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Financien applicatie
 +
|-
 +
|[[Koppelprofiel_Overheid_IO_koppelingen|Overheid IO koppelingen]]
 +
|1.0
 +
|In gebruik
 +
|Voor het importeren van organisatiecontacten via OpenKvK
 
|-
 
|-
|IndicatieInwonend
+
|[[Koppelprofiel_MijnOverheid|MijnOverheid]]
!X
+
|3.10 v1.1
 +
|In gebruik
 +
|Voor het versturen van StUF-Zaakberichten naar MijnOverheid
 +
|-
 +
|[[Koppelprofiel_Ogone|Ogone]]
 
|
 
|
 +
|In gebruik
 +
|Voor de online betaling bij het online aanvragen van zaken
 +
|-
 +
|[[Koppelprofiel Publieke zoekopdracht|Publieke zoekopdracht]]
 
|<nowiki>-</nowiki>
 
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|Voor het openbaar toegankelijk maken van het zakenoverzicht van een zoekopdracht
 
|-
 
|-
|Meeverhuizers.BurgerservicenummersMeeverhuizers
+
|[[Koppelprofiel_stuf-nps|StUF-NPS]]
!X
+
|3.10
 +
|In gebruik
 
|
 
|
|Opplusbaar tekstveld of numeriek veld
 
 
|-
 
|-
|Statuscode
+
|[[Koppelprofiel_StuF_PRS|StUF-PRS]]
 +
|2.04
 +
|Niet meer in gebruik
 
|
 
|
!X
 
|Tekstveld
 
 
|-
 
|-
|Statusomschrijving
+
|[[Koppelprofiel_StuF_ADR|StUF adressen]]
 +
|2.04 en 3.10 v1.1
 +
|In gebruik
 
|
 
|
!X
 
|Groot tekstveld
 
 
|-
 
|-
|IndicatieMeldenAanBurger
+
|[[Koppelprofiel_StuF_NNP|StUF-NNP]]
 +
|2.04 v1.1
 +
|In gebruik
 
|
 
|
!X
 
|Groot tekstveld
 
 
|-
 
|-
|BackOfficeID
+
|[[Koppelprofiel_StuF_DCR|StUF-DCR]]
 +
|1.0
 +
|In gebruik
 
|
 
|
!X
 
|Tekstveld
 
 
|-
 
|-
|Contactgegevens.Emailadres
+
|[[Koppelprofiel_Telefooncentrale|Telefooncentrale]]
!X
+
|1.0
 +
|In gebruik
 +
|Voor het uitwisselen van gegevens tussen het zaaksysteem en de telefooncentrale
 +
|-
 +
|[[Koppelprofiel_Scanstraat|Scanstraat]]
 +
|1.2
 +
|In gebruik
 +
|Voor het ontvangen van ingescande documenten
 +
|-
 +
|[[Koppelprofiel_Zaakinformatie_bevragen|Zaakinformatie bevragen]]
 +
|1.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
|Contactgegevens.TelefoonnummerPrive
+
|[[Koppelprofiel_I-navigator|I-Navigator]]
!X
+
|1.5
|
+
|In gebruik
|Tekstveld of systeemkenmerk
+
|Importmodule voor het importeren van zaaktypen uit de I-Navigator
 +
|-
 +
|[[Producten en vragen importeren|PDC - Kluwer / SDU]]
 +
|1.1 / 4.0
 +
|In gebruik
 +
|Importmodule voor het importeren van producten en vragen van Kluwer / SDU
 +
|-
 +
|[[Koppelprofiel SDU Connect|SDU Connect]]
 +
|1.0
 +
|In gebruik
 +
|Importmodules voor het importeren en synchroniseren van SDU producten en vragen
 
|-
 
|-
|Contactgegevens.TelefoonnummerMobiel
+
|[[Koppelprofiel_Omgevingsloket|Omgevingsloket (OLO)]]
!X
+
| StuF 3.12
|
+
|In gebruik
|Tekstveld of systeemkenmerk
+
|Koppelprofiel voor het automatisch verwerken van berichtenverkeer uit de OLO
 
|-
 
|-
!colspan="3"|Als 'Gebruik BAG voor adres verhuizing' = uit (zie optie 5)
+
|[[Koppelprofiel SAML IDP|SAML 2.0 Identity Provider]]
 +
|SAML 2.0
 +
|In gebruik
 +
|Koppelprofiel voor het inloggen op zaaksysteem via DigiD, eHerkenning, eIDAS en de AD
 
|-
 
|-
|Adresgegevens.Postcode
+
|[[Koppelprofiel SAML SP|SAML 2.0 Service Provider]]
!X
+
|SAML 2.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
|Adresgegevens.Huisnummer
+
|[[Koppelprofiel_Email#Uitgaande_mailconfiguratie|Uitgaande mailconfiguratie]]
!X
+
|1.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
|Adresgegevens.Huisletter
+
|[[Koppelprofiel_Email#Pop3Mailbox|Pop3Mailbox]]
!X
+
|1.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
|Adresgegevens.Huisaanduiding
+
|[[Koppelprofiel_Email#Inkomende_mailafhandeling|Inkomende mailafhandeling]]
!X
+
|1.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
|Adresgegevens.Huistoevoeging
+
|[[Koppelprofiel_Email#Ingeplande_e-mail|Ingeplande email]]
!X
+
|1.0
 +
|In gebruik
 +
|Voor het inplannen van e-mails
 +
|-
 +
|[[Koppelprofiel Kaartconfiguratie|Kaartconfiguratie]]
 +
|1.0
 +
|In gebruik
 +
|Voor het gebruik van WMS-kaartlaag services
 +
|-
 +
|[[Koppelprofiel Zaaksysteem API|Zaaksysteem API]]
 +
|1.0
 +
|In gebruik
 
|
 
|
|Tekstveld of systeemkenmerk
 
 
|-
 
|-
!colspan="3"|Als 'Gebruik BAG voor adres verhuizing' = aan (zie optie 5)
+
|[[Koppelprofiel Alternatieve authenticatie|Alternatieve authenticatie]]
 +
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|Voor twofactorauthenticatie
 
|-
 
|-
|Bagadres
+
|[[Koppelprofiel Xential|Xential]]
!X
+
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|Voor het gebruik van de externe documentgenerator van Xential
 +
|-
 +
|[[Koppelprofiel StUF-ZKN|StUF-ZKN]]
 +
|3.10 v1.1
 +
|In gebruik
 
|
 
|
|Bag-kenmerk (adres)
 
|}
 
</li>
 
<li>Vervolgens kunnen de kenmerken worden opgegeven in de configuratie van de koppeling, onder kenmerkmapping:<br>
 
<br>
 
[[bestand:Koppeling verhuizing gegevensmapping.png]]</li>
 
<br>
 
<li>Bij het registreren van de zaak zullen de kenmerken worden ingevuld:<br>
 
<br>
 
[[bestand:Koppeling verhuizing voorbeeld fase2.png]]</li>
 
<br>
 
</ul>
 
<li>In sommige situaties zal bovenstaand kenmerk 'statuscode' worden ingevuld met BVH07. Ingesteld kan worden dat de zaak in dit geval automatisch wordt afgehandeld.<br>
 
<br>
 
[[bestand:Koppeling verhuizing voorbeeld afhandelen.png]]</li>
 
<br>
 
<li>In sommige situaties zal bovenstaand kenmerk 'statuscode' worden ingevuld met BVH07. Ingesteld kan worden dat het resultaat van de zaak in dit geval automatisch wordt ingevoerd.<br>
 
<br>
 
[[bestand:Koppeling verhuizing voorbeeld resultaat.png]]</li>
 
<br>
 
<li>Er kan een keuze gemaakt worden in welk adres wordt gebruikt als verhuisadres.<br>
 
<ul>
 
<li>Het adres van de aanvrager</li>
 
<li>Een adreskenmerk</li>
 
</ul>
 
[[bestand:Koppeling verhuizing voorbeeld bag.png]]<br>
 
Zie ook de tabel bij 2.</li>
 
</ol>
 
<br>
 
 
=== Key2Financien ===
 
Dit is een export feature die zaken met financiele informatie exporteert, en na een complete export de zaken sluit.<br>
 
<br>
 
=====Configuratie=====
 
Maak eerst een exportprofiel aan:<br>
 
<ul>
 
<li>Ga naar het configuratiescherm en klik op de plusknop</li>
 
<li>Selecteer het type 'Key2Finance'</li>
 
<li>Geef een naam op, bijvoorbeeld die van het product in kwestie</li>
 
</ul>
 
<br>
 
[[bestand:Koppeling nieuw.png]]<br>
 
<br>
 
Stel nu de volgende instellingen in:
 
<ul>
 
<li>Geef een API key op, met de key kan een externe partij authenticeren.<br>Een goede method om een key te genereren is een GUID tool zoals
 
http://www.guidgenerator.com</li>
 
<li>Kies een zaaktype waarop gefilterd moet worden. De exportmodule zal alle zaken selecteren van dat zaaktype die klaar staan om afgerond te worden. Dat wil o.a. zeggen dat een resultaat ingevuld is, alle verplichte velden aanstaan en de zaak in de laatste fase is.</li>
 
<li>Stel vervolgens de gegevensmapping in. Een uitgebreide beschrijving hiervan volgt hieronder.</li>
 
<li>Activeer de koppeling</li>
 
</ul>
 
<br>
 
[[bestand:Koppelingen key2finance.png]]<br>
 
<br>
 
In de gegevensmapping worden twee kolommen getoond. De linkerkolom toont de namen van de 'kolommen' van het CSV bestand. De rechterkolom moet ingevuld worden met de (systeem)kenmerken. Bij de export wordt de data uit die kenmerken geplaatst in de kolommen van het CSV bestand.<br>
 
<br>
 
[[bestand:Koppelingen gegevensmapping key2finance.png]]<br>
 
<br>
 
 
=====Uitvoer=====
 
Het uitvoeren van de export bestaat uit 4 stappen. Elke stap is het invoeren van een URL in de navigatiebalk van de browser. In de URL's moeten verschillende variabele handmatig worden ingevoerd. Vervang hiervoor simpewel '<u><dit></u>' gedeelte door de variabele, bijvoorbeeld: '<u>52</u>'<br>
 
{| class="wikitable"
 
 
|-
 
|-
! scope="col"| Variabele
+
|[[Koppelprofiel StUF-ZKN Client|StUF-ZKN Consumer]]
! scope="col"| Locatie
+
|3.10 v1.1
 +
|In gebruik
 +
|
 
|-
 
|-
| <omgeving>
+
|[[Koppelprofiel DataB MultiChannel DMS|DataB MultiChannel DMS]]
| De gemeentenaam uit de zaaksysteem-URL: <u>gemeentenaam</u>.zaaksysteem.nl
+
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|
 
|-
 
|-
| <interface_id>
+
|[[Koppelprofiel iWMO en iJW|iWMO en iJW]]
| Het cijfer dat achter de naam van de koppeling wordt weergegeven, in het configuratiescherm
+
|2.0
 +
|In gebruik
 +
|Voor het versturen en verwerken van beschikkingen op basis van iWMO2.0 en iJW2.0
 
|-
 
|-
| <api_key>
+
|[[Koppelprofiel Next2Know|Next2Know]]
| De opgegeven tekst in het API-veld de koppeling, in het configuratiescherm
+
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|
 
|-
 
|-
| <transactionID>
+
|[[Koppelprofiel OpenCage|OpenCage]]
| Deze is terug te vinden onderaan de pagina die getoond wordt na het invoeren van de eerste URL
+
|<nowiki>-</nowiki>
 +
|In gebruik
 +
|
 
|}
 
|}
<ol>
 
<li><b>Transactie klaarzetten:</b><br>
 
https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/set_case_list?api_key=<u><api_key></u><br>
 
<br>
 
Helemaal onderaan staat het ‘transaction_id’, welke nodig is in de volgende stappen.<br>
 
</li><br>
 
<li><b>STDDEB.csv downloaden</b><br>
 
https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/get_csv_deb?zapi_format=csv&transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
 
</li><br>
 
<li><b>STDNAW.csv downloaden</b><br>
 
https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/get_csv_naw?zapi_format=csv&transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
 
</li><br>
 
<li><b>Transactie afsluiten</b><br>
 
https://<u><omgeving></u>.zaaksysteem.nl/sysin/interface/<u><interface_id></u>/trigger/close_cases?transaction_id=<u><transactionID></u>&api_key=<u><api_key></u><br>
 
<br>
 
Dit maakt de transactie af, en sluit de geexporteerde zaken.<br>
 
Let op: Fase acties worden niet uitgevoerd. De zaak wordt afgesloten dmv. de vroegtijdig afsluiten methode.
 
</li>
 
</ol>
 
<br>
 
 
=== KVK-import===
 
=== Ogone ===
 
=== StUF-PRS ===
 
 
===== StUF-PRS attributes =====
 
<pre>
 
    'required'      => [qw/
 
        straatnaam
 
        huisnummer
 
        postcode
 
 
        burgerservicenummer
 
        geslachtsnaam
 
        geslachtsaanduiding
 
        geboortedatum
 
    /],
 
    'optional'      => [qw/
 
        voornamen
 
        huisnummertoevoeging
 
        huisletter
 
        woonplaats
 
        geboorteplaats
 
        geboorteland
 
        a_nummer
 
[...]
 
 
</pre>
 
 
===== StUF-PRS example message =====
 
  
<pre>
+
''* Indien u gebruik wilt maken van een koppelprofiel adviseren wij u contact op te nemen met de leverancier voor actuele informatie en mogelijkheden.''
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
<soapenv:Body>
 
  <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
  <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
 
  <StUF:berichtsoort>Lk01</StUF:berichtsoort>
 
  <StUF:entiteittype>PRS</StUF:entiteittype>
 
  <StUF:sectormodel>BG</StUF:sectormodel>
 
  <StUF:versieStUF>0204</StUF:versieStUF>
 
  <StUF:versieSectormodel>0204</StUF:versieSectormodel>
 
  <StUF:zender>
 
    <StUF:applicatie>CMODIS</StUF:applicatie>
 
  </StUF:zender>
 
  <StUF:ontvanger>
 
    <StUF:applicatie>ZSNL</StUF:applicatie>
 
  </StUF:ontvanger>
 
  <StUF:referentienummer>MK0000229154</StUF:referentienummer>
 
  <StUF:tijdstipBericht>2012110209011458</StUF:tijdstipBericht>
 
  <StUF:kennisgeving>
 
    <StUF:mutatiesoort>T</StUF:mutatiesoort>
 
    <StUF:indicatorOvername>V</StUF:indicatorOvername>
 
  </StUF:kennisgeving>
 
  </StUF:stuurgegevens>
 
  <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
 
  <BG:PRS StUF:sleutelGegevensbeheer="1243796" StUF:sleutelVerzendend="1243796" StUF:verwerkingssoort="T" soortEntiteit="F">
 
    <BG:a-nummer>1234567890</BG:a-nummer>
 
    <BG:bsn-nummer>987654321</BG:bsn-nummer>
 
    <BG:voornamen>Tinues</BG:voornamen>
 
    <BG:voorletters>V</BG:voorletters>
 
    <BG:geslachtsnaam>Testpersoon</BG:geslachtsnaam>
 
    <BG:geboortedatum>19620529</BG:geboortedatum>
 
    <BG:geslachtsaanduiding>M</BG:geslachtsaanduiding>
 
    <BG:tijdvakGeldigheid>
 
    <StUF:begindatumTijdvakGeldigheid>19620529</StUF:begindatumTijdvakGeldigheid>
 
    <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
 
    </BG:tijdvakGeldigheid>
 
    <BG:PRSADRVBL StUF:sleutelGegevensbeheer="1243798" StUF:sleutelVerzendend="1243798" StUF:verwerkingssoort="T" soortEntiteit="R">
 
    <BG:tijdvakRelatie>
 
      <StUF:begindatumRelatie>20121030</StUF:begindatumRelatie>
 
      <StUF:einddatumRelatie StUF:noValue="geenWaarde" xsi:nil="true"/>
 
    </BG:tijdvakRelatie>
 
    <BG:extraElementen>
 
      <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
 
    </BG:extraElementen>
 
    <BG:ADR StUF:sleutelGegevensbeheer="22628" StUF:sleutelVerzendend="22628" StUF:verwerkingssoort="T" soortEntiteit="F">
 
      <BG:postcode>1015JL</BG:postcode>
 
      <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
 
      <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
 
      <BG:huisnummer>7</BG:huisnummer>
 
      <BG:ingangsdatum>19511115</BG:ingangsdatum>
 
      <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
 
      <BG:extraElementen>
 
      <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
 
      <StUF:extraElement naam="identificatieNummerAanduiding">0716200000762034</StUF:extraElement>
 
      <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
 
      <StUF:extraElement naam="identificatiecodeVerblijfplaats">0716010000028347</StUF:extraElement>
 
      <StUF:extraElement naam="identificatieTGO">0716010000028347</StUF:extraElement>
 
      <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraatt</StUF:extraElement>
 
      <StUF:extraElement naam="identificatieAOA">0716200000762034</StUF:extraElement>
 
      <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
 
      </BG:extraElementen>
 
    </BG:ADR>
 
    </BG:PRSADRVBL>
 
  </BG:PRS>
 
  </BG:body>
 
</BG:kennisgevingsBericht>
 
</soapenv:Body></soapenv:Envelope>
 
</pre>
 
''LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid''
 
 
 
=== StUF-ADR ===
 
 
 
===== StUF-ADR attributes =====
 
 
 
<pre>
 
        required    => [qw/
 
            identificatie
 
            woonplaats
 
            openbareruimte
 
            postcode
 
            huisnummer
 
            status
 
            inonderzoek
 
        /],
 
        optional    => [qw/
 
            huisletter
 
            huisnummertoevoeging
 
 
 
            correctie
 
            documentnummer
 
            documentdatum
 
            type
 
            einddatum
 
            gebruiksobject_id
 
            woonplaats_naam
 
            straatnaam
 
            officieel
 
            begindatum
 
        /],
 
</pre>
 
 
 
===== StUF-ADR example message =====
 
 
 
<pre>
 
    <BG:kennisgevingsBericht xmlns:BG="http://www.egem.nl/StUF/sector/bg/0204" xmlns:StUF="http://www.egem.nl/StUF/StUF0204" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
      <StUF:stuurgegevens xmlns="http://www.egem.nl/StUF/StUF0204">
 
        <StUF:berichtsoort>Lk01</StUF:berichtsoort>
 
        <StUF:entiteittype>ADR</StUF:entiteittype>
 
        <StUF:sectormodel>BG</StUF:sectormodel>
 
        <StUF:versieStUF>0204</StUF:versieStUF>
 
        <StUF:versieSectormodel>0204</StUF:versieSectormodel>
 
        <StUF:zender>
 
          <StUF:applicatie>ZNDAPP</StUF:applicatie>
 
        </StUF:zender>
 
        <StUF:ontvanger>
 
          <StUF:applicatie>ONTVAPP</StUF:applicatie>
 
        </StUF:ontvanger>
 
        <StUF:referentienummer>ZS0000000001</StUF:referentienummer>
 
        <StUF:tijdstipBericht>2012112316002368</StUF:tijdstipBericht>
 
        <StUF:kennisgeving>
 
          <StUF:mutatiesoort>T</StUF:mutatiesoort>
 
          <StUF:indicatorOvername>V</StUF:indicatorOvername>
 
        </StUF:kennisgeving>
 
      </StUF:stuurgegevens>
 
      <BG:body xmlns="http://www.egem.nl/StUF/sector/bg/0204">
 
        <BG:ADR StUF:sleutelGegevensbeheer="27178" StUF:sleutelVerzendend="27178" StUF:verwerkingssoort="T" soortEntiteit="F">
 
          <BG:postcode>1015XK</BG:postcode>
 
          <BG:woonplaatsnaam>Amsterdam</BG:woonplaatsnaam>
 
          <BG:straatnaam>Donker Curtiusstraat</BG:straatnaam>
 
          <BG:huisnummer>7</BG:huisnummer>
 
          <BG:huisletter></BG:huisletter>
 
          <BG:huisnummertoevoeging>414</BG:huisnummertoevoeging>
 
          <BG:aanduidingBijHuisnummer StUF:noValue="geenWaarde" xsi:nil="true"/>
 
          <BG:locatieomschrijving StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
 
          <BG:locatieadresnummer StUF:noValue="nietGeautoriseerd" xsi:nil="true"/>
 
          <BG:ingangsdatum>20070403</BG:ingangsdatum>
 
          <BG:einddatum StUF:noValue="geenWaarde" xsi:nil="true"/>
 
          <BG:straatcode>9999</BG:straatcode>
 
          <BG:buurtcode>0</BG:buurtcode>
 
          <BG:wijkcode>0</BG:wijkcode>
 
          <BG:gemeentecode>363</BG:gemeentecode>
 
          <BG:tijdvakGeldigheid>
 
            <StUF:begindatumTijdvakGeldigheid>20100302</StUF:begindatumTijdvakGeldigheid>
 
            <StUF:einddatumTijdvakGeldigheid StUF:noValue="geenWaarde" xsi:nil="true"/>
 
          </BG:tijdvakGeldigheid>
 
          <BG:extraElementen>
 
            <StUF:extraElement naam="officieleStraatnaam">Donker Curtiusstraat</StUF:extraElement>
 
            <StUF:extraElement naam="aanduidingGegevensInOnderzoek">N</StUF:extraElement>
 
            <StUF:extraElement naam="identificatieNummerAanduiding">0363200000756684</StUF:extraElement>
 
            <StUF:extraElement naam="authentiekeIdentificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
 
            <StUF:extraElement naam="authentiekeIdentificatieWoonplaats">1024</StUF:extraElement>
 
            <StUF:extraElement naam="authentiekeWoonplaatsnaam">Amsterdam</StUF:extraElement>
 
            <StUF:extraElement naam="statusCodeOmschrijving">Naamgeving uitgegeven</StUF:extraElement>
 
            <StUF:extraElement naam="identificatiecodeVerblijfplaats">0363010000032757</StUF:extraElement>
 
            <StUF:extraElement naam="status">Naamgeving uitgegeven</StUF:extraElement>
 
            <StUF:extraElement naam="identificatieTGO">0363010000032757</StUF:extraElement>
 
            <StUF:extraElement naam="identificatieWoonplaats">1024</StUF:extraElement>
 
            <StUF:extraElement naam="openbareRuimteNaam">Donker Curtiusstraat</StUF:extraElement>
 
            <StUF:extraElement naam="identificatieAOA">0363200000756684</StUF:extraElement>
 
            <StUF:extraElement naam="identificatieOpenbareRuimte">0363300000000059</StUF:extraElement>
 
            <StUF:extraElement naam="woonplaatsNaamBAG">Amsterdam</StUF:extraElement>
 
          </BG:extraElementen>
 
        </BG:ADR>
 
      </BG:body>
 
    </BG:kennisgevingsBericht>
 
</pre>
 
''LET OP: Bovenstaande gegevens zijn geen reflectie van de werkelijkheid''
 
 
 
=== StUF-VBO ===
 
=== StUF-NNP ===
 
=== Telefooncentrale ===
 
=== Scanstraat ===
 
Wanneer deze koppeling actief is kunnen ingescande documenten in het zaaksysteem worden weergegeven in de documentintake. Vanuit de documentintake kunnen deze vervolgens in zaken geplaatst worden.<br>
 
<br>
 
Elke minuut zal het zaaksysteem alle documenten die zich in een toegewezen map op de beheerbox van de gemeente bevinden kopiëren naar de documentintake in het zaaksysteem. De gemeente kan de scanners dusdanig configureren dat er een optie op de scanners aanwezig is waardoor gescande documenten direct in deze map zullen worden geplaatst.<br>
 
<br>
 
Let op: De documentintake is enkel zichtbaar voor medewerkers met de rollen: Administrator, zaaksysteembeheerder en zaakbeheerder.
 
 
 
=== WOZ-import ===
 
=== Zaakinformatie bevragen ===
 
===== Korte uitleg (Zaken obv JSON) =====
 
Zaaksysteem biedt een mogelijk om zaakinformatie op te vragen van zaken die door middel van een publieke zoekopdracht te benaderen. De resultaten (zaakinformtie) van deze zoekopdracht worden terug gegeven in JSON-formaat en kunnen daarna gepresenteerd worden bijvoorbeeld door een CMS.<br>
 
<br>
 
===== Welke data kan opgevraagd worden? =====
 
De resultaten van zaken in een (publiek gepubliceerde) zoekopdracht. Hierbij is een set van gegevens op te vragen, namelijk:<br>
 
 
 
* Zaaknummer (zaak.id)
 
* Zaaktype (zaaktype.naam)
 
* Registratiedatum
 
* Afhandeldatum
 
* Status (zaak.status)
 
* Fase (naam)
 
* Extra informatie (zaak.onderwerp)
 
* Resultaat (zaak.resultaat)
 
<br>
 
===== Hoe wordt de data ontvangen? =====
 
De data wordt gerouterneerd in JSON formaat. De zaken zelf staan in de property 'result', wat altijd een array is. In het geval van een foutmelding is het eerste object in de 'result' array een foutmeldingobject. In principe wordt de HTTP status code in dit geval ook op 500 gezet. Deze status code zit ook in het antwoord in de property 'status_code'. In de properties 'next' en 'prev' staan de URLs waarmee volgende en vorige pagina's kunnen worden opgevraagd, 'at' is de huidige pagina, 'num_rows' het totaal aantal zaken wat aan de zoekopdrachten voldoet, en 'rows' is het aantal zaken wat in dit antwoord wordt teruggegeven.<br>
 
<br>
 
===== Hoe kan data worden bevraagd? =====
 
De url van de call is {host}/public/search_case/?search_query_id={id}, waarbij {host} bijvoorbeeld 'https://mintlab.zaalsysteem.nl' is, en {id} het id van de gepubliceerde zoekopdracht.<br>
 
<br>
 
===== Hoe moet data worden verwerkt? =====
 
De data komt terug in een JSON string, die geparsed moet worden. De hashes met de kenmerken van de gevonden zaken staan in de property 'result' in een array.<br>
 
<br>
 
===== Voorbeeldvraag =====
 
https://quarterly.zaaksysteem.nl/public/search_case/?search_query_id=1<br>
 
<br>
 
===== Voorbeeldantwoord =====
 
<pre>
 
{
 
"next": null,
 
"comment": "This is not a DBIx::Class::ResultSet and does NOT support paging.",
 
"prev": null,
 
"at": null,
 
"num_rows": 1,
 
"rows": null,
 
"result": [
 
[
 
{
 
"afhandeldatum": null,
 
"zaaktype": "bagtest",
 
"status": "new",
 
"fase": "Naam van Fase komt hier",
 
"onderwerp": null,
 
"registratiedatum": "2013-09-05T12:33:57",
 
"resultaat": null,
 
"id": 155
 
}
 
]
 
]
 
}
 
</pre>
 
 
 
=== Zoekopdracht als kaart publiceren ===
 
Wanneer in de instellingen wordt opgegeven dat de zoekopdracht gepubliceerd moet kunnen worden, kan ook de kaart gepubliceerd worden.<br>
 
<br>
 
[[bestand:Zoekopdracht instellingen.png]]<br>
 
<br>
 
Gebruik hiervoor de volgende link:
 
http://<omgeving>/search/<id>/results/public_map<br>
 
{| class="wikitable"
 
|-
 
! scope="col"| Variabele
 
! scope="col"| Locatie
 
|-
 
| <omgeving>
 
| De gemeentenaam uit de zaaksysteem-URL: <u>gemeentenaam</u>.zaaksysteem.nl
 
|-
 
| <id>
 
| Dit cijfer is terug te vinden in de URL wanneer de zoekopdracht intern bekeken wordt<br>[[bestand:Zoekopdracht URL.png]]
 
|}
 

Huidige versie van 18 mrt 2019 om 18:37

Algemeen

Binnen zaaksysteem.nl is er een generiek koppelplatform met koppelprofielen.. een koppelprofiel bevat logica en mogelijkheden om de koppeling te beheren. Koppelingen die ontwikkeld worden voor organisaties die gebruik maken van het zaaksysteem, worden als koppelprofiel toegevoegd. Dit betekent dat ze vanaf dat moment ook beschikbaar zijn voor andere organisaties. Hoewel het organisaties geheel vrij staat om nieuwe koppelingen in te richten op basis van een koppelprofiel, is er bij veel koppelingen specifieke kennis nodig voor het werkend opleveren van de koppeling. Wij adviseren dan ook om contact op te nemen met Mintlab voor eventuele ondersteuning.

Het onderdeel 'koppelingen' bestaat uit de volgende drie overzichten:

Lijst van koppelingen

- Koppelingen -
Naam Versie Status Toelichting
Active directory 1.0 In gebruik Voor het importeren van gebruikers
Afspraken 1.0 In gebruik Voor koppelingen met Lamson, Qmatic, SuperSaaS
BAG-import 1.0 In gebruik Voor het importeren van de BAG-objecten, met name de adressen
BuitenBeter 1.6 In gebruik Meldingen die worden gedaan via de BuitenBeter App worden als zaken aangemaakt
GWS4ALL 1.0 In gebruik Voor het uitwisselen van gegevens tussen het zaaksysteem en de GWS4ALL applicatie
Key2Burgerzaken 2.1 In gebruik Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Burgerzaken applicatie
Key2Financien Niet meer in gebruik Voor het uitwisselen van gegevens tussen het zaaksysteem en de Key2Financien applicatie
Overheid IO koppelingen 1.0 In gebruik Voor het importeren van organisatiecontacten via OpenKvK
MijnOverheid 3.10 v1.1 In gebruik Voor het versturen van StUF-Zaakberichten naar MijnOverheid
Ogone In gebruik Voor de online betaling bij het online aanvragen van zaken
Publieke zoekopdracht - In gebruik Voor het openbaar toegankelijk maken van het zakenoverzicht van een zoekopdracht
StUF-NPS 3.10 In gebruik
StUF-PRS 2.04 Niet meer in gebruik
StUF adressen 2.04 en 3.10 v1.1 In gebruik
StUF-NNP 2.04 v1.1 In gebruik
StUF-DCR 1.0 In gebruik
Telefooncentrale 1.0 In gebruik Voor het uitwisselen van gegevens tussen het zaaksysteem en de telefooncentrale
Scanstraat 1.2 In gebruik Voor het ontvangen van ingescande documenten
Zaakinformatie bevragen 1.0 In gebruik
I-Navigator 1.5 In gebruik Importmodule voor het importeren van zaaktypen uit de I-Navigator
PDC - Kluwer / SDU 1.1 / 4.0 In gebruik Importmodule voor het importeren van producten en vragen van Kluwer / SDU
SDU Connect 1.0 In gebruik Importmodules voor het importeren en synchroniseren van SDU producten en vragen
Omgevingsloket (OLO) StuF 3.12 In gebruik Koppelprofiel voor het automatisch verwerken van berichtenverkeer uit de OLO
SAML 2.0 Identity Provider SAML 2.0 In gebruik Koppelprofiel voor het inloggen op zaaksysteem via DigiD, eHerkenning, eIDAS en de AD
SAML 2.0 Service Provider SAML 2.0 In gebruik
Uitgaande mailconfiguratie 1.0 In gebruik
Pop3Mailbox 1.0 In gebruik
Inkomende mailafhandeling 1.0 In gebruik
Ingeplande email 1.0 In gebruik Voor het inplannen van e-mails
Kaartconfiguratie 1.0 In gebruik Voor het gebruik van WMS-kaartlaag services
Zaaksysteem API 1.0 In gebruik
Alternatieve authenticatie - In gebruik Voor twofactorauthenticatie
Xential - In gebruik Voor het gebruik van de externe documentgenerator van Xential
StUF-ZKN 3.10 v1.1 In gebruik
StUF-ZKN Consumer 3.10 v1.1 In gebruik
DataB MultiChannel DMS - In gebruik
iWMO en iJW 2.0 In gebruik Voor het versturen en verwerken van beschikkingen op basis van iWMO2.0 en iJW2.0
Next2Know - In gebruik
OpenCage - In gebruik

* Indien u gebruik wilt maken van een koppelprofiel adviseren wij u contact op te nemen met de leverancier voor actuele informatie en mogelijkheden.