SITRAN-UC : Bulk Consultatie

Transcriptie

1 SITRAN-UC-0-4 : Bulk Consultatie BULK CONSULTATIE VAN SITRAN SITRAN-UC-0-4 Bulk consultatie van SITRAN Version V0.00 STATUT document de travail soumis à acceptation Approuvé X PUBLICATION DU DOCUMENT Starteam SITRAN\03Ana-Des\02analyse\UC Description\Analyse détaillée\uc-0-4\sitran-uc-0-4 Bulk consultatie van SITRAN- SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page /0

2 SITRAN-UC-0-4 : Bulk Consultatie HISTORIEK VAN DE WIJZIGINGEN Datum Auteur Versie Beschrijving Nov 2009 V. Bouserie 00.0 Initiële versie Maart 200 V. Bouserie Verwerken opmerkingen workshop van 24/3/200 0 april 200 F. Colpaert 0.00 Peer Review Quality Check + afwerken leverbaar document REFERENTIES N Titel Beschrijving Localisation V. SITRAN-UC-0-40 Unité Personne-FR.doc Ana-Des\02analyse\UC Description\Analyse détaillée\uc 0-40\ SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 2/0

3 SITRAN-UC-0-4 : Bulk Consultatie INHOUDSTAFEL.. VOORWERP VAN HET DOCUMENT DEFINITIES EN AFKORTINGEN BESCHRIJVING VAN HET FUNCTIONELE PACKAGE UC BULK CONSULTATIE VAN SITRAN KORTE BESCHRIJVING ACTORS DIAGRAM VAN DE USE CASE PRE-VOORWAARDEN BASISSTROOM Consulteer signaletiek via bulk interface ALTERNATIEVE STROOM Signaletiek «vervangen door», «opgeslorpt door», «getransfereerd naar», «gefusioneerd met» Geen actief adres of actieve naam gevonden via basisstroom POST-VOORWAARDEN BUSINESS RULES ACTIVITEITENDIAGRAMMA(S) SEQUENCEDIAGRAMMA(S) AANTEKENINGEN...0 SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 3/0

4 SITRAN-UC-0-4 : Bulk Consultatie.. Voorwerp van het document Deze UC beschrijft de interface tussen SITRAN en de toepassingen die de signaletiekgegevens in grote volumes (bulk) consulteren. De aannames die aan de basis van deze UC liggen zijn: De opzoekingsmogelijkheden van de signaletiekgegevens voor volume consultatie zijn beperkt tot opzoekingen via de volgende unieke sleutels in SITRAN: NN, KBO nummer, Bisnummer, pers_idf en u_pers_idf. De consultatie van de signaletiekgegevens is beperkt tot welbepaalde sets van gegevens; niet alle gegevens. De consultatie via de bulk interface zal bvb enkel de actuele gegevens en geen historiek gegevens ondersteunen. De primaire behoefte waaraan de bulk consultatie moet voldoen is: in een beperkt timeframe, de signaletiekgegevens voor een groot aantal unieke sleutels ter beschikking te stellen. De performante ter beschikkingstelling van deze gegevens kan gerealiseerd worden via snelle, opeeenvolgende consultaties van individuele unieke sleutels..2. Definities en afkortingen NN: Uniek identificatienummer voor een Natuurlijke Persoon, toegekend en beheerd door het RijksRegister. BISnummer : Uniek identificatienummer voor een Natuurlijke Persoon, toegekend en beheerd door het KSZ. KBO nummer: Uniek identificatienummer voor een Onderneming of Vestigingseenheid, toegekend door de KruispuntBank voor Ondernemingen. Pers_idf: unieke identificatie voor de signaletiekgevens van een Persoon (Natuurlijke Persoon, Onderneming of Vestiging), toegekend door SITRAN. De pers_idf identificeert de signaletiekgegevens ontvangen van één enkele bron (KBO, RRN, KSZ, manueel). U_Pers_idf: unieke identificatie voor de signaletiekgegevens van een Persoon, ongeacht of er voor deze Persoon één of meerdere bronnen zijn die signaletiekgegevens leveren. Taalkeuze: taal gekozen door de Natuurlijke Persoon of onderneming voor de communicatie met FODFin. Taalrol: taal van de Natuurlijke Persoon of de onderneming, aangeduid door de authentieke bron (RRN, KBO of KSZ) die de signaletiek van de Natuurlijke Persoon of de onderneming beheert. Begrip FODFin FUP KSZ MID NNBis NP RP NPO VE RR RRN STI UC UCP Definitie Federale OverheidsDienst Financiën Finance Unified Process Kruispuntbank van de Sociale Zekerheid Minimale Identificatie Data Nationaal Nummer toegekend door authentieke bron KSZ Natuurlijk Persoon RechtsPersoon Natuurlijke Persoon Onderneming VestigingsEenheid Rijks Register RijksRegister / Régistre National Système de Traitement Intégré Use Case Use Case Point SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 4/0

