Koppelprofiel Key2Burgerzaken: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(→‎Inrichting extern systeem)
(→‎Kenmerken koppelen)
 
(21 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 2: Regel 2:
  
  
−
= Inleiding =
+
= Algemeen =
−
Dit is een feature die enkele acties uitvoert ten behoeve van verhuizingzaaktypen. De volgende acties kunnen vervolgens automatisch worden uitgevoerd:<br>
+
Het koppelprofiel key2burgerzaken stelt in staat om verhuizingen die in zaaksysteem geregistreerd worden direct in de key2burgerzaken applicatie te registreren, en wanneer deze afgehandeld worden in de applicatie de geregistreerde zaken in zaaksysteem te laten afhandelen.
−
<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>
 
  
 
= Koppelprofiel =
 
= Koppelprofiel =
−
Een uitleg voor het instellen van deze koppeling:<br>
+
Instellingen voor deze koppeling.
−
<ol>
+
 
−
<li>In de configuratie van de koppeling moet een URL worden ingevoerd bij 'Url key2burgerzaken' voor het aansluiten op de key2burgerzaken omgeving.<br>
+
=== Configuratie ===
−
[[bestand:Koppeling verhuizing voorbeeld url.png]]<br>
+
{| class="wikitable"
−
Voorbeeld URL, testomgeving Centric<br>
+
|-
−
<pre>
+
!Instelling
−
http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx
+
!Omschrijving
−
</pre>
+
|-
−
<br>
+
|URL Key2Burgerzaken
−
<li>Op basis van de invoer voor kenmerken in de registratiefase worden kenmerken in de rest van de zaak ingevoerd:<br>
+
|Bijvoorbeeld: <i><nowiki>http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx</nowiki></i>
−
<ul>
+
|-
−
<li>De volgende kenmerken moeten in het verhuiszaaktype aanwezig zijn:<br>
+
|Verhuizingsoort
 +
|Binnengemeentelijk, Buitengemeentelijk
 +
|-
 +
|Actie op verwerkte aanvraag
 +
|Geen actie, Zaak afhandelen
 +
 
 +
Let op: De inrichting van het geselecteerde zaaktype moet zo zijn dat aan alle voorwaarden van de [[Zaakdossier_fase_afronden|Faseovergang]] voldaan is.
 +
|-
 +
|Zaakresultaat op verwerkte aanvraag
 +
|Let op: Moet overeenkomen met een resultaatmogelijkheid van het geselecteerde zaaktype
 +
|-
 +
|Gebruik BAG voor adres verhuizing
 +
|Met deze optie aan kan voor het adres gebruik gemaakt worden van één BAG-kenmerk (aanbevolen). Met deze optie uit moet voor het adres gebruik gemaakt worden van losse tekstkenmerken.
 +
|}
 +
 
 +
=== Zaaktype interface ===
 +
Het zaaktype waar verhuizingen op geregistreerd worden.
 +
 
 +
Let op: Voor het versturen van het bericht 'Verhuizing geregistreerd' aan de key2burgerzaken applicatie moet in het zaaktype ook een [[Zaaktypebeheer_Regels#Verstuur_extern_systeembericht|Extern systeembericht]] ingericht zijn.
 +
 
 +
=== Kenmerken koppelen ===
 +
De volgende kenmerken moeten gekoppeld worden:
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
!Titel
+
!style="width:350px;"|Titel
−
!Registratiefase
+
!style="width:100px;"|Registratiefase
−
!Fase 2+
+
!style="width:100px;"|Fase 2+
−
!Type
+
!style="width:180px;"|Type
−
!Toelichting
+
!style="width:200px;"|Toelichting
 
|-
 
|-
 
|Verhuisdatum
 
|Verhuisdatum
Regel 47: Regel 63:
 
!X
 
!X
 
|
 
|
−
|Opplusbaar tekstveld (of meerdere tekstvelden*)
+
|Opplusbaar tekstveld
−
|Verplicht 8 of 9 cijfers
+
|Verplicht 8 of 9 cijfers<br>
 +
<br>
 +
<nowiki>*Zie ook onderstaande toelichting</nowiki>
 +
|-
 +
|Meeverhuizers.OmschrijvingAangifte
 +
!X
 +
|
 +
|Tekstveld
 +
|*Zie onderstaande toelichting
 
|-
 
|-
 
|Statuscode
 
|Statuscode
Regel 77: Regel 101:
 
!X
 
!X
 
|
 
|
−
|Tekstveld
+
|Tekstveld of systeemkenmerk
 
|Verplicht
 
|Verplicht
 
|-
 
|-
Regel 83: Regel 107:
 
!X
 
!X
 
|
 
|
−
|Tekstveld
+
|Tekstveld of systeemkenmerk
−
|Verplicht
+
|rowspan="2"|Eén van beide verplicht
 
|-
 
|-
 
|Contactgegevens.TelefoonnummerMobiel
 
|Contactgegevens.TelefoonnummerMobiel
Regel 90: Regel 114:
 
|
 
|
 
|Tekstveld of systeemkenmerk
 
|Tekstveld of systeemkenmerk
−
|Verplicht als 'TelefoonnummerPrive' niet verplicht
+
|}
 +
 
 +
{| class="wikitable"
 +
|-
 +
!style="text-align:left;"|Gebruik BAG voor adres verhuizing = aan (aanbevolen)
 +
|-
 +
|style="width:350px;"|Bagadres
 +
!style="width:100px;"|X
 +
|style="width:100px;"|
 +
|style="width:180px;"|Bag-kenmerk (adres)
 +
|style="width:200px;"|Verplicht
 +
|}
 +
 
 +
{| class="wikitable"
 
|-
 
|-
−
!colspan="1"|'Gebruik BAG voor adres verhuizing' = uit (zie optie 5)
+
!style="text-align:left;"|Gebruik BAG voor adres verhuizing = uit
−
!colspan="4"|
 
 
|-
 
|-
−
|Adresgegevens.Postcode
+
|style="width:350px;"|Adresgegevens.Postcode
−
!X
+
!style="width:100px;"|X
−
|
+
|style="width:100px;"|
−
|Tekstveld of systeemkenmerk
+
|style="width:180px;"|Tekstveld of systeemkenmerk
−
|Verplicht
+
|style="width:200px;"|Verplicht
 
|-
 
|-
 
|Adresgegevens.Huisnummer
 
|Adresgegevens.Huisnummer
Regel 124: Regel 160:
 
|Tekstveld of systeemkenmerk
 
|Tekstveld of systeemkenmerk
 
|<nowiki>-</nowiki>
 
|<nowiki>-</nowiki>
 +
|}
 +
 +
{| class="wikitable"
 
|-
 
|-
−
!colspan="1"|'Gebruik BAG voor adres verhuizing' = aan (zie optie 5)
+
!style="width:350px;"|Titel
−
!colspan="4"|  
+
!style="width:100px;"|Registratiefase
 +
!style="width:100px;"|Fase 2+
 +
!style="width:180px;"|Type
 +
!style="width:200px;"|Toelichting
 
|-
 
|-
−
|Bagadres
+
|Adresgegevens.FunctieAdres
 
!X
 
!X
 
|
 
|
−
|Bag-kenmerk (adres)
+
|Tekstveld
−
|Verplicht
+
|<nowiki>-</nowiki>
 
|}
 
|}
−
<i>* Het is mogelijk om voor het opvragen van de BSN-nummers van de meeverhuizers met afzonderlijke kenmerken te werken ondanks dat deze niet allemaal gekoppeld kunnen worden aan de betreffende CSV-categorie. Neem een extra kenmerk op van het type (groot) tekstveld en vul met voorinvulling of een regel 'vul waarde in' de volgende string in: </i><nowiki>[[kenmerk1]],[[kenmerk2]],[[kenmerk3]],etc</nowiki><i>. Koppel dit kenmerk. Bij de export zullen de magicstrings eerst verwerkt worden, zodat de BSN-nummers in de export worden opgenomen.</i>
+
 
 +
===== Meeverhuizers in meerdere kenmerken =====
 +
De BSN's van meeverhuizers moeten kommagescheiden opgegeven worden voor Meeverhuizers.BurgerservicenummersMeeverhuizers. Dit kan op twee manieren:
 +
<ol>
 +
<li>Alle informatie in één opplusbaar kenmerk</li>
 +
<li>De informatie in losse kenmerken
 +
<br>Plus één systeemkenmerk waarin de informatie met magicstring kommagescheiden worden opgebouwd
 +
<br>Plus één systeemkenmerk waarin de betekenis van de informatie wordt opgegeven
 
</li>
 
</li>
−
<li>Vervolgens kunnen de kenmerken worden opgegeven in de configuratie van de koppeling, onder kenmerkmapping:<br>
+
</ol>
 +
 
 +
De laatste optie heeft de voorkeur. Het is hiermee mogelijk om zelf te beheren welke informatie in de export wordt opgenomen, en zelfs om dit dynamisch te maken middels regels.
 +
 
 +
Voorbeeld:
 +
 
 +
{| class="wikitable"
 +
|-
 +
!style="width:200px;"|Kenmerk
 +
!style="width:200px;"|Kenmerktype
 +
!style="width:200px;"|Voorbeeld invulling
 +
!Toelichting
 +
|-
 +
|BSN partner
 +
|Numeriek
 +
|123456789
 +
|
 +
|-
 +
|BSN kind 1
 +
|Numeriek
 +
|111111111
 +
|
 +
|-
 +
|BSN kind 2
 +
|Numeriek
 +
|222222222
 +
|
 +
|-
 +
|BSN kind 3
 +
|Numeriek
 +
|333333333
 +
|
 +
|-
 +
|BSN kind 4
 +
|Numeriek
 +
|444444444
 +
|
 +
|-
 +
|BSN kind 5
 +
|Numeriek
 +
|555555555
 +
|
 +
|-
 +
|BSN gemachtigde
 +
|Numeriek
 +
|121212121
 +
|
 +
|-
 +
|BSN gezaghouder
 +
|Numeriek
 +
|131313131
 +
|
 +
|-
 +
|BSN inwonende ouder
 +
|Numeriek
 +
|141414141
 +
|
 +
|-
 +
|BSN inwonende ouder
 +
|Numeriek
 +
|151515151
 +
|
 +
|-
 +
|OmschrijvingAangifte
 +
|Tekstveld
 +
|P,K,K,K,K,K,G,O,O
 +
|Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.<br>
 
<br>
 
<br>
−
[[bestand:Koppeling verhuizing gegevensmapping.png]]</li>
+
Mogelijke aanduidingen:<br>
 +
P = Partner,<br>
 +
K = Meerderjarig inwonend kind (voor ouders),<br>
 +
M = Meerderjarige gemachtigde,<br>
 +
G = Gezaghouder,<br>
 +
O = Inwonende ouder (voor kind)<br>
 +
|-
 +
|BurgerservicenummersMeeverhuizers
 +
|Tekstveld
 +
|<nowiki>[[bsn_partner]],[[bsn_kind_1]],[[bsn_kind_2]],[[bsn_kind_3]],[[bsn_kind_4]],[[bsn_kind_5]],[[bsn_gemachtigde]],[[bsn_ouder1]],[[bsn_ouder2]]</nowiki>
 +
|Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.<br>
 
<br>
 
<br>
−
<li>Bij het registreren van de zaak zullen de kenmerken worden ingevuld:<br>
+
Let op: Waarden mogen leeg zijn.
−
<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>
 
−
Let op: Een transactie die wordt verstuurd na een periode van inactiviteit zal falen doordat Centric dit bericht niet goed zal ontvangen. De transactie wordt vervolgens voor 10min in de toekomst ingepland en zal dan wel goed worden ontvangen. Het is niet bekend hoe lang de periode van inactiviteit is wil dit zich voordoen.<br>
 
−
 
 
−
= Inrichting extern systeem =
 
−
De inrichting van het externe systeem dient door de gemeente of de leverancier te worden uitgevoerd. Neem voor de zekerheid contact op met uw leverancier voor actuele informatie en mogelijkheden.
 
  
−
= Testscenario =
+
= Transacties =
−
== Koppelprofiel beheren ==
+
Alle transacties zijn inzichtelijk via het transactieoverzicht.
−
== Meldingen behandelen ==
 
−
= Beheer en onderhoud =
 
−
Indien uw gemeente een beheeroverkomst heeft voor het zaaksysteem, dan valt het beheer van het koppelprofiel binnen de overeenkomst. Het beheer van de koppeling aan de kant van het externe systeem dient geregeld te worden met de leverancier.
 
  
−
= Voorbeeldbestanden =
+
Let op: Een transactie die verstuurd wordt na een periode van inactiviteit zal falen doordat Centric dit bericht niet goed zal ontvangen. De transactie wordt vervolgens voor 10min in de toekomst ingepland en zal dan wel goed ontvangen worden. Het is niet bekend hoe lang de periode van inactiviteit is wil dit zich voordoen.
−
= Overige documentatie =
 

Huidige versie van 11 sep 2017 om 13:33


Algemeen

Het koppelprofiel key2burgerzaken stelt in staat om verhuizingen die in zaaksysteem geregistreerd worden direct in de key2burgerzaken applicatie te registreren, en wanneer deze afgehandeld worden in de applicatie de geregistreerde zaken in zaaksysteem te laten afhandelen.

Koppelprofiel

Instellingen voor deze koppeling.

Configuratie

Instelling Omschrijving
URL Key2Burgerzaken Bijvoorbeeld: http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx
Verhuizingsoort Binnengemeentelijk, Buitengemeentelijk
Actie op verwerkte aanvraag Geen actie, Zaak afhandelen

Let op: De inrichting van het geselecteerde zaaktype moet zo zijn dat aan alle voorwaarden van de Faseovergang voldaan is.

Zaakresultaat op verwerkte aanvraag Let op: Moet overeenkomen met een resultaatmogelijkheid van het geselecteerde zaaktype
Gebruik BAG voor adres verhuizing Met deze optie aan kan voor het adres gebruik gemaakt worden van één BAG-kenmerk (aanbevolen). Met deze optie uit moet voor het adres gebruik gemaakt worden van losse tekstkenmerken.

Zaaktype interface

Het zaaktype waar verhuizingen op geregistreerd worden.

Let op: Voor het versturen van het bericht 'Verhuizing geregistreerd' aan de key2burgerzaken applicatie moet in het zaaktype ook een Extern systeembericht ingericht zijn.

Kenmerken koppelen

De volgende kenmerken moeten gekoppeld worden:

Titel Registratiefase Fase 2+ Type Toelichting
Verhuisdatum X Datumkenmerk -
IndicatieInwonend X - -
Meeverhuizers.BurgerservicenummersMeeverhuizers X Opplusbaar tekstveld Verplicht 8 of 9 cijfers


*Zie ook onderstaande toelichting

Meeverhuizers.OmschrijvingAangifte X Tekstveld *Zie onderstaande toelichting
Statuscode X Tekstveld -
Statusomschrijving X Groot tekstveld -
IndicatieMeldenAanBurger X Groot tekstveld -
BackOfficeID X Tekstveld -
Contactgegevens.Emailadres X Tekstveld of systeemkenmerk Verplicht
Contactgegevens.TelefoonnummerPrive X Tekstveld of systeemkenmerk Eén van beide verplicht
Contactgegevens.TelefoonnummerMobiel X Tekstveld of systeemkenmerk
Gebruik BAG voor adres verhuizing = aan (aanbevolen)
Bagadres X Bag-kenmerk (adres) Verplicht
Gebruik BAG voor adres verhuizing = uit
Adresgegevens.Postcode X Tekstveld of systeemkenmerk Verplicht
Adresgegevens.Huisnummer X Tekstveld of systeemkenmerk Verplicht
Adresgegevens.Huisletter X Tekstveld of systeemkenmerk -
Adresgegevens.Huisaanduiding X Tekstveld of systeemkenmerk -
Adresgegevens.Huistoevoeging X Tekstveld of systeemkenmerk -
Titel Registratiefase Fase 2+ Type Toelichting
Adresgegevens.FunctieAdres X Tekstveld -
Meeverhuizers in meerdere kenmerken

De BSN's van meeverhuizers moeten kommagescheiden opgegeven worden voor Meeverhuizers.BurgerservicenummersMeeverhuizers. Dit kan op twee manieren:

  1. Alle informatie in één opplusbaar kenmerk
  2. De informatie in losse kenmerken
    Plus één systeemkenmerk waarin de informatie met magicstring kommagescheiden worden opgebouwd
    Plus één systeemkenmerk waarin de betekenis van de informatie wordt opgegeven

De laatste optie heeft de voorkeur. Het is hiermee mogelijk om zelf te beheren welke informatie in de export wordt opgenomen, en zelfs om dit dynamisch te maken middels regels.

Voorbeeld:

Kenmerk Kenmerktype Voorbeeld invulling Toelichting
BSN partner Numeriek 123456789
BSN kind 1 Numeriek 111111111
BSN kind 2 Numeriek 222222222
BSN kind 3 Numeriek 333333333
BSN kind 4 Numeriek 444444444
BSN kind 5 Numeriek 555555555
BSN gemachtigde Numeriek 121212121
BSN gezaghouder Numeriek 131313131
BSN inwonende ouder Numeriek 141414141
BSN inwonende ouder Numeriek 151515151
OmschrijvingAangifte Tekstveld P,K,K,K,K,K,G,O,O Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.


Mogelijke aanduidingen:
P = Partner,
K = Meerderjarig inwonend kind (voor ouders),
M = Meerderjarige gemachtigde,
G = Gezaghouder,
O = Inwonende ouder (voor kind)

BurgerservicenummersMeeverhuizers Tekstveld [[bsn_partner]],[[bsn_kind_1]],[[bsn_kind_2]],[[bsn_kind_3]],[[bsn_kind_4]],[[bsn_kind_5]],[[bsn_gemachtigde]],[[bsn_ouder1]],[[bsn_ouder2]] Ingesteld als systeemkenmerk, ingevuld middels voorinvulling of regel.


Let op: Waarden mogen leeg zijn.

Transacties

Alle transacties zijn inzichtelijk via het transactieoverzicht.

Let op: Een transactie die verstuurd wordt na een periode van inactiviteit zal falen doordat Centric dit bericht niet goed zal ontvangen. De transactie wordt vervolgens voor 10min in de toekomst ingepland en zal dan wel goed ontvangen worden. Het is niet bekend hoe lang de periode van inactiviteit is wil dit zich voordoen.

Overgenomen van "http://wiki.zaaksysteem.nl/index.php?title=Koppelprofiel_Key2Burgerzaken&oldid=9858"