Handleiding LRD-Raadpleegmodule (versie 3.4)

Transcriptie

1 1/13 INHOUDSOPGAVE 1 INLEIDING WERKING WEB-INTERFACE Opstarten van de LRD-module Functies LRD-module Bevragen Instellingen Logging Opschonen logging Afsluiten... 13

2 2/13 1 INLEIDING Voor het kunnen bevragen van de Landelijk Raadpleegbare Deelverzameling (LRD) is door T&T een LRD-Raadpleegmodule (afgekort als LRD-module ) vervaardigd. In dit document is een handleiding van de LRD-module opgenomen.

3 3/13 2 WERKING WEB-INTERFACE In dit hoofdstuk wordt de werking van de web-interface uiteengezet. Het is mogelijk dat er bij gebruikers kleine verschillen voorkomen. Deze hebben in de meeste gevallen betrekking op het uiterlijk (achtergrondkleuren, logo s etc.). De werking is in alle gevallen hetzelfde. 2.1 Opstarten van de LRD-module Het opstarten van de LRD-module kan verschillen per installatie. 1. Indien u reeds gebruik maakt van de GBA-webservice van T&T kunt u de module activeren via de knop LRD op het hoofdmenu. 2. Indien u binnen de webservice alleen de LRD-module gebruikt verschijnt een startscherm. Figuur 1 Startscherm van de LRD-module

4 4/13 Indien u nog niet in uw VOA-omgeving bent ingelogd verschijnt een inlog-scherm (zie Figuur 2 Inlog-scherm ). Op dit scherm voert u uw gebruikersnaam en wachtwoord in. Deze heeft u van uw applicatie beheerder of T&T ontvangen. Nadat u deze gegevens heeft ingevoerd, worden ze gecontroleerd in de gebruikerstabel van COMPET&T. Figuur 2 Inlog-scherm 2.2 Functies LRD-module Aan de linkerkant verschijnen een 4-tal menukeuzes: Bevragen Instellingen Logging Afsluiten (alleen als u de LRD-module NIET als onderdeel van de GBA webservice van T&T gebruikt)

5 5/ Bevragen Indien u correct bent ingelogd komt u terecht in het bevragingsscherm. Figuur 3 geeft een toelichting op de indeling van de schermen. In figuur 4 wordt het bevragingsscherm toegelicht. Schermindeling Zie Figuur 3 Schermindeling LRD-module. Rechtsboven in het scherm is het logo van de klant weergegeven. Afhankelijk van de vorm van het logo kunnen de lengte en breedte verhouding van het frame wijzigen. In het menu staan de keuze mogelijkheden, welke behoren bij de getoonde pagina. De mogelijkheden zijn afhankelijk van uw autorisatie als gebruiker. Logo frame: T&T logo Titel frame: T&T logo Klant frame: logo klant Menu frame: hierin verschijnt het menu. Aanwezigheid van keuzes kan afhankelijk zijn van uw autorisatie en het scherm in het rechter frame (voa frame). Voa frame: hierin verschijnt de daadwerkelijke toepassing. Figuur 3 Schermindeling LRD-module

6 6/13 Bevraging Met het bevragings -scherm kan een vraag aan de LRD worden samengesteld en verzonden. Berichtsoort: bepaalt de gevraagde rubrieken. Verwijzing naar standaard berichten in COMPET&T. Dropdown met het soort vraag dat naar de LRD wordt verzonden. Mogelijke waarden: Persoonsvraag en Adresvraag. Intern kenmerk: wordt opgenomen in de logging en vereenvoudigt het terugvinden van een bepaalde vraag/antwoord. Identificerende rubrieken: de ingevulde waarden dienen ter identificatie. Stel de vraag aan de LRD. Meer identificerende rubrieken. Druk op een knop om meer rubrieken getoond te krijgen in dit scherm. In dit voorbeeld is Nationaliteit toegevoegd. Figuur 4 Bevragingsscherm Toelichting (zie figuur 4) Kies bij Vraag de gewenste vraag (de mogelijkheden zijn afhankelijk van uw autorisatie): Persoonsvraag Hiermee kunt u gegevens van één of meerdere personen opvragen. Deze vraag is afgeleid van de ad hoc vraag. Adresvraag: Hiermee kunt u opvragen welke personen woonachtig zijn op bepaalde adressen. Deze vraag is afgeleid van de ad hoc adresvraag. Wanneer het in uw GBA-autorisatie niet is toegestaan ad hoc adresvragen te stellen, is het ook niet mogelijk adresvragen te stellen. Vul een intern kenmerk in. Dit intern kenmerk wordt niet meegezonden in het bericht naar de LRD, maar wordt opgenomen de logging van de LRD-module. Dit vereenvoudigt herkenning van de vraag op een later moment. Dit veld is niet verplicht. Kies een berichtsoort. Dit zijn de standaard berichten zoals u ze in COMPET&T heeft gespecificeerd. Indien gewenst, kan T&T er voor zorgen dat standaard het het eerst gevonden bericht wordt getoond. De gekozen waarde bepaalt de door de LRD te retourneren rubrieken, de zogenaamde gevraagde rubrieken. Zitten in het berichttype rubrieken die niet tot de LRD gegevensset behoren, dan worden deze genegeerd in de vraag naar de LRD.

