Extra kenmerken (vrije velden) functionaliteit [Documentatie]

Deze pagina is alleen-lezen. Je kan de broncode bekijken maar niet veranderen. Neem contact op met de beheerder als je denkt dat dit niet klopt.
====== Extra kenmerken (vrije velden) functionaliteit ====== 

Op deze pagina wordt uitgelegd hoe in OpenWave eigen velden te kunnen toevoegen aan zaken en locatiedossiers: de zogenaamde **Extra kenmerken** bij een zaak/locatiedossier. Dit zijn velden bedoeld om informatie bij zaken en locatiedossiers (inrichtingen) te kunnen noteren die niet in de reguliere databasevelden van OpenWave vast te leggen zijn.\\
De functionaliteit heeft vroeger (werkapplicatie van Wave) bestaan onder de naam **Vrije Velden**. De functionaliteit is vanaf versie 1.34 van OpenWave opnieuw beschikbaar gemaakt waarbij de functionaliteit is aangepast en uitgebreid. Met het hernieuwen van de functionaliteit is ervoor gekozen om in het beheer van OpenWave de oude naamgeving //Vrije velden// en //Vrij veldbetekenissen// te behouden. Aan de voorkant (gebruikerskant van OpenWave) is er voor gekozen om niet de term //Vrije velden// maar **Extra kenmerken** te gebruiken. 

De extra kenmerken zijn beschikbaar gemaakt om op te voeren bij:
  * Omgevingszaken
  * APV/Overige zaken
  * Handhanvingszaken 
  * Locatiedossiers (inrichtingen) 

Het kunnen gebruiken van de functionaliteit Extra kenmerken begint met het inrichten van definities in tbvrijeveldenbetekenissen via het beheerportaal en vervolgens het eventueel koppelen van deze betekenissen aan zaaktypes en/of bedrijfsoorten.

Vervolgens kunnen bij de bovengenoemde zaken (en locatiedossiers) extra kenmerken worden aangemaakt. In het detailscherm van de aangemaakte extra kenmerken bij de zaak/locatiedossier kan vervolgens een medewerker/behandelaar de gevraagde extra gegevens opgeven.

===== Beheer Vrije velden =====

In het //beheerportaal-Nieuw// onder kolom Werkbeheer, tegel //Beheer Vrije velden// is de codetabel  tbvrijeveldenbetekenissen te bewerken. Dit zijn de definities van de vrije velden, de zogenaamde **vrij veld betekenissen**.\\
Hier kan per vrij veld definitie het volgende worden opgeven:
  * op welke module het vrije veld van toepassing is (alleen te vullen bij initieel aanmaken van de regel in de codetabel!)
  * om welk soort vrij veld het gaat ( alleen te vullen bij initieel aanmaken van de regel in de codetabel!), waarbij de opties zijn:
      * T (tekst). Bij de zaak/locatiedossier wordt het extra kenmerk getoond als een op te voeren tekst 
      * D (datum). Bij de zaak/locatiedossier wordt het extra kenmerk getoond als een op te voeren datum
      * L (logic).  Bij de zaak/locatiedossier wordt het extra kenmerk getoond als een Keuze-veld waarbij men kan kiezen uit:
        * Ja (T)
        * Nee (F)
        * Nog niet bekend (N)
      * N (numeriek). Bij de zaak/locatiedossier wordt het extra kenmerk getoond als een veld waarin een getal ingevoerd kan worden.
      * Q (query).  Bij de zaak/locatiedossier wordt het extra kenmerk getoond als een drop down keuzelijst. Deze keuzelijst is het resultaat van de query die uitgeschreven wordt bij de vrij veld betekenis
  * bij het aanmaken van een zaak/locatiedossier van deze module er automatisch een extra kenmerk van deze definitie toegevoegd moet worden aan de zaak
  * of het extra kenmerk vaker mag worden opgevoerd bij de zaak/locatiedossier 
  * of het extra kenmerk alleen in het detailscherm van de zaak/locatiedossier opgevoerd mag worden

