Working version v32.1.X v32.0.X v29.1.X
Working version v32.1.X v32.0.X v29.1.X Dutch

Overzicht uitbreidingspunten

Vooraf

Een uitbreidingspunt is een plaats waar het platform je toelaat om eigen code toe te voegen of standaardgedrag te wijzigen. Deze pagina is een kaart: ze toont welke uitbreidingspunten er zijn, zonder elk ervan volledig uit te leggen. Wanneer je voor maatwerk kiest en wat het verschil is tussen een extensie en een customizatie, lees je op Wat zijn extensies & customizaties?. Waar de code in de repository terechtkomt, lees je op Opbouw van een Skryv applicatie.

Zó lees je de tabellen.

Elke tabel heeft vier kolommen:

  • Uitbreidingspunt en Wat je ermee doet beschrijven het uitbreidingspunt in gewone woorden.

  • Hoe het werkt is bedoeld voor developers: het technische mechanisme en de belangrijkste klassen of functies.

  • Soort geeft aan hoe diep je ingrijpt in het platform, en dus hoeveel aandacht het vraagt bij een platformupgrade.

Soort

Betekenis

Aandacht bij upgrades

Configuratie in code

Je stelt een platformonderdeel in via code, zonder iets te vervangen.

Laag

Extensie

Je voegt iets toe dat het platform niet standaard biedt.

Middel

Customizatie

Je vervangt een standaardonderdeel van het platform.

Hoog: je neemt de verantwoordelijkheid over voor alles wat het origineel deed.

Back-end

Maatwerk in de back-end schrijf je in Java, als Spring-component in de module backend of in een eigen module. Je bouwt daarbij voort op de publieke API van het platform, zoals de services uit skryv-backend-core.

Uitbreidingspunt

Wat je ermee doet

Hoe het werkt

Soort

Workflowservice

Een stap in een workflow laten uitvoeren door eigen code, bijvoorbeeld een berekening of het klaarzetten van een document.

Een Spring bean die je vanuit BPMN aanroept, met een expressie (camunda:expression="${mijnService.methode(execution)}") of als delegate (camunda:delegateExpression="${mijnDelegate}"). Een delegate implementeert JavaDelegate.

Extensie

Eigen connector

Gegevens uitwisselen met een externe dienst waarvoor geen platformconnector bestaat.

Een Spring bean die de externe dienst aanspreekt, bijvoorbeeld via REST. URL's en secrets komen uit eigenschappen, nooit uit de code.

Extensie

Wrapper rond een platformbouwsteen

Een bestaande platformconnector of platformservice aanvullen met eigen gedrag, bijvoorbeeld extra foutafhandeling.

Een Spring bean die de platformbean injecteert en doorgeeft, met eigen logica errond, zoals resilience4j-annotaties. De workflow roept de wrapper aan in plaats van de platformbean.

Extensie

Geplande taak

Iets automatisch laten gebeuren op vaste tijdstippen, los van een dossier, bijvoorbeeld een referentielijst bijwerken of een export klaarzetten.

Een methode met @Scheduled(cron = "${mijn.cron}"). De cron-expressie komt uit eigenschappen.

Extensie

Onderhoudstaak

Een eenmalige of zelden nodige correctie uitvoeren op bestaande dossiers, bijvoorbeeld ontbrekende gegevens aanvullen.

Een service die je via een eigen endpoint start. Goede praktijk: idempotent, eerst een dry-run, asynchroon bij grote volumes.

Extensie

Eigen REST-endpoint

Gegevens aanbieden aan je eigen backoffice- of frontofficecode die het platform niet standaard aanbiedt.

Een Spring-controller in de app. De frontends spreken het endpoint aan via een eigen actie in de store.

Extensie

Eventbrug

Gebeurtenissen uit de workflow doorgeven aan andere onderdelen van het platform, bijvoorbeeld om notificaties te laten versturen.

Een Spring bean die events publiceert op de eventbus van het platform via EventBusPublisher.

Extensie

Overschreven platformklasse

Standaardgedrag van het platform vervangen, bijvoorbeeld hoe een gebruikersprofiel uit de identity provider opgebouwd wordt.

Een subklasse van een platformklasse die bedoeld is om te overschrijven, geregistreerd als Spring bean. Het platform gebruikt dan automatisch jouw versie. Zie ook Identity provider.

Customizatie

Backoffice

De backoffice is gebouwd in AngularJS op het pakket @skryv/core-ng1. Alle aanpassingen registreer je op één plaats: in index.js van de module backoffice, via een plugin die Angular1Plugin uitbreidt en de ketting skryv.customize(...).

