Eigenschappen

skryv.baseUrl

Parameter die de url van de Skryv applicatie bevat.

springdoc.swagger-ui.enabled

Default:

false

• Zet deze parameter op true om Swagger UI expliciet inschakelen. Zie release note.

• Zie ook de Exposed API documentatie. Contacteer het Skryv team voor meer info.

skryv.allowedDomains

Voorbeeld:

skryv.allowedDomains=vandenbroele.be,vlaanderen.be

Whitelisted domeinnamen. Hyperlinks naar externe resources op deze sites worden vertrouwd en aldus ingeladen binnen gegenereerde communicaties.

Zie documentatie communicatie hulpfuncties.

URL’s eigen aan je applicatie die standaard vertrouwd worden en die je dus niet hoeft te expliciteren:

• backOfficeUrl

• frontOfficeUrl

• baseUrl

skryv.connectors.adressenregister.service.url

Deze parameter bevat de URL van de service waarmee de applicatie verbinding maakt met het Adressenregister.

skryv.connectors.adressenregister.api-key

Deze parameter bevat de API-sleutel die wordt gebruikt voor authenticatie bij de Adressenregister-service. De API-sleutel wordt meegestuurd met elk verzoek om toegang te krijgen tot de service en is vereist om de identiteit van de applicatie te verifiëren.

skryv.ldap.requiredGroup

Info volgt.

skryv.oauth.tokenUri

Info volgt.

skryv.oauth.userUri

Info volgt.

skryv.oauth.client-id

Info volgt.

skryv.oauth.secret

Info volgt.

skryv.authentication.provider

Default: skryv-ldap-jwt

Info volgt.

skryv.oauth.eportal.clientId

Info volgt.

skryv.oauth.eportal.clientSecret

Info volgt.

skryv.oauth.eportal.scopes

Default: openid

Waarde: komma gesepareerde lijst van oauth scopes. Met scopes kan je de autorisatie gaan fijnstellen: welke gegevens mag je ophalen en welke acties mag je uitvoeren?

De openid scope activeert de OpenID Connect uitbreiding op OAuth en voegt een authenticatielaag toe. De gebruiker moet zich authenticeren via een Identity Provider.

skryv.oauth.eportal.redirectUri

Info volgt.

skryv.oauth.eportal.accessTokenUri

Info volgt.

skryv.oauth.eportal.jwkUrl

Info volgt.

skryv.oauth.eportal.logoutRedirectUri

Info volgt.

skryv.oauth.backoffice.clientId

Info volgt.

skryv.oauth.backoffice.clientSecret

Info volgt.

skryv.oauth.backoffice.scopes

Default: openid

Waarde: komma gesepareerde lijst van oauth scopes. Deze bepalen de toegestane acties.

skryv.oauth.backoffice.redirectUri

Info volgt.

skryv.oauth.backoffice.accessTokenUri

Info volgt.

skryv.oauth.backoffice.userAuthorizationUri

Info volgt.

skryv.oauth.backoffice.jwkUrl

Info volgt.

skryv.oauth.backoffice.logoutRedirectUri

Info volgt.

skryv.openid.properties.isEmailEditable

Info volgt.

skryv.openid.properties.isPhoneEditable

Info volgt.

skryv.attachments.allowed-mime-types

Voorbeeld:

skryv.attachments.allowed-mime-types=application/pdf

Whitelisted bestandstypes voor het uploaden van bijlages.

Standaard (dus zonder het expliciet instellen van deze parameter) worden volgende bestandsformaten ondersteund: application/pdf,image/jpeg,image/jp2,image/jpx,image/jpm,image/png.

Bestandstypes die je kan whitelisten:

• Pdf - application/pdf

• Zip-bestanden - application/zip

• Tekstbestanden - text/plain, application/msword, application/vnd.oasis.opendocument.text and application/vnd.openxmlformats-officedocument.wordprocessingml.document

• Presentaties - application/vnd.ms-powerpoint and application/vnd.oasis.opendocument.presentation

• Spreadsheets - application/vnd.ms-excel, application/vnd.oasis.opendocument.spreadsheet and application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

• Outlook e-mail bijlage - application/vnd.ms-outlook

• Grafisch - application/vnd.oasis.opendocument.graphics

• Beelden - image/jpeg, image/jp2, image/jpx, image/jpm, image/png

• CSV - text/csv

• HTML - text/html

