DOSIS
Inleiding
DOSIS staat voor DOssier Status Informatie Systeem. DOSIS verzamelt en ontsluit informatie over de aanwezigheid en status van een dossier bij een Vlaamse of lokale overheidsdienst. Het is mogelijk om je dienstverlening aan te sluiten op DOSIS en statusupdates voor concrete dossiers door te geven via API. De dossierstatus wordt dan zichtbaar op platformen als Mijn Burgerprofiel, het Verenigingsloket of het eLoket voor ondernemingen.
Protocol
Onboardingprocedure gebeurt per dienstverlening die je met DOSIS wil koppelen en staat beschreven op de documentatiesite van de Digitaal Vlaanderen. Grosso modo doorloop je onderstaande stappen.
Vul het aansluitingsformulier in bij elke nieuwe aansluiting.
DOSIS zet de testomgeving op en bezorgt je een OAuth clientId voor toegang tot de testomgeving.
Log in bij het beheerdersportaal om de OAuth clientID te beheren en er een gevalideerde public key (certificaat onder de vorm van .jwks-bestand) op te laden.
Koppelen met testomgeving en valideren van de connectie.
DOSIS zet de productieomgeving op en bezorgt je een OAuth clientId voor toegang tot de productieomgeving.
Log in bij het beheerdersportaal om de OAuth clientID te beheren en er een gevalideerde public key (certificaat onder de vorm van .jwks-bestand) op te laden.
Koppelen met productieomgeving en verder operationaliseren.
Applicatie eigenschappen
Specifiek voor DOSIS (los van de eigenschappen die de toegang regelen).
Eigenschap | Beschrijving |
|---|---|
| Url waar de statusupdates naartoe gestuurd moeten worden. |
| Aanduiding van de bron van waaruit je applicatie statusupdates doorstuurt. Uitleg over het begrip ‘bron’. |
| Productcode voor je dienstverlening. Uitleg over ProductId of IDPC. |
| Client Id voor je applicatie. Hiermee moet je inloggen op het beheerdersportaal. |
| Waarde: boolean Indien |
| Url waar de applicatie op inlogt om vervolgens een token te verkrijgen waarmee de veilige communicatie tot stand gebracht kan worden. |
| Scope van je machtiging binnen DOSIS. Dit bepaalt welke acties je mag uitvoeren. |
| Pad naar private key in AWS Secrets Manager. |
| Pad naar lokale opslag van je key pair. |
Services en functies
sendDosisStatusUpdate
Functie gebruikt om een statusupdate door te sturen naar DOSIS. Alle parameters zijn instelbaar via de Studio service taak template ‘DOSIS - Verzend statusupdate’.
Workflow expressie
${dosis.sendDosisStatusUpdate(agentIdentificatie, agentToegangsrecht, statusVlaamseFase, statusVlaamseCode, statusDetail1, statusActie, dossierLabel, dossierNaam, doorverwijzing, contactNaam, contactDepartement, contactTelefoon, contactEmail, contactWebsite, productId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
agentIdentificatie | String | - | |
agentToegangsrecht | String | - | |
statusVlaamseFase | String | - | |
statusVlaamseCode | String | - | |
statusDetail1 | String | - | |
statusActie | String | - | |
dossierLabel | String | - | |
dossierNaam | String | - | |
doorverwijzing | String | - | |
contactNaam | String | - | |
contactDepartement | String | - | |
contactTelefoon | String | - | |
contactEmail | String | - | |
contactWebsite | String | - | |
productId | String | - |
Output
Geen output.
deleteDossier
Functie gebruikt om een in DOSIS gekend dossier te schrappen.
Workflow expressie
${dosis.deleteDossier(String bron, String dossierNummer)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
bron | String | - | Bron (info die je ontvangt tijdens het onboardingproces) |
dossierNummer | String | - | Nummer (dossierId die je doorgegeven hebt aan DOSIS) |
Output
Geen output.