Uitbreidingspunt

Wat je ermee doet

Hoe het werkt

Soort

Eigen componenten

Nieuwe schermonderdelen toevoegen die de standaardbackoffice niet heeft.

AngularJS-componenten (angular.module(...).component(...)), gebundeld in de plugin. Gebruik een eigen prefix voor de componentnaam, zodat ze niet verward worden met platformcomponenten (skr-).

Extensie

Pagina-override

Een standaardpagina, zoals het dossieroverzicht of het dashboard, vervangen door een eigen versie. Dat kan ook voor één dossiertype, terwijl de andere dossiertypes het standaardscherm houden.

navigation.page(naam, { extend: true, views: { content: "mijnComponent" } }). Je component krijgt dezelfde bindings als het origineel, zoals apiDossier en authorizations, en moet ze doorgeven als het terugvalt op het standaardcomponent.

Customizatie

Zoekconfiguratie

Extra zoekvelden toevoegen of de standaardweergave van lijsten instellen, bijvoorbeeld zoeken op rijksregisternummer of adres.

search.setSearchOptionsConfigurationFor(...) voor zoekvelden, met per veld de documentpaden waarop gezocht wordt. search.defaultForTasks(...) voor kolommen, filters en sortering van de takenlijst.

Configuratie in code

Vertalingen

Teksten van je maatwerk vertalen, en de beschikbare talen en de standaardtaal instellen.

translation.add(taal, bestand), .locale(...) en .selectable([...]), met vertalingen in .po-bestanden.

Configuratie in code

Thema

Kleuren, logo en andere stijlkenmerken aanpassen aan de huisstijl.

SCSS-variabelen in includes.scss en overrides.scss. Zie Custom backoffice thema.

Configuratie in code

Store

Gegevens ophalen of acties uitvoeren die de standaardbackoffice niet doet, bijvoorbeeld een takenlijst uit een eigen endpoint.

Eigen acties in de Redux-achtige store van het platform. Een actie kan een bestaand actietype van het platform hergebruiken met een andere API-aanroep.

Extensie

Frontoffice

De frontoffice is gebouwd in React op het pakket @skryv/core-react, eventueel aangevuld met @skryv/core-react-vo voor de Vlaamse overheid-stijl. Ook hier registreer je alle aanpassingen in index.js, via een klasse die SkryvFrontOfficeApp uitbreidt en de ketting .customize(...).

Uitbreidingspunt

Wat je ermee doet

Hoe het werkt

Soort

Layout

Vaste onderdelen van elke pagina vervangen, zoals de kop- en voettekst.

navigation.layout(layoutNames.FRONTOFFICE, { extend: true, views: { header, footer } })

Customizatie

Pagina-override

Een standaardpagina, zoals het dashboard of het dossieroverzicht, vervangen door een eigen versie.

navigation.page(pageNames.DOSSIER, { extend: true, views: { content: MijnComponent } })

Customizatie

Nieuwe pagina

Een pagina toevoegen die de standaardfrontoffice niet heeft, met een eigen URL.

navigation.page(naam, { layout, url, views: { content }, needsAuthentication })

Extensie

Formulier-configuratie

Instellen hoe formulieren zich gedragen, bijvoorbeeld een wizard per sectie of alleen pdf als bijlage.

form.setFormConfig({ ... })

Configuratie in code

Eigen formulier-componenten

Een formulierveld met eigen gedrag aanbieden, dat een configurator daarna in formulieren kan gebruiken.

form.addCustomComponent("mijnVeld", MijnComponent) registreert een React-component onder een naam.

Extensie

Eigen request

Formuliercomponenten gegevens laten ophalen uit de back-end, bijvoorbeeld parameters op basis van een postcode.

Een functie die je beschikbaar maakt via customRequest in form.setFormConfig. Ze roept doorgaans een actie in de store aan, die op haar beurt een eigen REST-endpoint aanspreekt.

Extensie

Vertalingen

Teksten van je maatwerk vertalen en de taal van de frontoffice instellen.

translation.locale(...) en .add(taal, vertalingen)

Configuratie in code

Thema

Kleuren en stijlkenmerken aanpassen.

SCSS in overrides.scss van de module frontoffice. Zie Custom frontoffice thema.

Configuratie in code

Store

Gegevens ophalen of standaardgedrag bijsturen, bijvoorbeeld een standaardmelding onderdrukken na het indienen.

Eigen acties en logica in de Redux-store, die je bij het opstarten aan SkryvFrontOfficeApp meegeeft.

Extensie

Niet in dit overzicht

Enkele vormen van maatwerk vallen buiten deze pagina: