Aquo Domeintabellen Services (Aquo DS) Gebruikershandleiding

Transcriptie

1 Aquo Domeintabellen Services (Aquo DS) Gebruikershandleiding Auteur: Informatiehuis Water

2 Documentbeheer Wijzigingshistorie Datum Versie Auteur Wijziging J.W. van Amelrooij Initiële versie (MX.Systems) J.W. van Amelrooij (MX.Systems) - Gesplitst in een Gebruikers- en een Beheerders-versie; - Schermafbeeldingen toegevoegd; - Diverse kleine aanvullingen/verbeteringen - Commentaar interne review verwerkt. 26 sept H.T. Reitsma (IHW) IHW huisstijl toegepast 27 sept H.T. Reitsma (IHW) Commentaar verwerkt, titel aangepast Review Datum Versie Reviewer Functie 27 sept S. van Kuijck (IHW) Controle en vrijgave Datum Versie Controleur Functie Literatuurbronnen Functioneel Ontwerp Domeintabellensysteem, versie (MX kenmerk P4796-R-1) pagina 2 van 17 Documentbeheer

3 Inhoudsopgave 1. Algemeen Inleiding Standaard functionaliteit Grafische knoppen Uitklapkeuzelijsten Sorteren Filteren Filterresultaat-paginas Geldigheidsperiode/Peildatum Laatste keus als voorzet Thema s, Categorieën en Trefwoorden Navigatieschema voor Raadplegers Schermbeschrijvingen Domeintabellen Overzicht (startscherm) Zoeken Domeintabel Domeintabel raadplegen Domeintabelkolom Domeinwaarden Zoeken over alle domeintabellen Aanvragen nieuwe domeinwaarde Bijlage A XML-formaat 17 Inhoudsopgave pagina 3 van 17

4

5 1. Algemeen 1.1 Inleiding Dit is de handleiding voor gebruikers van het systeem Aquo Domeintabellen Services (Aquo DS). In deze handleiding wordt de functionaliteit van de Aquo DS toegelicht. Aquo DS is te bereiken via de link Het Informatiehuis Water beheert ruim 500 domeintabellen. Al deze domeintabellen zijn opgenomen in Aquo DS. Informatie over de inhoud van de domeintabellen is te vinden in de onderstaande richtlijnen. Deze zijn te vinden op de website Aquo domeintabellen praktijkrichtlijn Praktijkrichtlijn geografie en geometrie Technische richtlijn Aquo uitwisselmodellen Naast deze handleiding is er ook nog een handleiding voor programmeurs waarin beschreven is op welke wijze de webservice gebruikt kan worden om de meest actuele en geldende domeinwaarden en -tabellen in afnemende systemen te synchroniseren. 1.2 Standaard functionaliteit Om niet in herhaling te hoeven vervallen behandelt deze paragraaf alle standaard functionaliteit die, alhoewel niet noodzakelijkerwijs in alle schermen voorkomend, wél altijd op dezelfde manier werkt Grafische knoppen In de verschillende schermen van het systeem wordt consequent gebruik gemaakt van de volgende grafische knoppen: Uiterlijk Functie Zoeken Datum kiezen Pas de opgebouwde Filter-instellingen toe, en toon het resultaat Herstel de default Filter-instellingen Naar scherm Domeinwaarden Exporteer naar CSV-bestand Exporteer naar XML-bestand Mail aanvraag Scherm sluiten Algemeen pagina 5 van 17

