EXT: Producten en diensten catalogus¶

What does it do?¶

This extension enables publication of product and service information on the municipality website. This extension is aimed for the dutch market, therefore this manual will continue in dutch. If you have questions regarding usage, feel free to contact the author.

Wat doet deze extensie?¶

Deze extensie is een implementatie van een producten en diensten catalogus voor het publiceren van informatie over producten en diensten op de gemeentelijke websites. Daarnaast kan deze extensie worden ingezet als een kennisbank, waarbij de content collectie (vraag-antwoordcombinaties) van de overheid gebruikt kan worden.

Deze extensie voldoet aan de eisen gesteld door http://www.e-overheidvoorburgers.nl (voormalig overheid heeft antwoord).

Screenshot¶

Picture 1: Examples

Flexibel inzetbaar¶

Deze extensie is opgezet met de achterliggende gedachten dat deze veelzijdig moet zijn. Hij moet ingezet kunnen worden bij verschillende gemeenten en daarom ook flexibel zijn en makkelijk aan te passen aan de wensen van de gemeente.

Met dat in gedachten is deze extensie opgezet. Er is dan ook veel tijd besteed aan het configureerbaar maken van deze extensie. Dit zorgt ervoor dat deze extensie vrij krachtig is geworden en veel configuratieopties heeft. Deze handleiding legt uit waar de verschillende opties voor zijn en welke waarden hierin verwacht worden.

Deze handleiding gaat niet in op de mogelijkheden van TypoScript zelf, die wel nodig zijn voor het laten werken van de extensie zoals hieronder aangegeven (met in de linkerkolom 1 instantie van de extensie):

Picture 2: Examples

Terminologie¶

Product: Een product of dienst.

Record: Het huidige product wat wordt bewerkt, of een product die in de context van de zin van toepassing is.

Bezoeker: Een niet ingelogde persoon die de website bekijkt (Frontend).

Gebruiker: Een ingelogde gebruiker die de website bekijkt (Frontend).

Administrator: Een ingelogde beheerder (Backend).

Redacteur: Een beheerder met beperkte rechten (Backend).

KCC medewerker: Een gebruiker, die werkzaam is bij het klant contact centrum.

Beheer van product records¶

Dit hoofdstuk zal uitwijden over de (vele) velden die beschikbaar zijn voor een PDC record.

Tabblad Algemeen

Veld: Ingeladen RTE velden

Afbeelding 3: ingeladen RTE velden

Met het veld 'ingeladen RTE velden' is te bepelen welke RTE velden voor dit record ingeladen zullen worden als het record bewerkt wordt. Het doel van dit veld is het versnellen van het inladen / opslaan van het record door minder (browserintensieve) RTE velden te tonen voor het record. De opties 'geen' zorgt ervoor dat er geen RTE veld wordt getoond, de optie 'alle velden' zorgt dat alle RTE velden zijn ingeladen. Veld: Type

Dit veld bevat het type van het record. Dit kan zijn product of dienst.

Sorteergewicht

Dit veld bevat het gewicht van het product. Het gewicht bepaalt hoe hoog het product in zoekresultaten getoond moet worden als er een match is op een zoekterm. Hoe groter dit getal, des te hoger het product in de zoekresultaten tevoorschijn zal komen.

Product unique identifier (owms / zaak)

Een waarde die het product uniek identificeert voor de Samenwerkende Catalogi.

Naam

De naam van het product.

Wijzigingen

In dit veld kunnen notities mbt de wijzigingen van het product worden bijgehouden (voor redacteuren).

Leges

De URL naar een pagina die de leges bevat die bij het product horen.

Leges (tabel)

Content-elementen die de leges voor het betreffende product bevatten.

Doorlooptijd

De duur van de behandeling van het product. Eenheid kan worden afgesproken (seconden, uren, dagen, weken)

Contactadressen

Dit zijn de adressen die getoond worden aan de bezoeker of KCC medewerker. Hiervoor moet de extensie tt_address ook zijn geinstalleerd op deze TYPO3 installatie.

Tabblad Overig

Synoniemen

Hier zijn de synoniemen te selecteren die van toepassing zijn op dit product.

Zoektermen

Hier zijn de zoektermen te selecteren die betrekking hebben op dit product. Deze zoektermen zorgen voor een direct match: Als iemand in de kennisbank zoekt op een van de termen die geselecteerd zijn voor een product, dan zal dit product getoond worden in de zoekresultaten. De positie is afhankelijk van het gewicht en de volgorde van het product in de database.