<adm N.B>
Indien men van oudsher een gevulde tabel tbvrijeveldenbetekenissen heeft, dan zijn deze regels te bewerken (of te laten vervallen) via de beheertegel Beheer Vrije Velden. De regels zijn te herkennen aan tbvrijeveldenbetekenissen.dvcode = ‘OUD_RECORD’. Dit omdat er een nieuw veld dvcode is toegevoegd aan de tabel, waarbij er voor is gekozen om deze te vullen met waarde ‘OUD_RECORD’ voor alle bestaande regels bij de update naar OpenWave versie 1.34
</adm>

Vervolgens kan men ervoor kiezen of men de vrij veld betekenissen nog wilt koppelen aan een zaaktype voor de modules Omgeving, APV/overig of Handhaving) of aan een bedrijfssoort voor Inrichting. Hiervoor zijn bij de genoemde zaaktypes in het beheer, en voor de bedrijfsoorten in het inrichtingbeheer, in het detailscherm van het zaaktype/bedrijfsoort een nieuw blok toegevoegd: **Gekoppeld aan vrij veld betekenissen**. Via de plus- minknop zijn hier vrij veld betekenissen te (ont)koppelen. \\
Zie kopje **Zaaktype en koppeling aan vrij veldbetekenissen** op deze pagina de werking van koppelen aan zaaktype/bedrijfsoorten.


===== Zaaktype en koppeling aan vrij veldbetekenissen =====