6 1.2.2 Uitklapkeuzelijsten Als de beginletter, of mits snel genoeg getypt meerdere beginletters, van de gezochte keuze word(t)/(en) ingetypt zal een uitklapkeuzelijst automatisch naar het eerste item springen dat met die letter(s) begint. Dit is echter een functie van de webbrowser (zoals bijvoorbeeld Internet Explorer), wat betekent dat het bij gebruik van een oude/andere browser kan zijn dat deze functionaliteit ontbreekt Sorteren In lijsten en tabellen is de inhoud bij het openen van een scherm altijd gesorteerd op volgorde van de sleutelwaarden van de desbetreffende gegevens. De sortering is daarbij over het algemeen eerst op kleine letters, en dan op grote letters. Door te klikken op een kolomtitel wordt op die kolom gesorteerd. Nog een keer klikken en de sortering vindt andersom plaats Filteren Het filteren van waarden wordt altijd ongevoelig voor het verschil tussen hoofden kleine letters uitgevoerd. Dus filteren op ab geeft als resultaat (mits het voorkomt, natuurlijk) zowel ab, Ab, ab als AB. Bij filteren kan ook het jokerteken * toegepast worden, wat 0 of meer willekeurige tekens representeert. Dus ab* geeft als resultaat alles dat met (hoofd- of kleine letters) ab begint, terwijl *ab* alles teruggeeft waar de opeenvolging van (hoofd- of kleine) letters a en b in voorkomt Filterresultaat-paginas Daar waar een te tonen filterresultaat potentieel een groot aantal regels omvat wordt dit in (één of) meerdere pagina s gepresenteerd. In die schermen kan dan altijd het aantal regels per pagina ingesteld worden. De geldige waarden daarvoor lopen van 10 tot 999, en als het totaal aantal te tonen regels groter is dan deze waarde zullen onder de getoonde resultaatregels hyperlinks voorkomen naar de overige resultaat-pagina s Geldigheidsperiode/Peildatum Zowel domeintabellen zelf als de domeinwaarden hebben een geldigheidsperiode, die is vastgelegd als en wordt gepresenteerd met een begindatum en een einddatum. Hierbij moet een lege einddatum worden geïnterpreteerd als geldig tot nader order. Als op gegeven moment een domeinwaarde wijzigt, dan zullen de beheerders aan de bestaande waarde een einddatum toekennen, en een nieuwe versie van de domeinwaarde aanmaken met een begindatum die één dag na die einddatum ligt. pagina 6 van 17 Algemeen

7 Een domeinwaarde kan ook verwijderd worden. De domeinwaarde blijft dan in het systeem staan als historische waarde met een einddatum van geldigheid. De geldigheidsperioden van verschillende versies van hetzelfde gegeven zullen dus nooit overlappen. Wel is het, tenminste in theorie, mogelijk dat geldigheidsperioden niet aaneensluiten als het gegeven een tijdje helemaal niet geldig geweest is. Voor domeintabellen geldt hetzelfde, maar zal alleen een nieuwe versie worden gemaakt als de structuur van de tabel wijzigt. Bij het opvragen van gegevens in dit systeem moet normaal gesproken een peildatum worden opgegeven (die nooit in de toekomst mag liggen), en worden alleen resultaten teruggeven waarvan de geldigheidsperioden die peildatum omvat. Dit maakt het mogelijk te achterhalen wat gold op een bepaald moment in het verleden Laatste keus als voorzet In bijna alle gevallen moet bij het selecteren van de gewenste gegevens minimaal een domeintabel en een peildatum worden gespecificeerd. Voor deze twee gegevens wordt telkens de laatst gemaakte keus als voorzetje ingevuld. Als de gebruikerssessie net is gestart (en er dus nog geen vorige keus beschikbaar is), wordt: voor de domeintabel de eerste uit de (alfabetisch gesorteerde) lijst gebruikt, en voor de peildatum de datum van vandaag ingevuld Thema s, Categorieën en Trefwoorden Gezien het grote aantal domeintabellen (momenteel meer dan 500) is extra aandacht besteed aan het toegankelijk maken van de informatie. Hiertoe zijn, naast omschrijvingen per tabel en kolom waarop gezocht kan worden, twee extra zoek-ingangen voor domeintabellen gerealiseerd, namelijk thema s en trefwoorden. Bij elke domeintabel wordt aangegeven tot welk thema deze behoort. De thema indeling wordt bepaald en onderhouden door het Informatiehuis Water. Een domeintabel kan tot meerdere thema s behoren. Daarnaast kunnen aan een domeintabel één of meerdere trefwoorden toegekend zijn. De trefwoorden zelf zijn weer ingedeeld in categorieën, dus om een trefwoord op te geven moet eerst de desbetreffende categorie worden geselecteerd. Algemeen pagina 7 van 17