Vraag-antwoordcombinaties

De aan dit product gekoppelde vraag-antwoordcombinaties. Deze worden getoond bij het product, in de detail weergave van het product. Als een vraag-antwoordcombinatie gevonden wordt bij het zoeken, dan kan het bijbehorende product ook getoond worden in de resultaten (afhankelijk van het gewicht van het product).

Informatie bij vraag-antwoordcombinaties

Extra informatieveld wat getoond wordt bij vraag-antwoordcombinaties.

Afbeelding

Afbeelding die bij het product getoond wordt.

Bijlagen

Documenten die bij het product horen.

Gerelateerde producten

Producten die een relatie hebben met dit product.

Notities

Krabbels/Notities van collega's (KCC medewerkers) over het betreffende product. Achterliggende gedachte is dat men samenwerkt om de burger zo goed mogelijk van dienst te kunnen zijn: hiervoor kunnen specifieke productgerelateerde krabbels zinvol.

Authoriteit (gebruikersgroep)

De frontend gebruikersgroep waar het product bij hoort. Leden van deze groep krijgen alle waarden van het product te zien en zijn ook in staat om krabbels toe te voegen. Ook zijn deze gebruikers in staat om een registratie af te handelen.

Verantwoordelijke gebruiker(s) voor dit product

Frontend gebruikers die toegang hebben tot dit product. Deze gebruikers krijgen alle waarden van het product te zien en zijn ook in staat om krabbels toe te voegen.

Tabblad Links

Aanvraagformulier

Een link naar het aanvraagformulier behorende bij dit product. Dit kan een link naar een interne TYPO3 pagina zijn, echter dit mag ook een externe URL zijn.

Werkinstructies

Een link naar de werkinstructies behorende bij dit product. Dit kan een link naar een interne TYPO3 pagina zijn, echter dit mag ook een externe URL zijn.

Proces beschrijving

Een link naar de producs beschrijving van dit product. Dit kan een link naar een interne TYPO3 pagina zijn, echter dit mag ook een externe URL zijn.

Wet- en regelgeving

Gerelateerde wet- en regelgeving behorende bij dit product. Dit kan een link naar een interne TYPO3 pagina zijn, echter dit mag ook een externe URL zijn.

Bron

Brongegevens voor dit product. Dit kan een link naar een interne TYPO3 pagina zijn, echter dit mag ook een externe URL zijn.

Doelgroep

Doelgroep gedefinieerd door samenwerkende catalogi. Dit kan organisatie / ondernemer of particulier zijn.

Taal

De taal van dit product.

Themas Samenwerkende Catalogi

Een of meerdere thema's die van toepassing zijn op dit product. Minimaal 1 thema moet geselecteerd zijn om het product geldig te laten zijn voor de samenwerkende catalogi.

Gebruikers voor doorverbinden

Hier kunnen gebruikers worden geselecteerd die getoond zullen worden aan KCC medewerkers als zij een product bekijken. KCC medewerkers kunnen dan in een oogopslag zien naar welke gebruikers / afdelingen zij moeten doorverbinden om de burger goed te kunnen helpen met vragen die betrekking hebben op dit product.

De overige tabbladen (Beschrijving, Aanvragen, Extra Informatie, Contact Info, Bijzonderheden, Wettelijke grondslag, Voorwaaren, Resultaten)

Deze tabbladen zijn zichtbaar afhankelijk van de waarde gekozen bij 'ingeladen rte velden' van dit product.

De opbouw van de volgende tabbladen is hetzelfde (afgezien van beschrijving, daar is een extra veld opgenomen wat getoond wordt als korte product-beschrijving in lijsten):

Elk tabblad heeft een 3-tal teksten en een 3-tal checkboxes. Met de checkboxen geef je aan of het eerstvolgende element getoond moet worden.

Afbeelding 4: RTE velden voorbeeld

De indeling is als volgt:

Gebruik tekst voor ...

Tekst voor …

Gebruik generiek tekst

Generieke tekst

Gebruik tekst na ...

Tekst na …

Met deze indeling is heel fijn te bepalen welke teksten van een product getoond moeten worden op de webste en welke niet. Er wordt vanuit gegaan dat in de toekomst de generieke teksten gesynchroniseerd zullen worden met een externe voorziening. Deze teksten mogen (vanwege juridische afspraken) niet gewijzigd worden, daarom is de inhoud van de 'generieke tekst' velden ook niet te wijzigen.

