Integratieprocedure
- quincy.oeyen
- Sofie Ruysseveldt
Aanvraag
Elke aanvraag voor een integratie wordt gericht aan digitaalarchief@vlaanderen.be. In deze aanvraag moeten minstens volgende vragen beantwoord worden:
Wat is de doelstelling van de integratie?
Op welke toepassing(en) van DAV heeft de integratie betrekking?
Betreft de integratie ontsluiting van informatie, invoer van informatie of beiden?
Welke timing wordt er vooropgesteld?
Het opzetten van een API-integratie met het E-depot wordt bij voorkeur case by case aangepakt .
Planning
Samen met de klant bekijkt DAV wat er mogelijk is qua planning. Hierbij wordt in de mate van het mogelijke rekening gehouden met de door de klant vooropgestelde timing.
Na afronding van deze fase ligt er een duidelijk projectplan met daarin timings en afspraken. Deze timings en afspraken kunnen achteraf nog bijgestuurd worden indien nodig.
Analyse
Tijdens deze fase worden de behoeften volledig in kaart gebracht en maakt de klant, ondersteund door DAV, een volledige functionele analyse. Deze functionele analyse moet o.a. duidelijkheid scheppen over:
Welke informatie moet worden gearchiveerd?
Hoe zien de dossiers eruit?
Welke metadata moeten meegenomen worden en moeten doorzoekbaar zijn in het E-depot?
Zijn de reeds beschikbare metadatavelden (combinatie van het standaard-datamodel en beschikbare extensievelden) in het E-depot toereikend of moeten er bijkomende extensievelden worden gedefinieerd?
Wat is de trigger voor de archivering van de informatie?
Welke informatie moet worden ontsloten?
De effectieve onderwerpen die worden opgenomen tijdens de functionele analyse kunnen verschillen afhankelijk van het type integratie (E-depot vs. Serieregister, ontsluiting vs. invoer, …). Na het functionele luik kan de technische ontwikkeling worden gestart.
CHECKLIST API-INTEGRATIE | |||
Voorwaarden | |||
Wat | Verantwoordelijke | Doorlooptijd | Uitgevoerd? |
TI- en PRD-omgevingen Serieregister en E-depot zijn aangemaakt voor Klant DAV | DAV | 3 werkweken vanaf aanvraag | ☐Ja |
Klant DAV heeft nodige rechten gekregen in ACM/IDM op organisatieniveau | DAV | 1 werkdag | ☐Ja |
Medewerkers van Klant DAV hebben toegang tot TI- en PRD-omgevingen | Klant DAV (+ lokale beheerder in ACM/IDM) |
| ☐Ja |
Projectleden – voor zover relevant – hebben toegang tot TI- en PRD-omgevingen | Klant DAV (+ lokale beheerder in ACM/IDM) |
| ☐Ja |
Template ‘API-aanvraag’ invullen en bezorgen aan DAV | Integrator |
| ☐Ja |
API-credentials aanvragen en aanleveren aan integrator | DAV | 3 werkweken vanaf aanvraag | ☐Ja |
Toegang verlenen tot Klantportaal (met handleidingen) | DAV | 1 werkweek vanaf aanvraag | ☐Ja |
API-documentatie aanleveren | DAV | 1 werkdag | ☐Ja |
Indien nodig: metadatavelden/extensies voorzien (is onderdeel van functionele analyse) | DAV | 3 werkweken vanaf aanvraag | ☐Ja |
Optioneel: demo van E-depot | DAV | Reken 1,5 uur voor de demo | ☐Ja |
Test
Tijdens de test wordt de integratie op de TI-omgeving van het respectieve platform opgezet.
De integratie met de TI-omgeving wordt als geslaagd beschouwd als de klant kan valideren dat de gewenste informatie met alle metadata correct kan worden geraadpleegd in de TI-omgeving van de respectieve toepassing.
Aangeraden wordt om niet ALLE data die men wil archiveren op te laden in TI, maar slechts een beperkte dataset als testset te gebruiken.
CHECKLIST TESTING API-INTEGRATIE IN TI-OMGEVING E-DEPOT | |||
Voorwaarden | |||
Wat | Verantwoordelijke | Doorlooptijd | Uitgevoerd? |
Serie(s) aanmaken in Serieregister TI en indienen bij Selectiecommissie | Klant DAV |
| ☐Ja |
Serie(s) door Selectiecommissie gepubliceerd | DAV (= Selectiecommissie in TI) | 1 à 2 werkdagen vanaf aanvraag | ☐Ja |
Controle: zijn per serie de nodige metadata- en extensievelden geactiveerd? | Klant DAV |
| ☐Ja |
API beschikbaar? | Integrator |
| ☐Ja |
Check releaseplanning van DAV (zie Overzicht releaseplanning DAV) | Integrator |
| ☐Ja |
Productie
De integratie wordt opgezet op de productie-omgeving van het respectieve platform.
De integratie met de productie-omgeving wordt als geslaagd beschouwd als de klant kan valideren dat de gewenste informatie met alle metadata correct kan worden geraadpleegd in de productie-omgeving van de respectieve toepassing.
CHECKLIST API-INTEGRATIE IN PRD-OMGEVING E-DEPOT | |||
Voorwaarden | |||
Wat | Verantwoordelijke | Doorlooptijd | Uitgevoerd? |
Serie(s) aanmaken in Serieregister PRD en indienen bij Selectiecommissie | Klant DAV |
| ☐Ja |
Serie(s) door Selectiecommissie gepubliceerd | Bevoegde Selectiecommissie | Max. 30 kalenderdagen[1] | ☐Ja |
Controle: zijn per serie de nodige metadata- en extensievelden geactiveerd? | Klant DAV |
| ☐Ja |
API beschikbaar? | Integrator |
| ☐Ja |
Check releaseplanning van DAV (zie Overzicht releaseplanning DAV) | Integrator |
| ☐Ja |
[1] Termijn onder voorbehoud. Indien een serie wordt afgekeurd door de Selectiecommissie, is het aan Klant om in het Serieregister de nodige correcties uit te voeren en nadien de serie opnieuw in te dienen.
Ingebruikname
De integratie is volledig werkend.
Hebt u nog vragen of stelt u een technisch probleem vast bij het gebruik, dan kunt u dit melden via onze servicedesk.