8 1.3 Navigatieschema voor Raadplegers Onderstaand schema geeft een overzicht van de schermen in dit systeem die voor Raadplegers beschikbaar zijn, en vanuit welke andere schermen ze aangeroepen kunnen worden. Een pijl die naar rechts of beneden loopt representeert de aanroep van een volgend scherm. Heeft de pijl een pijlpunt aan beide uiteinden dan kan vanuit het aangeroepen scherm teruggekeerd worden naar het aanroepende scherm. Ontbreekt de pijlpunt in de terug-richting, dan zal men na sluiting van het aangeroepen scherm weer in het startscherm terecht komen. Startscherm Raadplegen / Domeintabel Zoeken Domeinwaarde Domeinkolom Raadplegen Domeinwaarden Aanvraag nieuwe Domeinwaarde Zoeken Domeintabel pagina 8 van 17 Algemeen

9 2. Schermbeschrijvingen 2.1 Domeintabellen Overzicht (startscherm) Dit openings-scherm dient voor de toegang tot de verschillende functies van het systeem. Rechtsboven in het hoekje staat een Info link waarmee identificerende gegevens over de versie van het systeem getoond kunnen worden. Het scherm is verder verdeeld in een selectiegedeelte bovenaan, waarmee een domeintabel en peildatum worden gekozen, en daaronder een lijstje hyperlinks waarmee de schermen van het systeem kunnen worden aangeroepen. In de bovenste helft: De zoek-knop ( Domeintabel aan. ) naast de uitklapkeuzelijst roept het scherm Zoeken In het lijstje hyperlinks: De keuze van domeintabel en peildatum bovenin is niet relevant voor de links: Zoeken over alle domeintabellen, en Aanvragen. Schermbeschrijvingen pagina 9 van 17

10 2.2 Zoeken Domeintabel Dit scherm dient voor het opzoeken van een specifieke domeintabel. Het scherm bestaat uit twee delen. In de bovenste helft kan een filter-instelling opgebouwd en toegepast worden. Het resultaat daarvan, alle domeintabellen die aan de filter-instelling voldoen, wordt getoond in de onderste helft. In de bovenste helft: Naast de te hanteren peildatum kunnen tot drie andere voorwaarden opgegeven worden, aan elk waarvan de gezochte domeintabel moet voldoen. Voor elk van die drie voorwaarden kan gekozen worden tussen: Keuze van een Thema dat aan de domeintabel moet zijn toegekend; Keuze van een Trefwoord uit een bepaalde Categorie dat aan de domeintabel moet zijn toegekend; Ingave van (een deel van, bij gebruik van het jokerteken *) de naam van een kolom die de gezochte tabel moet bevatten, waarbij niet gekeken wordt naar de meta-kolommen (d.w.z. de onderin dit scherm bij het selectie-resultaat getoonde kolommen); Een selectie op de waarde van één van de meta- of administratieve kolommen (die in dit scherm getoond worden in het selectie-resultaat); Voor de tekstkolommen Tabelnaam en Taal kan daarbij desgewenst het jokerteken * gebruikt worden. Voor de datum-kolommen Datum laatste publicatie, Begindatum geldigheid en Einddatum geldigheid kunnen een van-waarde en een tot-en-met-waarde worden opgegeven, waarbij geldt dat wanneer slechts één van de twee is ingevuld dit wordt opgevat als groter dan of gelijk aan dan wel kleiner dan of gelijk aan. In de onderste helft: Een klik op een tabelnaam zal tot gevolg hebben dat dit scherm wordt gesloten en teruggekeerd wordt naar het aanroepende scherm, met daarin de aangeklikte tabel ingevuld. pagina 10 van 17 Schermbeschrijvingen

