MAGDA Document service

Inleiding

Ook wel Magda Documentendienst of Magda Document Service genoemd. Dit laat directe communicatie met de burger toe via eBox en/of aangetekende zending.

Technische info MAGDA-documentendienst.

Setup

Idem als bij alle Magda connectoren.

Applicatie eigenschappen

Algemeen

Opdat de connector toegang zou krijgen tot de MAGDA service, moet deze beschikken over de volgende informatie. De placeholder {service} moet je telkens vervangen door de specifieke service die je wil implementeren.

dosis (legacy connector)
ebox (magda documentendienst)
gc (ondernemingen - giveCompany)
ghp
gp (geefPersoon)
mobility (mobiliteit)
poc (kadaster)
ri (repertorium)
sme (ondernemingen - geefJaarrekeningen)
zoekeigendomstoestanden (kadaster)

URL-endpoint

Eigenschap

Beschrijving

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

Geef het URL-endpoint.

Voorbeeld: https://magdapersoondienst.vlaanderen.be

Keys en certificaten

Eigenschap	Beschrijving
`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.

Hoedanigheid

Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.

Eigenschap

Beschrijving

magda.default.hoedanigheid

Bevat de aansluitingscode of IPDC-code.

Uri

Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.

Eigenschap

Beschrijving

magda.default.uri

Bevat het pad naar de aan te spreken service.

Document service specifiek

Specifieke applicatie eigenschappen, los van de eigenschappen die de toegang regelen.

Eigenschap	Beschrijving
`skryv.connectors.magda.ebox.application-id`	Info volgt.
`skryv.connectors.magda.ebox.message-id`	Info volgt.
`skryv.connectors.magda.ebox.message-type`	Info volgt.

Services en functies

Deze connector is volledig in te stellen via Skryv Studio service taak templates.

hasAnEbox

Controleer of de opgegeven persoon (personen) of onderneming (ondernemingen) over een actieve eBox beschikken. Zie ook de service taak templates ‘Controleer of eBox actief is voor burger’ en ‘Controleer of eBox actief is voor onderneming’.

Workflow expression

${magda.hasAnEbox(String type, List<String> identifiers)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
type	String	‘kbo’	Twee opties: ‘kbo’ ofwel ‘ssin’
identifiers	List<String>	['85010212345', ‘95010212345’, ‘75010212345’]	Lijst met ofwel rijksregisternummers (indien type ‘ssin’ is) ofwel ondernemingsnummers (indien type ‘kbo’ is)

Output

Je krijgt een map met voor elke identifier (persoon of onderneming) een aanduiding of er al dat niet een actieve eBox is.

getMessageStatus

Check voor een verstuurd bericht of de ontvanger deze gelezen heeft of niet. Zie service task templates ‘Haal verzendstatus op voor eBox’ en ‘Haal verzendstatus op voor papier’.

Workflow expressie

${magda.getMessageStatus(String eboxMessageId, String type, List<String> identifiers)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
eboxMessageId	String	-	Verwijst naar de id van het bericht zoals die gekend is in eBox. Dit is info die je haalt uit de response van publishEboxMessage
type	String	‘kbo’	Twee opties: ‘kbo’ ofwel ‘ssin’
identifiers	List<String>	['85010212345', ‘95010212345’, ‘75010212345’]	Lijst met ofwel rijksregisternummers (indien type ‘ssin’ is) ofwel ondernemingsnummers (indien type ‘kbo’ is)

Output

Je krijgt een map met voor elke identifier de aanduiding of het bericht al dan niet gelezen is.

publishEboxMessage

Publiceer een bericht in de eBox van de persoon of onderneming. Zie ook de service taak template ‘Verstuur documenten'.

Workflow expressie

${magda.publishEboxMessage(EboxMessageParamsWrapper eboxMessageParamsWrapper)}

Input

Inputparameters	Data type	Voorbeeld	Uitleg
eboxMessageParamsWrapper	Wrapper	-	Bevat alle info nodig om een bericht te publiceren in de eBox. In te stellen via Studio.

Output

Je krijgt een string met de Id van het bericht zoals die in eBox gekend is.