7 7/13 Vul identificerende gegevens in. De meest gebruikte gegevens staan standaard op het scherm. Wilt u aanvullende identificerende gegevens invoeren, kies dan met een van de groene knoppen voor welke categorie u de aanvullende identificerende rubrieken wilt zien. Druk op de blauwe knop Stel vraag om de samengestelde vraag naar de LRD te versturen. Bent u gebruiker van de GBA webservice van T&T en gebruikt u de LRD-module als onderdeel daarvan, dan heeft u een extra knop. Deze staat links van de knop Stel vraag en stelt u in staat om de LRD-module te verlaten. Na het versturen van de vraag wordt binnen enkele seconden het antwoord getoond. De volgende antwoorden zijn mogelijk (tussen haakjes staat de resultaatcode zoals opgenomen in de logging): LRD resultaat code X: Niet geautoriseerd om LRD te raadplegen (X) Kan een groot aantal oorzaken hebben, waarbij de exacte oorzaak alleen door BPR kan worden achterhaald. Meestal is het wachtwoord niet goed of verlopen. Het kan ook zijn dat u rubrieken vraagt, waarvoor u in de LRD niet bent geautoriseerd. LRD resultaat code G: Geen personen gevonden die voldoen aan het profiel (G) Er zijn geen personen of adressen gevonden die voldoen aan de gestelde vraag. Pas de identificerende gegevens aan. LRD resultaat code P: Er zijn te veel personen of adressen gevonden (P) Er voldoen te veel personen of adressen aan de gestelde vraag. Het maximale aantal personen (of adressen) dat door de LRD wordt geretourneerd is 10 (of mogelijk een ander door BPR vast te stellen maximaal aantal). Scherp de vraag aan. LRD resultaat code T: Zoekopdracht heeft te lang geduurd (T): Indien de LRD de gestelde vraag niet binnen enkele seconden kan afhandelen wordt een foutcode T geretourneerd. U kunt proberen de vraag aan te scherpen of dezelfde vraag nogmaals te verzenden (misschien was het te druk op het LRDsysteem). LRD resultaat code H: Indicatie geheimhouding (H): Wanneer alle personen die zijn gevonden een indicatie geheim hebben wordt foutcode H geretourneerd. Dit geldt alleen maar voor afnemers waarbij de indicatie geheimhouding in de autorisatietabel is opgenomen (waarde 1 heeft). Alleen personen met indicatie geheim 2, 4, 6 of 7 worden in deze vergelijking betrokken. LRD resultaat code Z: geen personen ingeschreven bij een adresvraag (Z): Bij een adresvraag zijn wel adressen gevonden, maar op deze adressen zijn geen personen woonachtig. LRD is niet te benaderen (!): Deze fout wordt door de LRD-module gegenereerd indien de LRD niet te benaderen is. Mogelijk is de LRD uit de lucht. Controleer voor de zekerheid de instellingen van de LRD-module. Er zijn personen gevonden (A). Wordt 1 persoon gevonden, dan wordt scherm Figuur 5 Detail informatie gevraagde persoon getoond. Worden meerdere personen gevonden, dan wordt eerst scherm Figuur 6 Lijst met gevonden personen getoond, waaruit een selectie kan worden gemaakt.

8 8/13 Klik hiertoe op de gezochte persoon en scherm Figuur 5 Detail informatie gevraagde persoon zal verschijnen met de gewenste persoon in detail. Het plaatsen van afnemersindicaties en het stellen van ad hoc (adres)vragen is alleen mogelijk indien in de instellingen van de LRD-module aangegeven is, dat er vervolgberichten aangemaakt mogen worden. Verder zal het plaatsen van afnemersindicaties en het stellen van ad hoc adresvragen alleen mogelijk zijn, indien de gebruiker daartoe bevoegd is. Knoppen om bij de geselecteerde persoon een vervolgvraag aan de GBA te stellen. Informatie uit de LRD van de geselecteerde persoon. Knop om naar de lijst met gevonden personen in het antwoord terug te keren. Knop om terug te keren naar het hoofdmenu van de LRD-module. Knop om de gegevens van de geselecteerde persoon af te drukken. Knoppen om naar eventuele andere personen in hetzelfde antwoord van de LRD te gaan. Figuur 5 Detail informatie gevraagde persoon

9 9/13 Lijst met personen, zoals ze door de LRD zijn geretourneerd. Klik op een regel om detailinfo te bekijken. Knop om naar het hoofdmenu van de LRD-module terug te keren. Toont de gestelde vraag in een popup. Knop om de gegevens van alle gevonden personen af te drukken. Figuur 6 Lijst met gevonden personen