• XML - text/xml

skryv.attachments.base.path

Pad naar locatie waar bijlages opgeslagen worden.

skryv.attachments.isSoftDeleteEnabled

Default:

false

• Als je deze parameter toevoegt, en op true plaatst, dan kan een backoffice medewerker de bestanden wel verwijderen. Opgepast, de bestanden zelf worden niet verwijderd uit de applicatie, ze worden gewoon niet langer gevisualiseerd (soft deletion).

• Standaard (dus zonder het instellen van deze parameter) of indien false, wordt het verwijderen van bijlages uit frontoffice en backoffice niet ondersteund.

skryv.attachments.storage.s3.prefix

Default:

attachments

Deze parameter bepaalt de prefix (voorvoegsel) voor de opslaglocatie in de S3-bucket. Het voorvoegsel wordt toegevoegd aan het pad voor elk opgeslagen bestand.

skryv.attachments.storage.s3.encryption.enabled

Default:

false

Deze parameter bepaalt of de versleuteling voor bestanden in de S3-bucket is ingeschakeld. Als deze op true staat, worden de bestanden versleuteld voordat ze naar S3 worden geüpload.

skryv.attachments.storage.s3.encryption.key

Default:

null

Dit is de sleutel die wordt gebruikt voor de versleuteling van bestanden in de S3-bucket als de versleuteling is ingeschakeld. Deze sleutel kan een client-sleutel zijn of een AWS KMS-sleutel.

skryv.attachments.storage.s3.encryption.algorithm

Default:

aws:kms

Deze parameter specificeert het versleutelingsalgoritme dat wordt gebruikt wanneer versleuteling is ingeschakeld voor S3-bestanden. Het standaardalgoritme van AWS is aws:kms, wat betekent dat Amazon's Key Management Service (KMS) wordt gebruikt om de gegevens te versleutelen.

Eigenschap

Beschrijving

skryv.camunda.enableExceptionsAfterUnhandledBpmnError

Default:

true

Waarde: boolean

Indien false, dan zullen niet opgevangen BPMN-errors leiden tot het bruusk beëindigen van de process instance. Indien true, dan leidt een niet opgevangen BPMN-error tot een workflow engine exception.

skryv.camunda.enableNashorn

Default:

false

Waarde: boolean

Indien true, verander JavaScript engine van default GraalVM naar Nashorn. Zie release note.

skryv.camunda.enableScriptEngineNashornCompatibility

Default:

true

Waarde: boolean

Deze parameter bepaalt of de Camunda-engine compatibiliteit met de Nashorn JavaScript-engine inschakelt. Dit kan nodig zijn voor legacy-applicaties die afhankelijk zijn van Nashorn voor JavaScript-uitvoering. Na update Skryv platform naar Java 17 wordt immers GraalVM gebruikt als de default JavaScript engine.

skryv.camunda.rest.enabled

Waarde: boolean

Deze parameter bepaalt of de Camunda REST API-gebruik in de applicatie is ingeschakeld. Als deze parameter op true staat, wordt de Camunda REST API geactiveerd, wat het mogelijk maakt om via HTTP verzoeken (bijvoorbeeld GET, POST) interactie te hebben met het Camunda BPM-systeem.

skryv.camunda.preferJsonSerialization

Default:

false

Waarde: boolean

Deze parameter bepaalt of de Camunda-engine JSON-serialisatie moet verkiezen bij het verwerken van variabelen en gegevens. Wanneer deze parameter is ingeschakeld (d.w.z. true), wordt JSON gebruikt voor de serialisatie van gegevens in plaats van andere formaten, zoals XML. Dit kan handig zijn wanneer de applicatie JSON als standaardformaat gebruikt of wanneer er integraties zijn met systemen die JSON vereisen.

skryv.captcha.captchaeu.public-key

Deze parameter bevat de publieke sleutel die wordt gebruikt om een CAPTCHA-verificatie uit te voeren met de CAPTCHA-provider (in dit geval, de CAPTCHA EU-service). De publieke sleutel wordt meestal geleverd door de CAPTCHA-service en wordt gebruikt voor het valideren van CAPTCHA-antwoorden.

skryv.captcha.captchaeu.rest-key

Deze parameter bevat de REST-key die wordt gebruikt om API-calls naar de CAPTCHA EU-service te doen.

skryv.captcha.provider