5 SITRAN-UC-0-4 : Bulk Consultatie 2. BESCHRIJVING VAN HET FUNCTIONELE PACKAGE De UC 0-4 Bulk consultatie van Sitran bevindt zich in het package Toegangslaag\Consultatie in Together. Dit package behandelt alle mogelijke consultatiemogelijkheden voor de signaletiekgegevens. In dit UC document behandelen we enkel de consultatie via de bulk interface; de andere consultatiemogelijkheden worden in specifieke UC documenten beschreven. De bulk consultatie van gegevens bestaat uit het opzoeken en consulteren van de signaletiek gegevens. De bulk interface heeft als doel welbepaalde sets van signaletiekgegevens te verstrekken met een maximale performantie. Daartoe worden specifieke interfaces (toegangsprimitieven) voorzien die de vastgelegde sets van signaletiekgegevens op een efficiënte en performante manier ter beschikking stellen. SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 5/0

6 SITRAN-UC-0-4 : Bulk Consultatie 3. UC BULK CONSULTATIE VAN SITRAN 3.. Korte beschrijving. De primaire behoefte waaraan de bulk consultatie moet voldoen is: in een beperkt timeframe, de signaletiekgegevens voor een groot aantal unieke sleutels ter beschikking te stellen. Daarnaast moet het aantal bewerkingen (business rules) door de applicaties die deze gegevens gebruiken op deze signaletiekgegevens, minimaal zijn. Het liefst moeten deze gegevens kunnen gebruikt worden zonder enige transformatie. Om aan deze vereisten te kunnen voldoen, moeten de behoeften gekend zijn van de toepassingen die deze gegevens nodig hebben, zodat SITRAN kan afgestemd worden op deze specifieke behoeften. Uit de behoeftenstudie van de toepassingen die SITRAN gegevens in grote volumes willen consulteren, is de noodzaak van de dataset bulk mailing weerhouden. Deze dataset is in eerste instantie afgestemd op het verzenden van correspondentie via de post aan de FODFin klanten. De primaire signaletiekgegevens voor de "bulk mailing" dataset zijn: De naam. Voor Natuurlijke Personen zijnde de naam en de voornamen; voor ondernemingen de naam van de sociale zetel, voor vestigingseenheden de commerciële naam. Het adres. Voor Natuurlijke Personen zijnde het domicilieadres; voor ondernemingen het adres van de sociale zetel en voor vestigingseenheden het adres van de vestigingseenheid. De taal. Voor Natuurlijke Personen worden bijkomend aan deze primaire signaletiekgegevens, volgende gegevens toegevoegd: - Het NN - Het geslacht - De geboortedatum - De overlijdensdatum Voor Ondernemingen (Rechtspersonen, Natuurlijke Personen Onderneming of Vestigingseenheden) worden, bijkomend aan deze primaire signaletiekgegevens, volgende gegevens toegevoegd: - Het ondernemingsnummer of vestigingseenheidsnummer - De rechtsvorm Zowel voor de primaire gegevens als voor de bijkomende gegevens worden enkel de actieve gegevens ter beschikking gesteld; geen historiek. Op basis van de resultaten van de behoeftenstudie, mag gesteld worden dat de "bulk mailing" dataset tegemoet zal komen aan de behoeften voor bulkconsultatie voor de overgrote meerderheid van de applicaties. Opmerkingen:. De consultatie via de u_pers_idf zal; in geval van een Natuurlijke Persoon Onderneming, zowel de gegevensset van de Natuurlijke Persoon als het ondernemingsnummer van de Natuurlijke Persoon Onderneming ophalen. 2. Via de u_pers_idf kunnen alle actieve VE s van een onderneming geïdentificeerd worden. De bulk mailing dataset voorziet niet in de mogelijkheid om de signaletiekgegevens van VE s van een SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 6/0

7 SITRAN-UC-0-4 : Bulk Consultatie onderneming op te halen via de u_pers_idf Actors. - DB SITRAN : database SITRAN - Bulk toepassing TO BE : TO BE toepassing die de bulk consultatie gebruikt - Bulk toepassing ASIS : ASIS toepassing die de bulk consultatie gebruikt - Bulk toepassing : generalisatie van de toepassingen die de bulk consultatie gebruiken - Systeem Bulk : Het bulk systeem van SITRAN. Dit is een generalisatie van alle modules die gerealiseerd worden door het project SITRAN om de bulk gegevens te creëren en up to date te houden Diagram van de Use Case. Deze UC kan in een later stadium toegevoegd worden om de performantie te verhogen. Systeem Bulk Creëer en update gedefineerde dataset voor bulk consultatie Definieer dataset voor bulk interface «Database» DB Sitran «include» Bulk toepassingen TO BE Bulk Toegang 0-4 Consulteer dataset via bulk interface Bulk toepassingen ASIS 3.4. Pre-voorwaarden. Om de taal voor de "bulk mailing" dataset te bepalen, moeten de taalkeuze en/of de taalrol van de persoon ingevuld zijn in SITRAN Basisstroom. Om voldoende performantie te kunnen garanderen, wordt in de meeste gevallen de basisstroom uitgevoerd. Uitzonderlijk zal een alternatieve stroom uitgevoerd worden. SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 7/0

8 SITRAN-UC-0-4 : Bulk Consultatie Consulteer signaletiek via bulk interface. Controleer het type van de unieke sleutel waarmee de consultatie gebeurt. (NN, KBO nummer, BISnummer, pers_idf en u_pers_idf zijn de mogelijke types). 2. Haal de gegevensset voor de persoon op. 2. Mogelijkheid : unieke sleutel is NN of BISnummer of pers_idf met type persoon = NP en persoon is «actief» Haal de dataset van de Natuurlijke Personen op voor deze sleutel 2.2 Mogelijkheid 2 : unieke sleutel is KBO nummer of pers_idf met type persoon = RP, NPO of VE en persoon is «actief» Haal de dataset van de Ondernemingen op voor deze sleutel 2.3 Mogelijkheid 3 : unieke sleutel is pers_idf zonder type persoon te specifiëren Haal het type persoon op voor deze pers_idf Mogelijkheid 3a : type persoon = NP en persoon is «actief» Haal de dataset van de Natuurlijke Personen op voor deze sleutel Mogelijkheid 3b : type persoon = RP of type persoon = NPO of type persoon = VE en persoon is «actief» Haal de dataset van de Ondernemingen op voor deze sleutel 2.4 Mogelijkheid 4 : unieke sleutel is u_pers_idf Haal de actieve pers_idf(s) op voor deze u_pers_idf waarvoor het type persoon = NP of RP of NPO Mogelijkheid 4a : één pers_idf gevonden en type persoon = NP Haal de dataset van de Natuurlijke Personen op voor deze pers_idf Mogelijkheid 4b : één pers_idf gevonden en type persoon = RP Haal de dataset van de Ondernemingen op voor deze pers_idf Mogelijkheid 4c : twee pers_idf s gevonden en type persoon = NP en persoon2 = NPO Haal de dataset van de Natuurlijke Personen op voor pers_idf Haal het ondernemingsnummer op voor pers_idf 2. Opmerking : aan een NPO waarvan de oprichter (NP) niet bekend is in SITRAN, wordt geen u_pers_idf toegekend (zie ref[]) 3.6. Alternatieve stroom Signaletiek «vervangen door», «opgeslorpt door», «getransfereerd naar», «gefusioneerd met» De alternatieve stroom wordt uitgevoerd in de gevallen dat een signaltiek «vervangen is door», «opgeslorpt is door», «getransfereerd is naar» of «gefusioneerd is met». In deze gevallen is de persoon die geconsulteerd niet «actief» in de UP (zie ref[]).. Een lege dataset wordt ter beschikking gesteld Geen actief adres of actieve naam gevonden via basisstroom Reden : bvb naam of adres enkel beschikbaar in historiek (bvb stopgezette onderneming, Natuurlijke Personen in het buitenland die hun adres afsluiten, zonder nieuw adres op te geven).. Een lege dataset wordt ter beschikking gesteld Post-voorwaarden Business rules. Voor alle gegevens van de gegevensset worden enkel de actueel geldige gegevens ter beschikking SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 8/0