11 2.3 Domeintabel raadplegen Als gekozen wordt voor de domeintabel raadplegen, worden de eigenschappen van de (in het startscherm of filter) gekozen tabel getoond. Het grootste deel van het scherm toont de administratieve eigenschappen van de tabel. De twee lijsten rechts bevatten alle aan de tabel toegekende thema s en trefwoorden, terwijl de lijst onderin de kolommen toont waaruit de tabel is opgebouwd. Het resultaat van een klik op één van de URL-hyperlinks zal worden geopend in een nieuw browserscherm. Een klik op een kolomnaam in de lijst met kolommen roept het scherm Domeinkolom (in raadplegen-modus) aan, waarin de detail-eigenschappen van de desbetreffende kolom worden getoond. Een klik op de knop Domeinwaarden onderin roept het scherm Domeinwaarden (in raadplegen-modus) aan. Hiermee kan de inhoud van de tabel worden geraadpleegd. Schermbeschrijvingen pagina 11 van 17

12 2.4 Domeintabelkolom Met dit scherm kunnen de detail-eigenschappen van een kolom in een domeintabel worden geraadpleegd. De hier getoonde informatie kan relevant zijn bij het specificeren van uit te voeren selecties. pagina 12 van 17 Schermbeschrijvingen

13 2.5 Domeinwaarden Met dit scherm kan de inhoud van een domeintabel worden geraadpleegd. Het scherm bestaat uit twee delen. In de bovenste helft kan een tabel geselecteerd worden en een filter-instelling opgebouwd en toegepast worden. Het resultaat daarvan, alle domeinwaarderijen in de geselecteerde tabel die aan de filter-instelling voldoen, wordt getoond in de onderste helft. In de bovenste helft: De knop Zoeken ( ) naast de uitklapkeuzelijst met de tabelnaam roept het scherm Zoeken Domeintabel aan. De Historie optie vormt een alternatief voor de gebruikelijke filtering op geldigheid op een peildatum. Het geeft naast de op de systeemdatum geldige versies ook alle versies van domeinwaarden die in het verleden geldig geweest zijn. Naast de gekozen filtering op geldigheid (Peildatum/Historie) kunnen tot maximaal drie andere voorwaarden opgegeven worden, aan elk waarvan de gezochte domeinwaarden eveneens moeten voldoen. Deze selectieregels bestaan uit: - Een uitklapkeuzelijst met de namen van de (niet-administratieve) kolommen in de tabel plus een extra optie Eén van de kolommen 1, en 1 Bij toepassing van de optie Eén van de kolommen wordt alleen gezocht in de inhoudelijke domeinwaardekolommen, niet in de administratieve kolommen Begin- en Eind-Datum-Geldigheid, Status en Generatie. Ook numerieke kolommen worden hierbij niet in ogenschouw genomen. Schermbeschrijvingen pagina 13 van 17

14 - Voor tekst-kolommen, én die extra optie, een ingave-veld waarin de gezochte waarde(n), eventueel met gebruikmaking van het * jokerteken, kan worden ingegeven, of - Voor numerieke en datum-kolommen twee ingave-velden, voor een van-waarde en een tot-en-met-waarde. Hiervoor geldt dat als slechts één van deze twee is ingevuld, dit wordt opgevat als groter dan of gelijk aan dan wel kleiner dan of gelijk aan. De knop exporteert het selectie-resultaat naar een bestand in CSVformaat, wat met name geschikt is voor inlezen in Microsoft Excel. De knop exporteert het selectie-resultaat naar een XML-bestand. Zie de bijlage voor een beschrijving van de bestands-structuur. In de onderste helft: De lijst toont de domeinwaarderijen van de gekozen domeintabel. De in de schermafbeelding getoonde kolommen kunnen dus anders zijn. pagina 14 van 17 Schermbeschrijvingen

15 2.6 Zoeken over alle domeintabellen Met dit scherm kan het gehele systeem doorzocht worden op een bepaalde zoekwaarde. Het geeft als resultaat een opsomming van in welke tabellen, en welke kolom(men) daarin, waarden zijn aangetroffen die overeenkomen met de opgegeven zoekwaarde. In de bovenaan in te geven zoekwaarde kan gebruik gemaakt worden van het jokerteken (*). De zoekwaarde mag echter niet alleen uit dit/deze teken(s) bestaan. Klik op het filter om de zoekactie uit te voeren. Met een klik op één van de resultaatregels wordt het scherm Domeinwaarden (uit de vorige paragraaf) aangeroepen voor de desbetreffende domeintabel. Daarbij wordt automatisch het filter zodanig ingesteld en uitgevoerd dat ingezoomd wordt op de gevonden domeinwaarde(n): - Een selectieregel wordt ingesteld op Eén van de kolommen, met daarachter ingevuld de in dit scherm ingegeven zoekwaarde. - De Peildatum optie wordt geselecteerd, en als waarde daarvoor wordt de einddatum van de in dit scherm aangeklikte regel, of als deze leeg is de datum van vandaag, ingevuld. Schermbeschrijvingen pagina 15 van 17