Deze parameter geeft de naam van de CAPTCHA-provider aan die in de applicatie wordt gebruikt. Dit kan bijvoorbeeld captchaeu zijn of een andere CAPTCHA-aanbieder.

skryv.connectors.dosis.status.update.url

Url waar de statusupdates naartoe gestuurd moeten worden.

skryv.connectors.dosis.bron

Aanduiding van de bron van waaruit je applicatie statusupdates doorstuurt. Uitleg over het begrip ‘bron’.

skryv.connectors.dosis.productId

Productcode voor je dienstverlening. Uitleg over ProductId of IDPC.

skryv.connectors.geosecure.dosis.appnumber

Client Id voor je applicatie. Hiermee moet je inloggen op het beheerdersportaal.

skryv.connectors.geosecure.dosis.aws.seed.enabled=false

Waarde: boolean

Indien true worden authenticatiegegevens opgehaald uit AWS Secrets Manager. Indien false, dan worden de lokaal opgeslagen authenticatiegegevens gebruikt.

skryv.connectors.geosecure.dosis.requestpath

Url waar de applicatie op inlogt om vervolgens een token te verkrijgen waarmee de veilige communicatie tot stand gebracht kan worden.

skryv.connectors.geosecure.dosis.scope

Scope van je machtiging binnen DOSIS. Dit bepaalt welke acties je mag uitvoeren.

skryv.connectors.geosecure.dosis.aws.keypath

Pad naar private key in AWS Secrets Manager.

skryv.connectors.geosecure.dosis.keypath

Pad naar lokale opslag van je key pair.

Info volgt.

Info volgt.

Info volgt.

Info volgt.

skryv.scheduler.incidentReport.recipients

• Schakelt het periodiek versturen van incident reports via e-mail notificaties in.

• Indien niet opgegeven, dan is de service uitgeschakeld (dit is de default).

• Komma-gescheiden lijst van e-mailadressen voor de ontvangers.

• Voorbeeld:
  john@company.com,mark@company.com

skryv.scheduler.incidentReport.cron

• Bepaalt de periodiciteit van de notificaties.

• Maakt gebruik van cron notation

• Default waarde is 0 0 0 * * 0, wekelijks op zondag middernacht.

skryv.reply-to.email

E-mailadres gebruikt wanneer ontvangers willen replyen.

skryv.sender.email

E-mailadres vanwaaruit de notificaties verstuurd worden.

skryv.connectors.esignflow.api-key

• API-key: terug te vinden in het menu eSignFlow > Instellingen > API sleutels

• Voorbeeld: 12345678-1234-1234-1234-123456789012

skryv.connectors.esignflow.email-identity

• E-mailadres (technische) gebruiker eSignFlow.

• Voorbeeld: jouw.naam@vandenbroele.be

skryv.connectors.esignflow.base-url

• URL van eSignFlow instantie klant.

• Voorbeeld: https://stag-app.esignflow.be/api

skryv.exposed-api.resourceserver.jwkSetUri

Info volgt.

skryv.exposed-api.resourceserver.issuer

Info volgt.

skryv.exposed-api.resourceserver.audience

Info volgt.

skryv.exposed-api.dossier.frontOfficeUrl

Info volgt.

skryv.exposed-api.dossier.filter.nationalRegistryNumbers

Info volgt.

skryv.exposed-api.dossier.filter.cbeNumbers

Info volgt.

skryv.allowGuestAccess

Default: false

Standaard is de frontoffice enkel toegankelijk na authenticatie en inloggen. Om bepaalde dienstverleningen zo laagdrempelig mogelijk te houden, willen we echter ‘guest users’ toelaten die zonder inloggen de frontoffice kunnen benaderen en een dossier opstarten. Als je applicatie deze use case bevat, dan schakel je deze parameter in (true).

skryv.connectors.geosecure.gipod.scope

Scope bevat info die je ontvangt tijdens het onboardingproces.

skryv.connectors.geosecure.gipod.keypath

Private JWK.

skryv.connectors.geosecure.gipod.aws.keypath

JWK in AWS Secrets Manager.

skryv.connectors.magda.{service}.service-url

Geef het URL-endpoint.

Voorbeeld: https://magdapersoondienst.vlaanderen.be

skryv.aws.mutual-ssl.seed.enabled

• Indien true, dan haalt de applicatie de key en het certificaat op uit de AWS Secrets Manager en slaat deze lokaal in de applicatie op (zie de twee rijen hieronder).

• Indien false, dan neemt de applicatie rechtstreeks de lokaal gedefinieerde key en certificaat zonder eerst AWS Secrets manager te bevragen.

aws.{service}.client.ssl.trustore-jks

Lokale opslag van het certificaat.

Voorbeeld: wrp-trust-store.jks

aws.{service}.client.ssl.keystore-jks

Lokale opslag van de key.

Voorbeeld: wrp-key-store.jks

aws.{service}.client.ssl.trust-store-path

Bevat het pad naar het certificaat in AWS Secrets Manager.

aws.{service}.client.ssl.private-key-path

Bevat het pad naar de key in AWS Secrets Manager.

aws.{service}.client.ssl.private-key-password-path

Bevat het pad naar het wachtwoord voor de key in AWS Secrets Manager.

magda.default.hoedanigheid

Bevat de aansluitingscode of IPDC-code.

magda.default.uri

Bevat het pad naar de aan te spreken service.

Info volgt.

-

Info volgt.

-

skryv.connectors.magda.dosis.bron

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.dosis.productId

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.geef.persoon.bron

Info die je ontvangt bij het onboardingsproces.

Voorbeeld: RR (rijksregister)

skryv.connectors.magda.geef.persoon.taal

Info die je ontvangt bij het onboardingsproces.

Voorbeeld: nl (nederlands)

skryv.connectors.magda.mobility.url

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.tokenUrl

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.scope

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.clientId

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.keyPath

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.isAWSSeedEnabled

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.magda.mobility.awsKeyPath

Info die je ontvangt bij het onboardingsproces.

skryv.connectors.microsoft.enabled= true

• True: de connector is geactiveerd binnen de applicatie.

• False of niet opgegeven: de connector staat niet actief binnen de applicatie.

skryv.connectors.microsoft.client-id

Graph API credentials.

skryv.connectors.microsoft.tenant-id

Graph API credentials.

skryv.connectors.microsoft.client-secret

Graph API credentials.

skryv.connectors.microsoft.sharepoint.drive-id

Pad naar de SharePoint drive/folder waarmee je wil connecteren.

skryv.mbp.provider.id

Info volgt.

skryv.mbp.provider.name

Info volgt.

skryv.mbp.select.forms

Info volgt.

skryv.mbp.dosis.source

Info volgt.

skryv.orafin.attachment-folder

Naam van de folder voor Orafin-gerelateerde bijlagen

skryv.orafin.connection

Connectietype, bijvoorbeeld sftp

skryv.orafin.source

Bron voor de communicatie met Orafin

skryv.orafin.username

Gebruikersnaam voor de communicatie met Orafin

skryv.orafin.password

Paswoord voor de communicatie met Orafin

skryv.orafin.keymanager

Welke key manager wordt gebruikt?

Bijvoorbeeld: aws

skryv.orafin.host

Url van de host server (Orafin SFTP-server)

skryv.orafin.port

Poort voor de Orafin connectie

skryv.orafin.privatekeypath

Pad waar de private key te vinden is

skryv.orafin.infolder

Naam van de ‘In Folder’

Bijvoorbeeld: in

skryv.orafin.outfolder

Naam van de ‘Out Folder’

Bijvoorbeeld: out

orafin.in.cron

Voorbeeldinstelling voor zelf op te zetten schedular, cron notatie

Bijvoorbeeld: 0 */5 * * * *

orafin.out.cron

Voorbeeldinstelling voor zelf op te zetten schedular, cron notatie

Bijvoorbeeld: 0 */5 * * * *

orafin.bet.cron

Voorbeeldinstelling voor zelf op te zetten schedular, cron notatie

Bijvoorbeeld: 0 */5 * * * *

resilience4j.circuitbreaker.configs.default.failureRateThreshold=50

Het drempelpercentage van mislukte requests dat bepaalt wanneer de circuit breaker open gaat. Volgens de default, als 50% of meer van de requests in een bepaalde periode falen, schakelt de circuit breaker naar de open toestand.

resilience4j.circuitbreaker.configs.default.permittedNumberOfCallsInHalfOpenState=10

Het aantal toegestane requests dat wordt uitgevoerd wanneer de circuit breaker in de half-open toestand verkeert. Volgens de default worden er 10 requests uitgevoerd om te testen of de service hersteld is.

resilience4j.circuitbreaker.configs.default.slidingWindowSize=100

Het aantal requests dat wordt gevolgd in de sliding window van de circuit breaker. Volgens de default worden de uitkomsten van de laatste 100 requests gebruikt om te bepalen of de drempel voor mislukte verzoeken wordt overschreden.

resilience4j.circuitbreaker.configs.default.waitDurationInOpenState=60000

De tijd (in milliseconden) die de circuit breaker in de open toestand blijft, voordat hij probeert over te schakelen naar de half-open toestand. Default is dit dus 60 seconden.

resilience4j.ratelimiter.configs.default.limitForPeriod=8

Maximaal aantal calls per periode.

resilience4j.ratelimiter.configs.default.limitRefreshPeriod=1000

Lengte van de periode in milliseconden. 1000 milliseconden staat gelijk aan 1 seconde.

resilience4j.ratelimiter.configs.default.timeoutDuration=5

Aantal seconden dat de applicatie wacht bij overschrijding van de rate limit per periode. Indien het daarna nog steeds een overbelasting vaststelt, dan wordt een exception gegooid en faalt de call.

resilience4j.bulkhead.configs.default.maxConcurrentCalls=25

Het maximum aantal gelijktijdige requests dat de bulkhead toestaat. In dit geval kunnen er 25 gelijktijdige requests naar de service worden gestuurd. Als dit aantal wordt bereikt, worden extra requests geblokkeerd of moeten wachten totdat er ruimte is.

resilience4j.bulkhead.configs.default.maxWaitDuration=0

De maximale tijd (in milliseconden) dat een thread wacht om toegang te krijgen tot de bulkhead wanneer deze vol is. In dit geval is de waarde 0, wat betekent dat een thread niet wacht, maar onmiddellijk wordt afgewezen als de bulkhead verzadigd is.

resilience4j.retry.configs.default.maxAttempts=3

Het maximum aantal pogingen (inclusief de eerste poging) dat wordt gedaan om een mislukte call opnieuw te proberen. In dit geval worden er maximaal 3 pogingen gedaan, waarbij de initiële call als de eerste poging telt.

resilience4j.retry.configs.default.waitDuration=500

De wachttijd (in milliseconden) tussen opeenvolgende pogingen om de mislukte call opnieuw te doen. In dit geval bedraagt de wachttijd 500 milliseconden tussen elke poging.

skryv.connectors.signhub.client.secret

Info volgt.

skryv.connectors.signhub.client.id

Info volgt.

skryv.connectors.signhub.password

Info volgt.

skryv.connectors.signhub.username

Info volgt.

skryv.connectors.signhub.service.url

Info volgt.

skryv.signhub.aws.key

Info volgt.

skryv.signhub.aws.bucket

Info volgt.

skryv.signhub.ssl.keystoreFile

Info volgt.

skryv.signhub.ssl.password

Info volgt.

skryv.spotbooking.url

URL Spotbooking van de klant.

skryv.spotbooking.username

Gebruikersnaam technische gebruiker.

skryv.spotbooking.password

Wachtwoord technische gebruiker.

server.port

Voorbeeld: 8080

Poort waarop de applicatie server draait.

spring.application.name

Voorbeeld: skryv

Naam voor de SpringBoot applicatie.

spring.datasource.url

Voorbeeld:

jdbc:mysql://localhost/skryv

Datasource url bevat volgende info:

• Protocol (bijv. jdbc)

• Driver (bijv. mysql)

• Host-naam of IP-adres van de MySQL-database (bijv. localhost of de )

• Naam database (bijv. skryv)

spring.datasource.username

Voorbeeld: root

Gebruikersnaam, kan je rechtstreeks invullen, maar meestal komt hier een verwijzing naar de AWS Secrets Manager.

spring.datasource.password

Voorbeeld: skryvdoc

Paswoord, kan je rechtstreeks invullen, maar meestal komt hier een verwijzing naar de AWS Secrets Manager.

spring.jpa.hibernate.ddl-auto

spring.jpa.properties.hibernate.cache.use_second_level_cache

Waarde: boolean.

Indien true, dan schakel je een tweede cache level in, wat de reactietijden binnen de applicatie kan verbeteren.

spring.jpa.show-sql

spring.jpa.hibernate.naming.physical-strategy

spring.mvc.dispatch-options-request

spring.main.allow-circular-references