GEBRUIKERSHANDLEIDING DOMEIN ONDERNEMING PUBLICEERGEANNULEERDEONDERNEMINGEN 2.0

Transcriptie

1 /// Gebruikershandleiding GEBRUIKERSHANDLEIDING DOMEIN ONDERNEMING PUBLICEERGEANNULEERDEONDERNEMINGEN 2.0 Versie /// 2.0 Publicatiedatum ///

2 Informatie Vlaanderen /// Auteur: Elin Vanlierde Datum aanmaak: Wijzigingsdatum: Datum afdruk: Interne bestandsnaam: Gebruikershandleiding PubliceerGeannuleerdeOndernemingen 2.0 Documenthistoriek: Versie Opmerking Datum Auteur Status 0.1 Eerste opzet Michaël Loedts Concept 0.2 Toevoeging voorbeeldbestanden Michaël Loedts Concept 0.3 Review - Opmerkingen toegevoegd Bart Vingerhoets Concept 0.4 Verwerking review Michaël Loedts Concept 1.0 Publicatie Michaël Loedts Finale versie 2.0 Nieuwe lay-out Elin Vanlierde Finale versie 2 /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

3 /// Informatie Vlaanderen INHOUD Inhoud Inleiding Terminologie en afkortingen Doel Opbouw Algemeen Omgevingsinformatie Functionaliteiten Leverancier van de gegevens Gebruiksvoorwaarden Verwante diensten Interface Algemeen Bestandsnaam Publicatie in XML Algemeen XSD Elementen Uitzonderingen Publicatie in csv Algemeen Elementen Codetabellen Werking Verdeling Opties Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

4 Informatie Vlaanderen /// 4.3 Opkuis en logging Beschikbaarheid Gekende problemen Testgegevens Testbestanden Voorbeeldbestanden XML: publicatie met gegevens XML: geen gegevens te publiceren CSV: publicatie met gegevens Contactgegevens /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

5 /// Informatie Vlaanderen 1 INLEIDING 1.1 TERMINOLOGIE EN AFKORTINGEN Term/afkorting KBO VKBO Omschrijving Kruispuntbank ondernemingen Verrijkte kruispuntbank ondernemingen 1.2 DOEL Dit document beschrijft het gebruik en de werking van de publicatie van geannuleerde ondernemingen zoals deze door MAGDA aangeboden wordt. De gepubliceerde gegevens zijn beschikbaar in XML als CSV. Binnen KBO kunnen ondernemingen en vestigingen geannuleerd worden. In feite hebben deze dan nooit bestaan. MAGDA biedt via deze publicatie deze geannuleerde ondernemingen en vestigingen aan, inclusief de datum van annulatie. 1.3 OPBOUW Het algemeen overzicht van de functionaliteiten en het gebruik van deze publicatie is opgenomen in hoofdstuk 2. Hoofdstuk 3 behandelt de interface van de publicatie. Hoofdstuk 4 geeft meer informatie over de werking. Hierbij worden onder meer enkele aandachtspunten, de configuratieparameters, de beschikbaarheid en de gekende problemen aangehaald. Hoofdstuk 5 bevat enkele voorbeelden van het gebruik van de dienst. De contactgegevens zijn opgenomen in hoofdstuk 6. Daar het de eerste versie van de publicatie betreft is er geen hoofdstuk met de wijzigingen tegenover de voorgaande versie. Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

