VERA 3.0. Bijlage D.2 - Leeswijzer StUF. Versie: 3.0 Datum: Status: Definitief

Transcriptie

1 VERA 3.0 Bijlage D.2 - Leeswijzer StUF Versie: 3.0 Datum: Status: Definitief Stichting VERA Veenendaal

2 Inhoudsopgave 1 Inleiding StUF toelichting StUF Documentatie StUF In Gebruik StUF Notendop StUF Basics StUF Best Practices StUF Historie Bibliografie... 7 Versiebeheer Versie Datum Toelichting Creatie Aanpassing structuur StUF documentatie Bijlage D.2 - Leeswijzer StUF 2

3 1 Inleiding Stichting VERA heeft er voor gekozen om de standaard StUF van de Nederlandse Gemeenten in te zetten. Deze standaard biedt een goed uitgangspunt om de berichtformaten van VERA verder op te baseren. Dit document bevat de leeswijzer voor de documenten met betrekking op het standaard uitwisselingsformaat (StUF). Deze informatie is met name geschikt voor personen die zich bezighouden met de doorontwikkeling van de VERA standaard. Daarnaast is de informatie in de aangegeven documenten interessant voor ontwikkelaars die berichten volgens de VERA standaard gaan uitwisselen. De informatie zoals deze is opgenomen in de documenten en site van VERA zijn afkomstig van de site van KING (Kwaliteitsinstituut Nederlandse Gemeenten). Zie (KING, sd) voor de locatie van de StUF documenten. De huidige versie van VERA (3.0) maakt gebruik van StUF versie 3.10 patch level 15. Bijlage D.2 - Leeswijzer StUF 3

4 2 StUF toelichting Zonder hier de teksten zoals deze zijn opgenomen in de StUF documenten te herhalen, een korte toelichting op de inzet van StUF door VERA. Zoals in het document StUF basics is te zien, voorziet StUF in een technische uitwerking van berichten. Deze onderlaag, de laag onder het horizontale model, vormt de basis voor de berichtenuitwisseling. En daarmee de basis voor de Vera berichten. In Figuur 2.1 is een voorbeeld te zien hoe de StUF modellen aan elkaar gerelateerd zijn. Figuur 2.1 Modellen binnen StUF VERA zal gebruik maken van deze onderlaag om de berichten te versturen. Daarnaast zal een deel van het horizontale model (niet in figuur 3 opgenomen) worden ingevuld voor zover nu mogelijk. Bijlage D.2 - Leeswijzer StUF 4

5 3 StUF Documentatie Op de website van het Kwaliteits Instituut Nederlandse Gemeenten (KING, sd) wordt een uitgebreide hoeveelheid StUF documentatie (publiek) aangeboden. Echter doordat de site regelmatig aangepast wordt en er op het moment van schrijven van de VERA 3.0 documentatie een (mogelijk) tijdelijke versie van de website online staat, kan het helaas voorkomen dat de gezochte documenten niet op de in hoofdstuk 4 vermelde links te vinden zijn. Naar aanleiding van feedback op eerdere VERA releases is er besloten dat de minimale set aan documentatie welke betrekking heeft op StUF op te nemen in de mappenstructuur. Deze documenten zijn te vinden in de map VERA Bijlage D.3 - XSD's en WSDL's - Definitief : Figuur 3.1 Mappingstructuur StUF documenten Voor de technische invulling van VERA 3.0 is een aantal documenten van StUF gehanteerd. Het gaat om de in tabel 7.2 StUF documentatie genoemde documenten, welke in de volgende paragrafen worden toegelicht. Map en gebruikt bestand 0301\StUF0301.pdf 0301\StUF_Notendop.pdf 0301\StUF_Basics.pdf 0301\StUF_best_practices.pdf Beschreven in paragraaf StUF in gebruik StUF Notendop StUF Basics Stuf Best practices Tabel 3.1 StUF documentatie 3.1 StUF In Gebruik Dit document is een uitgebreide beschrijving van StUF, de standaard, historie en achtergrond informatie. Dit document is zeer uitgebreid en is essentieel om de achtergrond van StUF en de hierop geïmplementeerde VERA entiteiten te begrijpen. 3.2 StUF Notendop In deze korte tekst wordt uitgelegd hoe StUF is opgebouwd. Het document is gedateerd, maar geeft wel hoog over weer wat je kan verwachten binnen StUF aan definities en beschrijvingen. 3.3 StUF Basics Deze presentatie uit 2008 geeft een goed beeld van de positionering van StUF en hoe de standaard is opgebouwd. Daarnaast is aangegeven hoe de vertaling van een model in een schema eruit ziet en welke interactiepatronen er zijn. Tot slot wordt een toelichting gegeven op het horizontale en Bijlage D.2 - Leeswijzer StUF 5

6 verticale model. Dit document is een goede onderlegger geweest voor de VERA implementatie van StUF. 3.4 StUF Best Practices Binnen de StUF best practices (d.d ) worden de ontwerpregels voor StUF-berichten beschreven. Uit deze ontwerpregels zijn keuzen gemaakt wat wel en wat niet geschikt is om in de VERA mee te nemen. Zie bijlage D.5 voor een toelichting op de gemaakte keuzen. Voor een goed begrip van de keuzen die gemaakt zijn is het aan te raden met name dit document grondig te bestuderen. 3.5 StUF Historie StUF maakt onderscheid tussen formele en materiële historie. Vanaf versie 3 maakt VERA ook gebruik van de formele historie, door het mogelijk te maken formele historie middels StUF berichten op te vragen middels Lv05 en Lv06 berichten. Voor een nadere uitleg over het nut, noodzaak en gebruik van deze twee vormen van historie verwijzen we u naar een uitstekend artikel op de website van de StUF standaard onder: Klik aldaar op het derde (3 e ) tabblad Bibliotheek, en daarbinnen op het mapje StUF 3.01 in gebruik. U vindt daar het artikel TheorieHistorie in PDF formaat. Bijlage D.2 - Leeswijzer StUF 6

7 4 Bibliografie KING. (sd). Site Kennisinstituut Nederlandse Gemeenten. Opgehaald van KING. (sd). StUF - Welkom bij de StUF-Community. Opgeroepen op 08 16, 2013, van GEMMA Community: Bijlage D.2 - Leeswijzer StUF 7