16 2.7 Aanvragen nieuwe domeinwaarde Met behulp van dit scherm kan bij de IHW servicedesk een verzoek tot toevoeging van (een) nieuwe domeinwaarde(n) worden ingediend. Het scherm bestaat inhoudelijk uit drie delen: In het bovenste deel verstrekt u gegevens over uzelf, zodat indien nodig contact met u kan worden opgenomen. In het middelste deel specificeert u de domeinwaarde(n) die u graag toegevoegd zou zien. Daarbij is het de bedoeling dat u: - puntkomma s als veld-scheidingsteken, en - regelovergangen (Enter) als scheiding tussen domeinwaarderijen gebruikt. Dit is hetzelfde formaat als MS-Excel, met Nederlandse instellingen, hanteert voor export naar CSV-bestanden. Voorbeeld 1 (de meeste domeinwaarden bestaan uit weinig kolommen): A;ampère bar;bar B;Beaufort Voorbeeld 2 (enkele domeinwaarden bestaan uit vele kolommen): 17;11DClC3a [ug/l] [NVT] [AW];AW;11DClC3a;NVT;ug/l; 18;1234T4ClBen [mg/kg] [dg] [BS];BS;1234T4ClBen;dg;mg/kg; In het onderste deel kunt u uw verzoek tot toevoeging onderbouwen. Bij keuze van de knop Aanvragen ( ) onderaan zal het ingevulde formulier per naar de beheerders worden verzonden. pagina 16 van 17 Schermbeschrijvingen

17 Bijlage A XML-formaat De XML-bestanden bestaan uit een vaste header en footer (gelijk voor alle domeintabellen). Tussen de header en footer is voor elke domeinwaarderij een tag met de tabelnaam opgenomen. De tabelnaam geeft hier dus niet het begin van de hele domeintabel aan, maar het begin van één domeinwaarderij. Tussen die tabelnaam-tags staat voor elke kolom een tag met de kolomnaam en zijn waarde voor die rij. header <tabelnaam> <kolomnaam1>waarde-van-rij-1-kolom-1</kolomnaam1> <kolomnaam2>waarde-van-rij-1-kolom-2</kolomnaam1> </tabelnaam> <tabelnaam> <kolomnaam1>waarde-van-rij-2-kolom-1</kolomnaam1> <kolomnaam2>waarde-van-rij-2-kolom-2</kolomnaam1> </tabelnaam> footer De gegeven voorzet bij exporteren naar XML voor de bestandsnaam is gelijk aan de tabelnaam gevolgd door de datum van vandaag in formaat eejj_mm_dd aangevuld met de extensie.xml. Voorbeeld: Het bestand eenheid_2011_09_26.xml zou kunnen bevatten: <?xml version="1.0"?> <eenheid> <eenheid>a</eenheid> <domein></domein> <eenheidomschrijving>ampère</eenheidomschrijving> </eenheid> <eenheid> <eenheid>bar</eenheid> <domein></domein> <eenheidomschrijving>bar</eenheidomschrijving> </eenheid> <eenheid> <eenheid>b</eenheid> <domein></domein> <eenheidomschrijving>beaufort</eenheidomschrijving> </eenheid> <eenheid> <eenheid>bq/kg</eenheid> <domein></domein> <eenheidomschrijving>becquerel per kilogram</eenheidomschrijving> </eenheid>. Technisch Het formaat voor een datum/tijd is: CCYY-MM-DDThh:mm:ss Het decimaal scheidingsteken is een punt. Bijlagen pagina 17 van 17