6 Informatie Vlaanderen /// 2 ALGEMEEN 2.1 OMGEVINGSINFORMATIE Naam: PubliceerGeannuleerdeOndernemingen Versie: Classificatie: niet privacygevoelig 2.2 FUNCTIONALITEITEN De PubliceerGeannuleerdeOndernemingen 2.0 laat toe om vanuit VKBO de bij KBO geannuleerde ondernemingen en vestigingen te publiceren in xml- als in csv-formaat. Elke afnemer heeft daarbij de mogelijkheid om in samenspraak met Informatie Vlaanderen te bepalen welke gegevens gevraagd worden, op basis van welke criteria deze geselecteerd moeten worden en met welke frequentie die zouden moeten aangeleverd worden. De gegevens worden na publicatie beschikbaar gesteld op de MAGDA FTP server. De exacte locatie van deze folder en de naam wordt in samenspraak met Informatie Vlaanderen bij aansluiting beslist. De folderstructuur en de manier waarop de gegevens opgehaald kunnen worden, wordt beschreven in de FTP richtlijnen [FTP]. In het geval er geen gegevens geselecteerd zouden worden, wordt er standaard geen bestand aangemaakt, tenzij de afnemer uitdrukkelijk vraagt om in dat geval toch een uitzonderingsbestand aan te leveren. 2.3 LEVERANCIER VAN DE GEGEVENS De oorspronkelijke bron van deze gegevens is de KBO. Informatie Vlaanderen is dan ook afhankelijk van deze bron voor de kwaliteit en de aanlevering van de gegevens. 2.4 GEBRUIKSVOORWAARDEN Afnemers moeten aan volgende voorwaarden voldoen om deze dienst te mogen gebruiken: Toelating tot de publicatie PubliceerGeannuleerdeOndernemingen Toelating tot het MAGDA platform 6 /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

7 /// Informatie Vlaanderen Meer informatie over deze voorwaarden is terug te vinden in het document Machtigingen en toelatingen [MT]. 2.5 VERWANTE DIENSTEN Geen verwante diensten; Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

8 Informatie Vlaanderen /// 3 INTERFACE 3.1 ALGEMEEN De gegevens zijn beschikbaar in zowel XML als CSV en opgebouwd volgens de MAGDA richtlijnen. XML: Bevat een standaard context zoals de andere MAGDA publicaties. Dit naar analogie met de contextbeschrijving voor webservices in het CORVE document voor de afnemers Gebruik MAGDA Webservices. [GMW] CSV: deze is opgebouwd zoals beschreven in de Corve MAGDA algemene richtlijnen VIP FTP server / richtlijnen FTP gebruik. Dit wil zeggen: o Delimiter is ; (punt komma) o Elk gegeven tussen (quotes) o Elk GeannuleerdeOnderneming-element bevindt zich op een nieuwe lijn. Eveneens zijn opties als bundeling, borderelbestand, controlebestand, zippen van publicaties, beschikbaar. Voor meer informatie, zie hoofdstuk Opties. 3.2 BESTANDSNAAM De exacte bestandsnaam wordt meegedeeld tijdens het aansluitingsproces. Deze is steeds onder de vorm prefix_publicatienaam_timestamp.extensie Voorbeeld: Pub_PubliceerGeannuleerdeOndernemingen_ xml 3.3 PUBLICATIE IN XML Algemeen De publicatie bevat een standaard context zoals de andere MAGDA publicaties. Dit naar analogie met de contextbeschrijving voor webservices in het CORVE document voor de afnemers Gebruik MAGDA Webservices. [GMW] 8 /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

9 /// Informatie Vlaanderen De inhoud bestaat uit een publicatie van één of meerdere geannuleerde ondernemingen of vestigingen. Of in geval dat er een uitzonderingsbestand gevraagd werd, kan dit ook de Uitzondering bevatten (zie ook 3.3.4) XSD De bestanden die worden aangeboden op de outputfolder zijn gevalideerd volgens de PubliceerGeannuleerdeOndernemingen Service xsd. De actuele xsd is ter beschikking op aanvraag Elementen Voor een overzicht van alle elementen die in de aangeleverde xml staan en eventuele beperkingen wordt er verwezen naar de XSD. Onderstaande afbeelding toont de elementen vanaf het Inhoud-element. Elke gepubliceerde geannuleerde onderneming komt in een nieuw Onderwerp-element. Er komen geen Metadata-gegevens terug in de publicatie. Element GeannuleerdeOnderneming/ Beschrijving De annulatie van een onderneming of vestiging Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