9 SITRAN-UC-0-4 : Bulk Consultatie gesteld; dit zijn de gegevens die niet geannuleerd zijn en waarvoor de geldigheidsperiode niet werd afgesloten (d_i_fin is null). 2. De consulatie met als sleutel het NN, het BISnummer of de pers_idf van een Natuurlijke Persoon, haalt enkel de signaletiekgegevens van de Natuurlijke Persoon op. 3. De consulatie met als sleutel het KBO nummer of de pers_idf van een onderneming of vestigingseenheid, haalt enkel de signaletiekgegevens van de onderneming of een vestigingseenheid op. 4. De consultatie met als sleutel de u_pers_idf haalt enkel de signaletiekgegevens van de Natuurlijke Persoon of van de onderneming op; niet van de vestigingseenheden. Indien de Natuurlijke Persoon in SITRAN gekend is als de oprichter van een Natuurlijke Persoon Onderneming, dan worden de gegevens van deze Natuurlijke Persoon aangevuld met het ondernemingsnummer van de Natuurlijke Persoon Onderneming. 5. Indien de Natuurlijke Persoon of de onderneming vervangen is door een andere Natuurlijke Persoon of onderneming, dan wordt een lege dataset ter beschikking gesteld. Voor een onderneming die opgeslorpt is door, overgedragen is naar of gefusioneerd is met, wordt een lege dataset ter beschikking gesteld. 6. Bepalen van de naam van een Natuurlijke Persoon De naam van een Natuurlijke Persoon bestaat uit de familienaam en de eerste voornaam; eventueel is er een tweede voornaam. Een Natuurlijke Persoon heeft slechts één geldige naam. Opmerking: indien de naam of de voornaam van de persoon niet bekend is bij de inschrijving in het RRN; dan wordt de naam of voornaam als XXX genoteerd. SITRAN zal deze notatie als geen actieve naam beschouwen en een lege dataset ter beschikking stellen. 7. Bepalen van de sociale benaming van een onderneming of commerciële naam van een vestigingseenheid. De sociale benaming van eenzelfde onderneming of de commerciële naam van eenzelfde vestigingseenheid, kan in 5 verschillende talen genoteerd zijn (Nl, Fr, D, E, Andere), maar er is slechts één geldige naam mogelijk in elk van deze talen. De bulk interface zal alle opgeslagen, geldige namen ophalen. 8. Bepalen van de gegevens voor het domicilieadres: Belgisch adres: indien de 3 talen (Nl, Fr, D) voorhanden zijn in de gegevens, worden de straatnaam en de gemeentenaam in de 3 talen ter beschikking gesteld. Voorhanden in de 3 talen betekent: voor een gestructureerd adres in de traductoren van het RRN, voor een niet-gestructureerd adres in de niet-gestructureerde gegevens. Een Belgisch adres bestaat uit: Postcode, gemeentenaam, straatnaam, huisnummer, bus (= RRN index) Gestructureerd adres (grosso modo RRN) Niet-gestructureerd adres (grosso modo KSZ) Opmerking: het veld T_I_BOITE in de SITRAN databank, bevat niet de RRN index en wordt niet via de bulk mailing ter beschikking gesteld. Buitenlands adres o Landcode (niet de ISO code). Vb. Landcode van België = 50. o Landomschrijving (in Nl, Fr, D indien omschrijving beschikbaar in deze talen in de traductoren van het RRN) o Postadres en/of verblijfplaats 9. Bepalen van de gegevens voor het sociale zetel adres of adres van een vestigingseenheid: Voor een sociale zetel adres of vestigingseenheidadres in België is dit identiek aan het bepalen van een domicilieadres in België. Voor een sociale zetel adres of vestigingseenheidadres in het buitenland is dit voor de landcode en landomschrijving identiek aan een domicilieadres in het buitenland, er is echter geen postadres noch verblijfplaats, maar het sociale zetel adres of vestigingseenheidadres in het buitenland kan aangevuld zijn met een straatnaam en gemeentenaam in het buitenland (ter informatie: alle landcodes van vestigingseenheidadressen in het buitenland zijn = 999, wat onbepaald betekent). SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 9/0