Het (eventueel) koppelen van vrij veldbetekenissen vindt plaats in het portaal Zaakbeheer voor Omgeving-, APV/Overig- en handhavingmodule, en in portaal Inrichtingenbeheer voor de inrichtingmodule.\\
In het detailscherm van ofwel de zaaktypes, of wel de bedrijfsoort (via tegel //Inrichting bedrijfsoort//) vindt men het blok **Gekoppeld aan vrij veld-
betekenissen**. In dit blok kan men via de plusknop vrij veldbetekenissen koppelen en ontkoppelen aan het zaaktype/ de bedrijfsoort. Via de minknop kan men een enkele koppeling verwijderen.\\
In het detailscherm van een gekoppeld vrij veldbetekenis wordt getoond de informatie uit tbvrijeveldenbetekenissen die niet gewijzigd mag worden want deze gegevens  liggen vast in de code tabel. Wel kan de omschrijving van de koppeling opgegeven worden evenals de eventuele vervaldatum van de koppeling.\\
Het al dan niet koppelen van vrij veldbetekenissen aan een zaaktype heeft invloed op of er een extra kenmerk van dit type vrij veldbetekenis wordt aangemaakt bij aanmaken van de zaak/inrichting in OpenWave. EN invloed op de te kiezen extra kenmerken bij een zaak/locatiedossier.\\
Hoe dit werkt zie kopjes **Automatisch aanmaken extra kenmerken bij nieuwe zaak/locatiedossier** en **Aanmaken extra kenmerken bij zaak/locatiedossier** op deze pagina.

===== Automatisch aanmaken extra kenmerken bij nieuwe zaak/locatiedossier =====

Bij het aanmaken van een nieuwe zaak die onder de modules Omgeving (W), Handhaving (H) of APV/Overig valt, wordt door de programmatuur gekeken of er ook automatisch Extra kenmerken moeten worden aangemaakt bij de nieuwe zaak. Dit geldt voor handmatig toevoegen van een zaak in OpenWave maar ook voor alle programmatuur waarbij nieuwe zaken aangemaakt worden zoals via de DSO en SWF, aanmaken van zaken via de ZGW API (indien van toepassing), de import acties in OpenWave, vervolgzaken aanmaken etc etc.\\
Dit geldt ook voor het aanmaken van een nieuwe locatiedossier (inrichting) in OpenWave.

De beredenering of/welke Extra kenmerken worden aangemaakt bij een nieuwe zaak/locatiedossier is als volgt:\\
Zijn er niet vervallen gekoppelde vrij veld betekenissen bij het zaaktype/bedrijfsoort:
  * Zo ja, dan 
      * indien er bij deze gekoppelde vrij veld betekenissen aangevinkt is dat automatisch aanmaken van toepassing is, dan wordt op basis van deze, extra kenmerken aangemaakt bij de nieuwe zaak/inrichting
      * indien van de gekoppelde geen met automatisch aanmaken is true dan worden er uiteraard geen extra kenmerken aangemaakt
  * Zo nee (er zijn geen gekoppelde vrij veld betekenissen bij het zaaktype/bedrijfsoort), dan
      *  indien er niet-vervallen vrij veld betekenissen voor de module van de zaak/inrichting zijn waarvoor geldt dat automatisch aanmaken van toepassing is, dan wordt op basis van deze, extra kenmerken aangemaakt bij de nieuwe zaak/inrichting
      * zijn deze er niet dan worden er geen extra kenmerken aangemaakt bij de nieuwe zaak/inrichting

===== Lijstscherm Extra kenmerken bij zaak/locatiedossier =====
Indien er voor de module niet-vervallen vrij veld betekenissen bestaan in het beheer, dan zal bij respectievelijk omgevings-, APV/Overige-, handhaving- en inrichtingsportaal (Locatiedossier) zowel een **tegel Extra kenmerken**, als een **blok in het detailscherm van de zaak/locatiedossier genaamd Extra kenmerken** zichtbaar zijn. \\
Deze tonen beiden een lijst met daarin de extra kenmerken die bij de zaak/locatiedossier aanwezig zijn. Hiervoor moet men wel het recht hebben voor zichtbaarheid van Extra kenmerken (tbomgrechten.dlcomgvrijveldvsb voor omgevingmodule).
Klikken op een regel in de lijst opent het detailscherm waarop de medewerkers de extra kenmerken kunnen vullen/wijzigen. Hiervoor moet men wel wijzigrechten voor extra kenmerken hebben (tbomgrechten.dlcomgvrijveldedt voor omgevingmodule). De rechten zijn in het beheer toe te wijzen per module. 

Het verschil tussen de lijst onder het blok in het detailscherm van een zaak/locatiedossier versus onder de tegel is dat in het detailschermblok alleen de extra kenmerken met eigenschap **In detailscherm bij zaak/inrichting?** aangevinkt te zien EN te kiezen zijn via de plusknop en de drie puntjesknop.\\
In het lijstscherm onder de tegel zijn standaard de extra kenmerken te zien waarvoor eigenschap **In detailscherm bij zaak/inrichting?** niet aangevinkt zijn. Via het filter (alleen zichtbaar op de lijst via de tegel) kan men alle extra kenmerken zichtbaar maken. Bij het aanmaken van extra kenmerken via de lijst onder de tegel mag men uit zowel extra kenmerken met en zonder eigenschap **In detailscherm bij zaak/inrichting?** kiezen.

==== Bijzondere kolommen ====
Eigenlijk zijn bijna alle kolommen in de lijst bijzonder in die zin dat afhankelijk van welk type een extra kenmerk is, de kolom wel of niet gevuld is.
Daarnaast zijn er nog twee kolommen die een icoon tonen indien er extra informatie beschikbaar is.\\
Vandaar de toelichting op alle bijzondere kolommen in de lijst:
  * de tweede kolom in de lijst toont een **vraagteken icoon**, mits er bij de codetabel een toelichting is gevuld (tbvrijeveldenbetekenissen.dvtoelichting). Klikken op het icoon opent een dialog scherm die de inhoud van de toelichting toont aan de medewerker
  * de kolom **Keuze** is alleen gevuld indien het extra kenmerk van type keuze (logic) is. Is dit het geval dan toont de lijst:
      * T indien keuze = 'Ja'
      * F indien keuze = 'Nee'
      * N indien keuze = 'Nog niet bekend'
  * de kolom **Datum** is alleen gevuld indien het extra kenmerk een datum veld betreft en de waarde voor het extra kenmerk is gevuld in het detailscherm 
  * de kolom **Aantal** is alleen gevuld indien het extra kenmerk een numeriek veld betreft en de waarde voor het extra kenmerk is gevuld in het detailscherm 
  * de kolom **Antwoord** toont het veld vwfrmvrijvelden.dvantwoord. Deze is gevuld met de waarde van tbvrijevelden.dvstring indien Tekst OF met de waarde van tbvrijevelden.dvinvoerdropd indien query. Anders leeg
  * de zevende kolom in de lijst toont een **informatie icoon (letter I)**, mits er in het detailscherm bij het extra kenmerk een opmerking is gevuld (tbvrijevelden.dvopmerking). Klikken op het icoon opent een dialog scherm die de inhoud van de opmerking toont aan de medewerker


==== Knoppen op het lijstscherm ====
Er is zijn op de lijst de volgende knoppen aanwezig: 
  * plusknop voor het toevoegen van één extra kenmerk. Zichtbaar indien rechten voor de module om extra kenmerken te mogen aanmaken True is (voor omgeving is dat tbomgrechten.dlcomgvrijveldins).
  * minknop voor het verwijderen van een extra kenmerk. Zichtbaar indien rechten voor de module om extra kenmerken te mogen verwijderen True is (voor omgeving is dat tbomgrechten.dlcomgvrijvelddel).
  * drie puntjesknop voor het toevoegen van meerdere kenmerken in één keer. Zichtbaar indien rechten voor de module om extra kenmerken te mogen aanmaken True is (voor omgeving is dat tbomgrechten.dlcomgvrijveldins).

==== Aanmaken Extra kenmerk via tegel ====

De tegel **Extra kenmerken** bij een zaak/locatiedossier toont een lijst met Extra kenmerken bij de zaak. Deze lijst is standaard gefilterd op het alleen tonen van de extra kenmerken waarvoor eigenschap **In detailscherm bij zaak/inrichting?** NIET aanstaat bij corresponderende soort extra kenmerk in de code tabel (tbvrijeveldenbetekenissen).\\
Het filter rechtsboven op de lijst kan gebruikt worden om de filter uit te vinken zodat zowel de op detailscherm geldende extra kenmerken zichtbaar zijn als die bij de tegel.

Er zijn drie knoppen zichtbaar op het lijstscherm. De minknop werkt hetzelfde als op de lijst die via het detailscherm van de zaak/het locatiedossier te openen is en zal het aangevinkte extra kenmerk verwijderen. \\

De plusknop start de wizard insertExtraKenmerk. \\
In de aanroep wordt meegeven dat de wizard gestart is vanaf de tegel en het gaat om een enkel kenmerk toevoegen. Dit betekent dat aan de medewerker die de wizard start een scherm getoond wordt waarbij er een keuze gemaakt moet worden uit 1 extra kenmerk toevoegen.
Waarvoor geldt dat de keuze bestaat uit alle vrij veldbetekenissen (tbvrijeveldenbetekenissen) die:
  * indien er gekoppelde vrij veld betekenissen zijn bij het zaaktype/ bedrijfsoort, dan deze vrij veld betekenissen mits ze nog niet vervallen zijn
  * anders, indien er geen gekoppelde vrij veld betekenissen zijn bij het zaaktype/ bedrijfsoort, dan alle niet-vervallen vrij veld betekenissen met moduleletter gelijk aan de module van de bovenliggende zaak/locatiedossier
  * daar bovenop geldt de extra restrictie dat als er al een extra kenmerk bestaat bij de zaak/locatiedossier van een vrij veld betekenis, dat deze alleen nog een keer gekozen mag worden indien in de codetabel tbvrijeveldenbetekenissen het kenmerk **Mag vaker?** is aangevinkt.

De drie puntjesknop start ook de wizard insertExtraKenmerk. Echter deze is bedoeld voor het toevoegen van meerdere kenmerken in één keer. In de aanroep achter de knop wordt meegeven dat de wizard gestart is vanaf de tegel en het gaat om een meerdere kenmerken toevoegen. De medewerker krijgt een scherm te zien met daarin aan te vinken vrij veldbetekenissen waarbij gekozen mag worden uit een selectie die hetzelfde is als hierboven geschreven voor de plusknop achter de tegel met enkel kenmerk toevoegen. Het verschil met de plusknop is dat bij de drie puntjesknop men dus meerdere vrij veld betekenissen mag aanvinken. Bij uitvoeren van de wizard wordt dan voor alle aangevinkte vrij veld betekenissen een extra kenmerk aangemaakt bij de zaak/locatiedossier.

<adm warning Zichtbaarheid Extra kenmerk>
Via de aanmaakknoppen bij de lijst achter de tegel Extra kenmerk kan men zowel extra kenmerken met kenmerk 
**In detailscherm bij zaak/inrichting?**, als extra kenmerken zonder deze eigenschap toevoegen aan de zaak.\\
Voor de extra kenmerken met deze eigenschap geldt dat deze pas zichtbaar worden in de lijst Extra kenmerken indien men de filter uitzet voor alleen tonen van extra kenmerken die deze eigenschap niet hebben
</adm>


==== Aanmaken Extra kenmerk via  zaakdetailscherm====
Het blok **Extra kenmerken** bij een zaak/locatiedossier toont een lijst met Extra kenmerken bij de zaak waarvoor geldt dat eigenschap **In detailscherm bij zaak/inrichting?** true is. 

Dezelfde knoppen zijn zichtbaar op de lijst als die op het lijstscherm gestart via de tegel. De minknop werkt hetzelfde als op de lijst die via het detailscherm van de zaak/het locatiedossier te openen is en zal het aangevinkte extra kenmerk verwijderen. \\
De overige twee knoppen werken echter net iets anders:\\

De plusknop start ook hier de wizard insertExtraKenmerk. \\
Maar in de aanroep wordt meegeven dat de wizard gestart is vanaf het detailscherm en het gaat om een enkel kenmerk toevoegen. Dit betekent dat aan de medewerker die de wizard start een scherm getoond wordt waarbij er een keuze gemaakt moet worden uit 1 extra kenmerk toevoegen.
Waarvoor geldt dat de keuze bestaat uit alle vrij veldbetekenissen (tbvrijeveldenbetekenissen) die:
  * indien er gekoppelde vrij veld betekenissen zijn bij het zaaktype/ bedrijfsoort, dan deze vrij veld betekenissen mits ze nog niet vervallen zijn EN waarvoor geldt dat **In detailscherm bij zaak/inrichting?** aangevinkt is
  * anders, indien er geen gekoppelde vrij veld betekenissen zijn bij het zaaktype/ bedrijfsoort, dan alle niet-vervallen vrij veld betekenissen met moduleletter gelijk aan de module van de bovenliggende zaak/locatiedossier EN waarvoor geldt dat **In detailscherm bij zaak/inrichting?** aangevinkt is
  * daar bovenop geldt de extra restrictie dat als er al een extra kenmerk bestaat bij de zaak/locatiedossier van een vrij veld betekenis, dat deze alleen nog een keer gekozen mag worden indien in de codetabel tbvrijeveldenbetekenissen het kenmerk **Mag vaker?** is aangevinkt.

De drie puntjesknop start ook de wizard insertExtraKenmerk. Echter deze is bedoeld voor het toevoegen van meerdere kenmerken in één keer. In de aanroep achter de knop wordt meegeven dat de wizard gestart is vanaf het detailscherm en het gaat om een meerdere kenmerken toevoegen. De medewerker krijgt een scherm te zien met daarin aan te vinken vrij veldbetekenissen waarbij gekozen mag worden uit een selectie die hetzelfde is als hierboven geschreven voor de plusknop achter de tegel met enkel kenmerk toevoegen. Het verschil met de plusknop is dat bij de drie puntjesknop men dus meerdere vrij veld betekenissen mag aanvinken. Bij uitvoeren van de wizard wordt dan voor alle aangevinkte vrij veld betekenissen een extra kenmerk aangemaakt bij de zaak/locatiedossier.


===== Detailscherm Extra kenmerk =====

Na het doorlopen van de wizard insertExtraKenmerk waarbij er een enkel kenmerk wordt aangemaakt of na klikken op een regel in de lijst Extra kenmerken, wordt het detailscherm van het extra kenmerk geopend. In dit scherm kan een extra kenmerk gevuld dan wel gewijzigd worden. Hiervoor moet men wel wijzigrechten voor extra kenmerken hebben (tbomgrechten.dlcomgvrijveldedt voor omgevingmodule). \\

Het detailscherm bestaat uit drie blokken:
  * Titel; Antwoord:
      * In dit blok is altijd aanwezig de id, code en omschrijving van het extra kenmerk zoals beschreven in de codetabel tbvrijeveldenbetekenissen
      * In dit blok is op te geven het extra gegeven wat bij de zaak/locatiedossier genoteerd dient te worden en waarvoor dus het extra kenmerk aangemaakt is: het zogenaamde antwoord. Dit antwoord kan van verschillende type zijn en daarom is er afhankelijk van het type extra kenmerk, een ander antwoord veld zichtbaar:
          * **Datum** zichtbaar indien in de codetabel tbvrijeveldenbetekenissen.dvsoort = 'D'
          * **Getal** zichtbaar indien in de codetabel tbvrijeveldenbetekenissen.dvsoort = 'N'
          * **Keuze** zichtbaar indien in de codetabel tbvrijeveldenbetekenissen.dvsoort = 'L'. Hierbij moet men kiezen uit 'Ja', 'Nee', 'Nog niet bekend'. Indien er nog niet gekozen is dan staat de keuze op 'Nog niet bekend'
          * **Tekst** zichtbaar indien in de codetabel tbvrijeveldenbetekenissen.dvsoort = 'T'
          * **Dropdown** zichtbaar indien in de codetabel tbvrijeveldenbetekenissen.dvsoort = 'Q'. Hierbij moet men kiezen uit een keuzelijst gedefinieerd bij tbvrijeveldenbetekenissen
  * Toelichting: in dit blok staat de toelichting die opgegeven is bij de codetabel (tbvrijeveldenbetekenissen.dvtoelichting). Niet aanpasbaar
  * Opmerking: in dit blok kan men een opmerking plaatsen bij het extra kenmerk. Tevens kan men hier het extra kenmerk laten vervallen
===== Rechten =====
Het inzien, wijzigen, aanmaken en verwijderen van Extra kenmerken bij een zaak/locatiedossier is gebonden aan rechten. Deze zijn per module in te stellen in het beheer van OpenWave bij de Functionele rechten. Dit uiteraard dan bij de modules waarbij Extra kenmerken van toepassing zijn dus:
  * omgeving
  * APV/Overig
  * Handhaving
  * Inrichting (locatiedossier)

De rechten zijn bij uitleveren van 1.34 initieel toegewezen corresponderend aan de algemene rechten per module. Dus medewerkers die zichtbaarheidsrechten hebben voor de module omgeving, mogen Extra kenmerken zien. Diegene die wijzigrechten hebben voor de zaak mogen ook Extra kenmerken wijzigen etc. etc.

{{tag>openwave:1.34:applicatiebeheer:functionaliteiten:vrijevelden}}
{{tag>openwave:1.34:applicatiebeheer:functionaliteiten:extrakenmerken}}