10 10/ Instellingen Met het instellingen scherm (zie Figuur 7 Instellingen LRD-module ) kunnen enkele LRD gerelateerde instellingen worden aangepast. De LRD-module maakt, als onderdeel van COMPET&T, ook gebruik van de instellingen van COMPET&T. Deze dienen via de reguliere weg te worden aangepast (indien noodzakelijk). In de VOA zal tevens de mogelijkheid bestaan om gebruikers van het gebruik van dit scherm uit te sluiten. LRD-module instelling Waarde van de instellingen. Sommige kunnen alleen door T&T worden aangepast. Toelichting op de instelling. Ga met de muis op de knop staan en zie de toelichting. Knop om de waarden op te slaan Figuur 7 Instellingen LRD-module Let op: het wijzigen van de instellingen kan tot het disfunctioneren van de LRDmodule leiden! Eenmaal opgeslagen wijzigingen kunnen niet automatisch worden hersteld.

11 11/13 De instellingen hebben de volgende betekenis. AANTAL-BEVRAGINGEN: Het aantal vragen dat aan de LRD is gesteld. LOGGING Wel (waarde = 1) of geen (waarde = 0) logging bijhouden. Zie Logging. LRD-URL-ADMINISTRATION De URL naar de LRD voor administratieve taken. De enige administratieve taak die momenteel wordt geboden is het wijzigen van het wachtwoord. De URL voor administratieve taken is (momenteel) dezelfde als die voor het stellen van vragen. LRD-URL-SERVICE De URL naar de LRD voor de reguliere bevragingen. LRD-WACHTWOORD Het wachtwoord voor de LRD. Als gebruiker wordt de afnemersindicatie van de afnemer gebruikt. Deze is reeds in COMPET&T opgenomen. LRD-WACHTWOORD-TERMIJN Termijn waarin het wachtwoord geldigheid heeft. Wijzigen van het wachtwoord gebeurt automatisch (gebruik makend van het bestand met wachtwoorden uit COMPET&T). Zodra de wachtwoord termijn wordt overschreden, zal het wachtwoord door de software worden aangepast. De wachtwoord termijn is overschreden als de huidige datum groter is dan de datum waarop het wachtwoord voor het laatst werd aangepast, vermeerderd met de waarde van deze instelling. Het termijn waarop de LRD uw wachtwoord als vervallen beschouwd is 90 dagen. Zorg er daarom voor dat de waarde van deze instelling kleiner is dan 90 dagen. LRD-WACHTWOORD-WIJZIG Datum waarop het wachtwoord van de LRD voor het laatst automatisch is aangepast. MAXIMUM-BEVRAGINGEN Het maximum aantal bevragingen van de LRD. VERVOLG-BERICHTEN Hiermee wordt aangegeven dat antwoorden kunnen worden doorgezet als ad hoc vragen, ad hoc adresvragen of plaatsen afnemersindicatie berichten via het reguliere GBA-netwerk. Wel (waarde = 1) of geen (waarde = 0) mogelijkheid om vervolgberichten aan te kunnen maken. Een aanpassing wordt pas definitief indien u op de Opslaan knop drukt.

12 12/ Logging Afhankelijk van de waarde van de instelling LOGGING worden alle vragen en antwoorden opgeslagen in de logging. Middels deze sectie kunt u de logging raadplegen. Gebruikers kunnen geautoriseerd worden om hun eigen berichten, dan wel de berichten van alle gebruikers via de logging in te zien. Datum en tijd van de bevraging, alsmede naam van de gebruiker Volgnummer van de vraag. Komt overeen met het aantal vragen in de instellingen. Opgegeven kenmerk bij stellen vraag. Druk op de icoontjes om vraag of antwoord te zien. Type vraag: Persoon (Hq01) of Adres (Xq01) Resultaat van de vraag. Zie lijst met mogelijke antwoorden bij sectie Bevraging Figuur 8 Raadplegen logging Het antwoord wordt gepresenteerd op dezelfde wijze als bij het bevragen. 2.6 Opschonen logging Deze functie is aan het menu toegevoegd om LRD-berichten uit de logging te kunnen verwijderen. De LRD-berichten worden opgeschoond tot en met de ingegeven datum. Gebruikers die voor deze functie geautoriseerd zijn, kunnen standaard alleen hun eigen berichten verwijderen. "Master" en speciaal daartoe geautoriseerde gebruikers kunnen alle berichten verwijderen. In webservice-omgevingen met een volledig hoofdmenu wordt het verslag aangemaakt onder de knop DOWNLOAD. In omgevingen met alleen het LRD-menu verschijnt het verslag na afronding in een apart pdf-venster.

13 13/ Afsluiten Met deze knop sluit u de LRD-module af. De knop is alleen zichtbaar als u de LRDmodule als stand-alone toepassing gebruikt en deze niet combineert met de Webservice van T&T. Gebruikt u de laatste oplossing (combinatie) dan zullen alle functies in de LRD-module een Terug -knop hebben, waarmee u terugkeert naar de webservice.