10 SITRAN-UC-0-4 : Bulk Consultatie Opmerking: Deze straatnamen en gemeentenamen in het buitenland, worden door KBO in deze velden genoteerd, maar hun betekenis is niet noodzakelijk een gemeentenaam of straatnaam. 0. Bepalen van de taal van de Natuurlijke Persoon of de Onderneming. In SITRAN kunnen 2 taalcodes voor elke Persoon (NP of RP) bewaard worden. De ene taalcode is deze die door de betrokkene aangeduid werd als zijn taalkeuze en diie gebruikt wordt voor communicaties met FODFin. De taalkeuze is een gegeven dat door FODFin beheerd wordt. De andere taalcode is deze die door de betrokkene aangeduid is als zijn taalrol. Deze taalrol wordt door SITRAN beschouwd als zijnde beheerd door de authentieke bronnen: RRN, KBO, KSZ. Momenteel wordt deze taalrol enkel effectief beheerd door het RRN. Andere authentieke bronnen zoals KBO en KSZ voorzien deze taalrol niet. Bij het toekennen van de taalkeuze verifieert SITRAN dat de taalkeuze in overeenstemming is met de Belgische taalwetgeving. Indien zowel de taalkeuze als de taalrol aangeduid zijn in SITRAN, dan heeft de taalkeuze voorrang op de taalrol. Indien geen van beide aangeduid is, dan kan SITRAN de taal van de persoon niet bepalen en wordt een blanco taal aangeduid.. Bepalen van de rechtsvorm van een Onderneming of vestigingseenheid Voor de rechtsvorm wordt de verkorte omschrijving (bvb. BVBA, NV, enz.) opgehaald in de 3 talen (Nl, Fr, D) Activiteitendiagramma(s). Niet van toepassing Sequencediagramma(s). Niet van toepassing. 3.. Aantekeningen De toegangsrechten tot de signaletiekgegevens via de bulk interface worden gecontroleerd door de «client» applicatie, niet door SITRAN. Tussen SITRAN en de «client» applicaties wordt een application trust gecreëerd. SITRAN-UC-0-4 Bulk consultatie van SITRAN- Version : V0.00 Date : Page 0/0