De generieke tekst kan altijd vooraf en achteraf worden aangevuld met een lokale tekst. Daar zijn de 'tekst voor...' en 'tekst na...' velden voor.

Zoekterm¶

De tabel zoekterm bevat de zoektermen die gekoppeld (kunnen) worden aan producten in de PDC. Als een product gekoppeld is aan een zoekterm, dan wordt het product direct vindbaar op die term. Afhankelijk van het 'gewicht' van het product wordt deze hoger in de resultaten weergegeven als er een match is.

Een zoekterm record bevat 2 kolomen:

Verbergen

Hiermee is de zoekterm (tijdelijk ) te verbergen

Zoekterm.

Deze kolom bevat de daadwerkelijke zoekterm.

Synoniem¶

De tabel synoniem bevat synoniemen van elkaar. Een Synoniem kan gekoppeld worden aan 0 of meer andere synoniemen. Een product kan gekoppeld worden aan 0 of meer synoniemen.

Een product is vindbaar via de synoniemen van de gekoppelde synoniemen. Als de synoniem 'paspoort' is gekoppeld aan de synoniem 'identiteitsbewijs' en de synoniem 'paspoort' is gekoppeld aan het product, dan wordt het product gevonden op het woord 'identiteitsbewijs'.

De velden van een synoniem record:

Verbergen

Hiermee is de synoniem (tijdelijk) te verbergen.

Synoniem

De synoniem (het woord zelf)

Gerelateerd aan

De synoniemen waar deze synoniem aan gerelateerd is.

Afhandeling¶

De tabel afhandeling bevat alle afhandelingen die geregistreerd zijn. Hieruit is af te leiden welke stappen een medewerker uitvoert om tot een antwoord te komen, en hoe lang de medewerker hierover doet.

Een afhandeling bevat de volgende kolommen:

Onderwerp vraag

Dit is de actuele zoekvraag die is ingevoerd, of het handmatig opgegeven onderwerp van de vraag (bij handelingen staan ook de vraag vermeld die is ingevoerd).

Begin tijd

Tijd waarop de afhandeling is begonnen (wanneer de vraag is binnengekomen).

Eind tijd

Tijd waarop de afhandeling is afgelopen.

Gesloten (Closed)

Is de afhandeling gesloten? Indien deze niet is aangevinkt kan het zijn dat deze afhandeling nog bezig is.

Resultaat

Het (geselecteerde) resultaat van de afhandeling.

Opmerkingen

Opmerking die geplaatst is door de medewerker mbt de afhandeling.

Handelingen uitgevoerd

De acties die zijn ondernomen om de de vraag af te handelen. Een handeling is een record van het type 'Acties gedaan'. Zie definitie bij 'overige tabellen'.

Vervolgvraag

Eventuele aansluitende vervolgvraag die gesteld is (ander onderwerp).

Door gebruiker

De ingelogde FE user die de afhandeling heeft gedaan.

Statistieken¶

Het is mogelijk om in de PDC te registreren welke producten / vraag- antwoordcombinaties bekeken worden en hoe vaak. Hiervoor wordt de statistiekentabel gebruikt. Deze gegevens worden weer gebruikt in de top-x weergave van de PDC.

Een record van de statistieken tabel bevat de volgende kolommen:

Actie

Wat is er gedaan (product- of VAC bekeken)

VAC (afhankelijk van actie)

De vraag-antwoordcombinatie die is bekeken.

Product (afhankelijk van actie)

Het product wat is bekeken.

Aantal bezichtigingen ingelogd

Hoe vaak het product of VAC record op het registratiemoment is bekeken, door een ingelogde gebruiker.

Totaal aantal bezichtigingen

Hoe vaak het product of VAC record op het registratiemoment is bekeken, ongeacht of de gebruiker was ingelogd of niet.

Registratiemoment

Het moment waarop de registratie telt. Hiervoor wordt een in TypoScript (plugin.tx_ncgovpdc.settings.statistics.timestampFormat) ingestelde grofkorreligheid genomen: des te nauwkeuriger dit moment, des te meer statisiek records er worden aangemaakt – des te nauwkeuriger is te bepalen wanneer wat het meest wordt bekeken. Als dit moment heel onnauwkeurig wordt bijgehouden, dan is er minder gedetailleerd te bepalen wanneer wat het meest wordt bekeken; er worden minder statistiek records aangemaakt dan. De default instelling is dat er per maand wordt bijgehouden hoe vaak de records worden bekeken. Let er op: dit timestamp formaat moet een aansluitend geheel nummer zijn, waarop gesorteerd kan worden (dus yyyymmddhhmmss).