10 Informatie Vlaanderen /// Ondernemingsnummer Het ondernemingsnummer of vestigingnummer van de geannuleerde onderneming / vestiging. Ondernemingsnummer is steeds met voorloopnul. Datum Datum van annulatie, dit onder de vorm jjjj-mm-dd /GeannuleerdeOnderneming Uitzonderingen Indien er gekozen werd om een uitzonderingsbestand te onvangen, komt er een Uitzondering terug met als foutcode geen gegevens te publiceren. <Uitzonderingen> <Uitzondering xmlns:soap-env=" <Identificatie>15015</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>INFORMATIE</Type> <Tijdstip> <Datum> </Datum> <Tijd>15:56:16</Tijd> </Tijdstip> <Diagnose>Geen te publiceren gegevens</diagnose> </Uitzondering> </Uitzonderingen> 3.4 PUBLICATIE IN CSV Algemeen MAGDA richtlijnen voor CSV worden gevolgd: ISO , alles tussen (quotes), ; (punt komma) als delimiter en elk record op een nieuwe lijn. De CSV één op één met de XSD vanaf het GeannuleerdeOnderneming-element. 10 /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

11 /// Informatie Vlaanderen Voor de inhoudelijke beschrijving wordt bijgevolg verwezen naar het hoofstuk Publicatie in xml. Al de elementen binnen de XSD zijn opgenomen in de CSV. In geval dat er een uitzonderingsbestand gevraagd werd zal het CSV-bestand leeg zijn. Elk Onderwerp-element in een XML resulteert in één csv-record Elementen Nr Element 1 Ondernemingsnummer 2 Datum 3.5 CODETABELLEN Geen codetabellen van toepassing. Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

12 Informatie Vlaanderen /// 4 WERKING 4.1 VERDELING De gegevens worden verdeeld op basis van de criteria die besproken worden tijdens het aansluitingsproces of voorafgaande gesprekken. Verfijnde selecties zijn mogelijk, gelieve hiervoor contact op te nemen met helpdesk.magda@vlaanderen.be. Voorbeelden van dergelijke selecties: enkel ondernemingen uit eigen klantenlijst, ondernemingen uit bepaalde gemeente,. 4.2 OPTIES Volgende afleveropties zijn mogelijk: - compressie van het bestand in.zip - bundeling van bestanden (gezamelijke aflevering van meerdere publicaties) - compressie van de bundeling - borderelbestand (oplijsting afgeleverde bestanden, enkel mogelijk indien bundeling) - uitzonderingsbestand / leeg bestand (indien er geen gegevens te publiceren zijn, verkrijgt men toch een bestand) - controlebestand (bevat een md5, gebruikte encoding, gebruikte en volgende herstartdatum) Voor meer informatie rondom deze afleveropties wordt verwezen naar de beschikbare documentatie. 4.3 OPKUIS EN LOGGING De gegevens in het bestand worden bewaard zoals beschreven in het document MAGDA logging [ML]. Bestanden worden gedurende een beperkte tijd aangeboden op de FTP folder zoals beschreven in de FTP richtlijnen. [FTP] 12 /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

13 /// Informatie Vlaanderen 4.4 BESCHIKBAARHEID MAGDA verwerkt de door KBO verkregen gegevens dagelijks, behalve op zondag en maandag daar er tijdens het weekend geen gegevens gewijzigd worden. De periodiciteit van aanlevering via MAGDA is te bespreken tijdens het aansluitingsproces of voorafgaande besprekingen. Algemeen beschouwd is het mogelijk de gegevens dagelijks, wekelijks, aan te bieden. 4.5 GEKENDE PROBLEMEN Er zijn momenteel geen problemen gekend. Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15

14 Informatie Vlaanderen /// 5 TESTGEGEVENS 5.1 TESTBESTANDEN Testbestanden zijn beschikbaar op aanvraag. 5.2 VOORBEELDBESTANDEN XML: publicatie met gegevens geann_geannond_ rownum_ XML: geen gegevens te publiceren geann_herstart_ge annond_herstart_ CSV: publicatie met gegevens geann_geannond_ rownum_ /// /// Gebruikershandleiding Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0

15 /// Informatie Vlaanderen 6 CONTACTGEGEVENS Informatie Vlaanderen is elke werkdag bereikbaar van 9.00 tot uur. Postadres: Herman Teirlinckgebouw - Havenlaan 88, 1000 Brussel Virginie Lovelinggebouw - Koningin Maria Hendrikaplein 70, 9000 Gent Tel: 02/ helpdesk.magda@vlaanderen.be Gebruikershandleiding - Domein Onderneming PubliceerGeannuleerdeOndernemingen 2.0 /// /// 15