Submission information package (SIP)

Owned by stijn.bovy (Unlicensed), created
Last updated: Sept 18, 2023
4 min read

Importeren van dossiers via SIP

Het importeren van dossiers gebeurt aan de hand van een submission information package (SIP). In de praktijk zijn de SIP’s die in het E-depot worden geüpload via de semi-automatische import een zipbestand (.zip). Hieronder is de opbouw, logica van een SIP voor het E-depot beschreven.

Een SIP heeft steeds betrekking op één serie. Dit zorgt ervoor dat tijdens het invoerproces de juiste dossiers op een eenvoudige manier aan de juiste serie worden gekoppeld. Per serie is er ook een specifiek importbestand dat wordt gegenereerd in het E-depot.

SIP als geheel

In een SIP moeten de volgende zaken terug te vinden zijn:

  • Het metadatabestand met metadata van de dossiers en eventueel van de stukken,

  • De dossiers zelf.

Om de import gestructureerd te laten verlopen, worden de volgende regels gehanteerd binnen een SIP:

  • Elke map in de ‘root’ van het zipbestand wordt als een dossier beschouwd (concreet is dit de bovenste lijst van mappen),

  • Elk dossier moet beschreven zijn in het bijhorende metadatabestand in het correcte Excelsjabloon (zie verder).

Afwijken van deze regels kan o.a. de volgende implicaties hebben:

  • Een verkeerde koppeling tussen de informatie en de metadata ervan (bv. de verkeerde metadata die aan een dossier wordt gekoppeld),

  • Stukken die in de verkeerde dossiers terecht komen,

  • De volledige invoer die faalt,

  • …

Dossiers in SIP

Binnen een SIP gelden voor dossiers de volgende regels:

  • Elk bestand wordt gelijkgesteld aan één stuk. Dit stuk wordt gekoppeld aan het dossier (de map) waar het onderdeel van uitmaakt,

  • Indien een dossier is opgebouwd uit verschillende submappen, worden de namen van deze submappen weggeschreven in de metadatavelden ‘Path’ en ‘Path in tags’. Deze metadatavelden worden dan gekoppeld aan het stuk.

Metadatabestand

Een metadatabestand kent de volgende opbouw:

  • Structuurvelden: deze velden zorgen ervoor dat de applicatie weet welke metadata bij welke objecten hoort:

    • Path in SIP:

      • Voor een dossier is dit is de naam van de ‘root’map waarin een dossier zit. 

      • Voor een stuk is dit de naam van de map waarin het zit, gevolgd door een / waarna de bestandsnaam met extensie wordt opgegeven. Concreet ziet dit er als volgt uit ‘mapnaam/bestandsnaam.extensie’.
        LET OP: dit veld is hoofdlettergevoelig. Als er in de bestandsnaam of de mapnaam een hoofdletter staat, dan moet dit ook zo worden overgenomen. Dit geldt ook voor de schrijfwijze van de bestandsextensie, bijvoorbeeld .png of .PNG.

    • Type: dit veld duidt aan of het over een dossier of een stuk gaat. Dit veld wordt automatisch ingevuld als het veld ‘path in SIP’ is ingevuld.

    • DossierRef: wordt automatisch afgeleid van het ingegeven path in SIP. Als het ‘type’ een dossier is dan zal hier hetzelfde staan als in het veld ‘Path in SIP’, als het type een ‘stuk’ is dan zal hier de naam van het dossier staan waartoe het stuk behoort.

  • Het kernmodel: dit zijn alle velden van het datamodel van het E-depot.

  • De extensies: dit zijn alle velden van de extensie die aan de respectievelijke serie zijn verbonden. De extensies zelf zijn gedefinieerd in het Serieregister en de businessregels op die extensie (d.w.z. het al dan niet verplicht zijn van die velden) zijn beschikbaar in het Serieregister.

De algemene stelregels om het metadatabestand in te vullen, zijn: 

  • Elk dossier dat in de SIP is opgenomen, moet beschreven zijn,

  • Een stuk moet enkel opgenomen en beschreven worden als er andere of meer gegevens gekoppeld moeten worden dan diegene die geëxtraheerd kunnen worden uit de bestandseigenschappen. Voorbeelden van metadata die geëxtraheerd worden uit de bestandseigenschappen zijn:

    • Bestandsnaam: standaard wordt deze naam beschouwd als de naam van het stuk,

    • Creatiedatum: de creatiedatum van het bestand wordt standaard gelijkgesteld met de creatiedatum van het stuk,

    • Auteur: de auteur van het bestand wordt standaard gelijkgesteld met de auteur van het stuk.

  • Beschrijf eerst het dossier en dan pas de stukken van het dossier.

​​​​​​​Als de inhoud van bovenstaande velden moet afwijken van de automatisch geëxtraheerde informatie, dan moet het stuk in kwestie beschreven worden in het metadatabestand.

  • De verplichte velden op dossierniveau zijn:

    • Naam,

    • Openingsdatum,

    • Sluitingsdatum.

  • De verplichte velden op stukniveau zijn: 

    • Naam.

  • Technische metadata worden nooit beschreven. Deze worden tijdens het opladen rechtstreeks uit de bestanden geëxtraheerd.

  • Als bepaalde velden meerdere waarden moeten bevatten, bijvoorbeeld ‘Trefwoorden_vrij’, dan moeten er meerdere kolommen met dezelfde kolomtitel worden gecreëerd. Meerdere waarden in één kolom zullen door het systeem worden herkend als één waarde.

  • Openings- en sluitingsdatum: deze velden moeten enkel worden ingevuld op rijen waar dossiers worden beschreven.

  • Als een extensie bepaalde velden verplicht maakt op het niveau van het dossier of het stuk, dan moeten deze velden ook effectief worden ingevuld vooraleer er wordt geïmporteerd. Anders zal de invoer falen.

Toegelaten formattering

  • Voor de openings- en sluitingsdatum mag enkel het toegelaten formaat worden gebruikt: JJJJ-MM-DD.

  • De identificatie van een persoon gebeurt aan de hand van een rijksregisternummer, een BIS-registernummer of de naam. De formattering van deze velden met nummers is de volgende:

    • Rijksregisternummer: xx.xx.xx-xxx.xx

      • x is telkens een getal,

      • Het controlegetal moet correct zijn, volgens de regels zoals hier vermeld.

    • BIS-registernummer: xx.xx.xx-xxx.xx

      • x is telkens een getal,

      • Het controlegetal moet correct zijn - zelfde als bij rijksregisternummer -, en de maand moet geldig zijn voor een BIS-registernummer. Dit wil zeggen dat er 20 of 40 bijgeteld moet zijn bij de maand van het rijksregisternummer.

  • De identificatie van een organisatie gebeurt aan de hand van een KBO-nummer, een OVO-nummer of de organisatienaam. De formattering van deze velden met nummers is de volgende:

    • KBO-nummer: xxxx.xxx.xxx

      • x is telkens een getal,

      • Het eerste getal van een KBO-nummer is 0 of 1.

    • OVO-nummer: OVOxxxxxx

      • x is telkens een getal.

Metadatamodel

De actuele versie van het datamodel voor het E-depot is niet langer publiek toegankelijk en maar kan op simpel verzoek worden bekomen via   digitaalarchief@vlaanderen.be.