Beheer vraag-antwoordcombinaties (VAC)¶

De PDC biedt de mogelijkheid om de content-collectie van de overheid te gebruiken. Zie hierover: http://www.e-overheidvoorburgers.nl/standaarden,contentmodellen

Er is de mogelijkheid om regelmatig de gegevens te laten downloaden en synchroniseren met de collectie die beheerd wordt door de overheid. Het is ook mogelijk om naast de content-collectie van de overheid een eigen (lokale) verzameling bij te houden.

Een vraag-antwoordcombinatie bestaat uit twee delen:

1- De vraag-antwoordcombinatie

Dit is een soort 'container' waar metadata met betrekking tot de vraag-antwoordcombinatie in wordt opgeslagen. Deze metadata wordt aangeleverd.

2- De vraag-antwoordcombinatie per kanaal

Elke vraag-antwoordcombinatie kan een vraag en antwoord bevatten specifiek gericht op een kanaal. Bijvoorbeeld website of e-mail.

Overige tabellen¶

Revisie

Deze tabel worden de revisies in opgeslagen die gekoppeld zijn aan vraag-antwoordcombinaties, die worden meegeleverd in de feed die de overheid aanbiedt. Het is natuurlijk mogelijk om voor de lokale vraag- antwoordcombinaties de wijzigingen (handmatig) met een revisie record bij te houden, om zo de historie bij te houden.

Log

In de log tabel worden meldingen opgeslagen die kunnen helpen bij de ontwikkeling van de applicatie, of als er iets mis gaat met de applicatie.

Onderwerp

De onderwerp tabel is gekoppeld aan de vraag-antwoordcombinaties. Het is mogelijk om hier zelf records aan toe te voegen, maar dit Is af te raden, aangezien hier in principe alleen onderwerpen inkomen die uit de collectie VraagstructuurRijkThema komen: http://standaarden.overhe id.nl/owms/3.5/doc/waardelijsten/overheid.vraagstructuurrijkthema.html

Tip

De tip tabel bevat alle gebruikers notities van de producten. Het is af te raden om direct via deze tabel records te wijzigen of toe te voegen, dit moet vanuit de gekoppelde producten gebeuren.

Een tip heeft 4 kolommen:

Verbergen

Hiermee is aan te geven of het record getoond mag worden aan de frontend.

Naam

Dit is de naam/ondewerp van de notitie

Beschrijving

Dit is de notitie zelf

Auteur

Dit is de frontend user die de notitie gemaakt heeft.

Acties gedaan

Deze tabel bevat de afzonderlijke handelingen die zijn uitgevoerd bij het afhandelen van een registratie. Het heeft weinig zin om hier zelf records aan toe te voegen.

Deze tabel bevat de kolommen:

Actie

De handeling die is uitgevoerd

Zoekvraag gesteld (afhankelijk van de actie)

Informatie over de zoekvraag die is uitgevoerd.

Product (afhankelijk van de actie)

Het product dat is bekeken.

VAC (afhankelijk van de actie)

De vraag-antwoordcombinatie die is bekeken.

Afhandeling resultaat

Deze tabel bevat de te kiezen resultaten voor een afhandeling bij het registreren van een afhandeling. Het is mogelijk om bestaande resultaten te wijzigen / of hier zelf resultaten aan toe te voegen. Dit record kan worden verborgen om deze niet meer zichtbaar te maken bij het registreren van een afhandeling.

Let op : Er moet altijd een record zijn wat gebruikt wordt als de afhandeling te lang duurt (sessie verlopen is). Het systeem gebruikt dit om afhandelingen automatisch te sluiten als ze te lang open staan. De duur van de sessie is in te stellen met TypoScript: (plugin.tx_ncgovpdc.settings.registration.sessionTimeout). Als dit record wordt verwijderd (of niet is aangemaakt) dan zal de extensie een error geven.

Installatie¶

Voor deze installatie is TYPO3 versie 4.3 vereist, daar deze versie de minimale vereiste versie is voor de benodigde systeem extensies fluid en extbase . Zonder deze extensies kan de PDC NIET functioneren.

