Koppelprofiel Key2Burgerzaken: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(→‎Inleiding)
(→‎Kenmerken koppelen)
 
(25 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 2: Regel 2:
  
  
−
= Inleiding =
+
= 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.
  
−
Dit is een feature die enkele acties uitvoert ten behoeve van verhuizingzaaktypen. De volgende acties kunnen vervolgens automatisch worden uitgevoerd:<br>
+
= Koppelprofiel =
−
<ul>
+
Instellingen voor deze koppeling.
−
<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>
 
  
−
= Inrichting zaaksysteem =
+
=== Configuratie ===
−
= Inrichting extern systeem =
+
{| class="wikitable"
−
= Testscenario =
+
|-
−
== Koppelprofiel beheren ==
+
!Instelling
−
== Meldingen behandelen ==
+
!Omschrijving
−
= Beheer en onderhoud =
+
|-
−
= Voorbeeldbestanden =
+
|URL Key2Burgerzaken
−
= Overige documentatie =
+
|Bijvoorbeeld: <i><nowiki>http://key2burgerzaken.centric.nl/BOKoppelvlakPIV/PROD/Versie2_0/Service.asmx</nowiki></i>
 +
|-
 +
|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"
 +
|-
 +
!style="width:350px;"|Titel
 +
!style="width:100px;"|Registratiefase
 +
!style="width:100px;"|Fase 2+
 +
!style="width:180px;"|Type
 +
!style="width:200px;"|Toelichting
 +
|-
 +
|Verhuisdatum
 +
!X
 +
|
 +
|Datumkenmerk
 +
|<nowiki>-</nowiki>
 +
|-
 +
|IndicatieInwonend
 +
!X
 +
|
 +
|<nowiki>-</nowiki>
 +
|<nowiki>-</nowiki>
 +
|-
 +
|Meeverhuizers.BurgerservicenummersMeeverhuizers
 +
!X
 +
|
 +
|Opplusbaar tekstveld
 +
|Verplicht 8 of 9 cijfers<br>
 +
<br>
 +
<nowiki>*Zie ook onderstaande toelichting</nowiki>
 +
|-
 +
|Meeverhuizers.OmschrijvingAangifte
 +
!X
 +
|
 +
|Tekstveld
 +
|*Zie onderstaande toelichting
 +
|-
 +
|Statuscode
 +
|
 +
!X
 +
|Tekstveld
 +
|<nowiki>-</nowiki>
 +
|-
 +
|Statusomschrijving
 +
|
 +
!X
 +
|Groot tekstveld
 +
|<nowiki>-</nowiki>
 +
|-
 +
|IndicatieMeldenAanBurger
 +
|
 +
!X
 +
|Groot tekstveld
 +
|<nowiki>-</nowiki>
 +
|-
 +
|BackOfficeID
 +
|
 +
!X
 +
|Tekstveld
 +
|<nowiki>-</nowiki>
 +
|-
 +
|Contactgegevens.Emailadres
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|Verplicht
 +
|-
 +
|Contactgegevens.TelefoonnummerPrive
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|rowspan="2"|Eén van beide verplicht
 +
|-
 +
|Contactgegevens.TelefoonnummerMobiel
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|}
 +
 
 +
{| 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"
 +
|-
 +
!style="text-align:left;"|Gebruik BAG voor adres verhuizing = uit
 +
|-
 +
|style="width:350px;"|Adresgegevens.Postcode
 +
!style="width:100px;"|X
 +
|style="width:100px;"|
 +
|style="width:180px;"|Tekstveld of systeemkenmerk
 +
|style="width:200px;"|Verplicht
 +
|-
 +
|Adresgegevens.Huisnummer
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|Verplicht
 +
|-
 +
|Adresgegevens.Huisletter
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|<nowiki>-</nowiki>
 +
|-
 +
|Adresgegevens.Huisaanduiding
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|<nowiki>-</nowiki>
 +
|-
 +
|Adresgegevens.Huistoevoeging
 +
!X
 +
|
 +
|Tekstveld of systeemkenmerk
 +
|<nowiki>-</nowiki>
 +
|}
 +
 
 +
{| class="wikitable"
 +
|-
 +
!style="width:350px;"|Titel
 +
!style="width:100px;"|Registratiefase
 +
!style="width:100px;"|Fase 2+
 +
!style="width:180px;"|Type
 +
!style="width:200px;"|Toelichting
 +
|-
 +
|Adresgegevens.FunctieAdres
 +
!X
 +
|
 +
|Tekstveld
 +
|<nowiki>-</nowiki>
 +
|}
 +
 
 +
===== 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>
 +
</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>
 +
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>
 +
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.

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"