Externe klanttaak
Last updated
Last updated
Auteur: Jan Brekelmans | Status: Review
Hiermee kunnen inwoners direct zelf zaken regelen bij de gemeente. Deze service laat acties zien die nog door een inwoner moeten worden uitgevoerd. Inwoners kunnen hier bijvoorbeeld extra gegevens aanleveren voor een lopende zaak of een betaling doen.
Van betrokkenen bij een ZAAK (?) kan tijdens het proces "iets" worden gevraagd dat uitgevoerd moet worden. Als de Taak niet wordt uitgevoerd vervalt een recht, moet een aanvraag opnieuw worden ingediend of zijn er andere gevolgen.
Betere notificatie filtering -> https://github.com/maykinmedia/objects-api/issues/405
Een ZAC kan taken uit zetten bij een portaal.
Scope: ZAC zet taak uit in de Objecten API die door het klantportaal word opgepakt
Deze pagina beschrijft het (Technisch) design en structuur van het taken patroon. Met de opzet van deze taken beschrijving is als uitgangspunt gebruikt het toekomstig kunnen uitbreiden van de standaard. Zo moet het makkelijk zijn om een nieuw taak sub-type toe te kunnen voegen zonder dat dit backwards-compatibility problemen opleveren. Een taak bestaat daarom uit een generiek deel en een sub-type specifiek deel. Dat laatste kan makkelijk uitgebreid worden met andere sub-typen. Bijv. een nieuwe betaaltaak soort voor een andere payment provider.
Momenteel zijn de volgende taak sub-types gedefinieerd
Type | Uitleg |
---|---|
Onderstaande sequence beschrijft het verloop van een taak, ongeacht wat voor taak soort het is. Verdere detail uitwerking per taak soort is verderop in dit document te lezen.
Een taak is een archief waardig object. In principe moet een taak bewaard blijven zodat later altijd inzage is in de communicatie tussen de klant en de gemeente.
Het opschonen van taken zal daarom door een Archief Beheer Component moeten worden gedaan als de bewaartijd is overschreden.
Let op dat een taak dus (waar mogelijk) altijd aan een zaak of ander items is gekoppeld waardoor deze meegenomen kunnen worden in opschoonacties.
Een taak heeft een verloopdatum. Een portaal is alleen verantwoordelijk voor het weergeven van een taak, niet voor het opschonen van een taak. De applicatie die de taak klaar zet moet zelf verlopen taken in acht nemen en deze opschonen.
Een taak moet altijd de volgende data bevatten:
Bevat een URL waarna de gebruiker wordt doorgestuurd. Verdere afhandeling van de taak en eventuele terugkoppeling naar het portaal zijn in handen van het externe systeem waarna de gebruiker gerefereerd word.
Formulier taak die binnen het portaal wordt afgehandeld. Een gebruiker krijgt na het klikken op de taak een formulier voor zich dat middels FormIO is opgesteld wat ingevuld kan worden. Het resultaat van het ingevulde formulier wordt in het object opgeslagen.
Het integreren van een betaalverzoek direct in een klanttaak, waarbij het betaalverzoek de enige actie is die van de gebruiker wordt gevraagd.
Rol van het ZAC
Het ZAC maakt gebruik van een 'betaling' element binnen een klanttaak, zonder dat er een externe payment provider integratie nodig is vanuit de procesapplicatie. Het opnemen van betalingsvariabelen is voldoende. Deze variabelen kunnen door de behandelaar worden ingevoerd in een taakscherm.
Rol van het portaal
Het portaal is verantwoordelijk voor het renderen van het betaalformulier, het aanmaken van de transactie bij de payment provider, en voor het correct verwerken van de output van deze provider, die trigger is om het formulierobject bij te werken.
Informeren initiator
Via outputmanagementcomponent (trigger is update van zaakstatus door ZAC?)
Via mail door ZAC
De betaaltaak bevat:
Title (Voor Ingenico weergave, zelfde als taak titel)
Bedrag
Betaalkenmerk - Aanleverende partij is verantwoordelijk voor het uniek zijn van dit betaalkenmerk
PSPID
Vervaldatum - tot welke datum de betaaltaak actief moet zijn; null = oneindig (Zelfde als taak verloopdatum)
https://www.jsonschemavalidator.net/s/tQFfv02f
1.1.0 -> 1.1.1
Betere schema validatie met additionalproperties op false voor identificatie
1.0.0 -> 1.1.0
Description toegevoegd met schema versie (Nu 1.1.0)
Identificatie & koppeling aangepast zodat ze ook andere soorten toelaten maar nogsteeds validatie doet op bsn, kvk, zaak en product values. Non breaking change
Veld | Omschrijving |
---|---|
Titel
Weergave naam van de taak. Max 1 zin.
Status
Status van de taak. Opties: open, afgerond, verwerkt, gesloten.
Soort
Zie tabel hierboven.
Identificatie
KVK of BSN waaraan de taak gericht is. Kan mogelijk uitgebreid worden met andere types
Verloopdatum
Optioneel: Verloopdatum van de taak.
Koppeling
Optioneel: Zaak of Product UUID waaraan de taak verbonden is.
Verwerker taak id
Een UUID waarmee een ZAC een link kan leggen tussen de taak en zijn eigen administratie
eigenaar
Een identificatie van de eigenaar / aanmaker van de taak. Gebruikt voor filtering ed.
url
Een link naar een externe resource. Als hier op deze taak geklikt word, word de gebruiker doorgestuurd naar deze link.
formtaak
Een taak die uitgevoerd kan worden binnen het desbetreffende portaal.
ogonebetaling
Een betaling die via het portaal met Ogone / Ingenico wordt voldaan