Zorg dat zowel extbase als fluid daadwerkelijk zijn geinstalleerd.

Minimale installatie¶

Daarna zijn minimaal de volgende stappen nodig voor een minimale installatie (product A-Z index + product detail):

Installeer de pdc extensie, via de extension manager.

Maak een storage folder aan, waar de PDC records geplaatst zullen worden.

Maak een TypoScript template aan voor de extensie. Zorg dat deze template wordt geinclude door de 'hoofd' TypoScript template. Zorg dat 'Producten en diensten catalogus (ncgov_pdc)' bij 'Statisch opnemen (vanuit extensies):' in 'Opnames' is toegevoegd.

Installeer de plugin op een pagina naar wens. Kies hiervoor de 'Product: A-Z index'. Zie de afbeeldingen hieronder voor de te volgen stappen.

Afbeelding 5: Installeren van de plugin

Klik aan de linkerkant op list, in het midden op de gewenste pagina, rechts op het plusje.

Afbeelding 6: Installeren van de plugin

Klik hier op pagecontent.

Afbeelding 7: Installeren van de plugin

Afbeelding 8: Installeren van de plugin

Bij tabblad general: selecteer 'insert plugin' bij type.

Bij tabblad plugin Product- en dienstencatalogus bij plugin.

Optioneel is het mogelijk om een productdetail pagina te maken, waar de producten zelf op getoond worden. Maak hiervoor een extra pagina aan, installeer hierop de plugin. Stel de volgende TypoScript waarde in: plugin.tx_ncgovpdc.settings.pages.productDetailPage, deze moet verwijzen id van de net aangemaakte pagina. De extensie zorgt er dan voor dat als een product wordt aangeklikt deze op zijn eigen pagina wordt getoond.

Templates wijzigen¶

Het is mogelijk om de templates lokaal te wijzigen. Kopieer hiervoor de templates (inclusief mappen) vanuit de extensie folder (EXT:ncgov_pdc/Resource/Private/Templates/*) naar een benaderbaar pad op de webserver (bijvoorbeeld fileadmin/tmpl/pdc/). Let op: is belangrijk dat de mappen waar de templates in staan ook worden gekopieerd! Hierna moet de TypoScript waarde plugin.tx_ncgovpdc.view.templateRootPath worden ingesteld op het pad waar de templates zijn neergezet (in bovenstaand voorbeeld: plugin.tx_ncgovpdc.view.templateRootPath = fileadmin/tmpl/pdc/).

Verschillende weergaven¶

De extensie is veelzijdig en heeft verschillende weergaven, elk voor een specifiek doel. Hieronder een toelichting voor elke weergave:

Afbeelding 9: weergaven pdc

Plugin opties¶

Afbeelding 10: Plugin opties

De plugin heeft de volgende opties: - Gebruik template voor detailweergave:

Hiermee is in te stellen dat in de detailweergave een andere template wordt gebruikt. Gebruik dit om de TypoScript te overrulen. Dit is te gebruiken om in een linker- of rechterkolom een alternatieve weergave van een product te realiseren (bijvoorbeeld voor het tonen van contactinformatie, of gerelateerde producten).

• Kennisbank: Toon enkele VAC vraag (ongeacht parameters)

  Toon alleen de vraag, waarvan het id is meegegeven aan de URL (dus geen zoekresultaten)

• Registratie voor deze instantie uitschakelen

  Schakelt de registratie uit voor deze plugin instantie. Gebruik dit om dubbele registratieregels te voorkomen als de plugin meerder malen op de dezelfde pagina wordt gebruikt.

• Statistiekenregistratie voor deze instantie uitschakelen

  Schakelt de statistieken registratie voor deze instantie uit. Gebruik dit om te voorkomen dat er dubbel geteld wordt als er meer dan 1 plugin instantie op dezelfde pagina wordt gebruikt.

• Extensieweergave:

  De gekozen weergave van de extensie. Zie vorige paragraaf.

• Startpunt:

  De folder waar de pdc records zich bevinden.

database¶

wordsNotRelevantForSearch¶

controllers¶

registration¶

statistics¶

contentMyQuestionWasNotAnswered¶

contentNoResultsFound¶

contentPoseQuestion¶

vraagAntwoordCombinaties¶

samenwerkendeCatalogi¶

pages¶

Persistence.storagePid¶

csvImport¶

((generated))¶