Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1 Wat?
De SIP-creator v1.0 is een oplossing om de invoer van dossiers en stukken naar het E-depot te vereenvoudigen. Die invoer gebeurt door het aanmaken van een Submission Information Package (SIP). In de praktijk gaat het daarin om een .zip bestand, dat bestaat uit het metadatabestand met metadata van de dossiers en eventueel van de stukken en de dossiers zelf.
...
In deze documentatie wordt de eerste fase van de ontwikkelde tool beschreven. In deze fase krijgt de SIP-Creator een aantal basisfunctionaliteiten waarop in latere fases verder gebouwd wordt. In de volgende fase zal de tool verder ontwikkeld worden, zodat het ook gebruikt kan worden voor analoog archief.
1.1 Toepassingsgebied
De SIP-creator zal gebruikt kunnen worden in de volgende scenario’s:
Scenario 1: Elk dossier zit reeds geordend in een mappenstructuur. Er is een externe metadatafile aanwezig met extra metadata voor het dossier (deze file is niet conform het DAV-model)
Scenario 2: Er is 1 locatie met daarin ongeordende bestanden/stukken. Er is een externe metadatafile met metadata (niet conform het DAV-model) o.b.v. de externe metadatafile moeten de ongeordende stukken gestructureerd worden in dossiers (mappen).
Scenario 3: Elk dossier zit reeds geordend in een mappenstructuur. Er is geen externe metadatafile aanwezig.
1 De tool
1.1 Installatie
Via de Github kan je onder de SIP-Creator repository de code van de SIP-Creator downloaden en uitvoeren als ontwikkelaar (lees hiervoor zeker de README). Om de laatste release te installeren als gebruiker ga je naar de releases, hier vind je de laatste nieuwe versie van de applicatie.
Om de SIP-Creator uit te voeren als gebruiker, download je het .exe bestand. Dit zet je best lokaal op je computer (en niet in cloudapplicaties als Microsoft OneDrive), in een aparte map die je eerst zelf aanmaakt. Door de .exe aan te klikken start je de applicatie. Je hebt hier geen admin rechten voor nodig. Als je bij het uitvoeren van de applicatie een foutmelding krijgt, werkt het vaak om de tool te installeren in de temporary folder op je C-schijf.
1.2 Configuratie
In het eerste scherm is het nodig om via de knop “configuratie” de API en FTPS te configureren. Dit kan voor zowel de productie- als de testomgeving. Het is verplicht om de API te configureren, anders geeft de tool een foutmelding. API- en FTPS-credentials kan je bekomen door een ticket aan te maken in onze servicedesk: Inloggen (topdesk.net). De tool werkt als de FTPS niet geconfigureerd is, maar gaat dan een foutmelding geven als een SIP via de tool geüpload wordt. Het is wel mogelijk om dan de gemaakte SIP handmatig op te laden in het E-depot. Als de configuratie gebeurd is, wordt er een JSON-file toegevoegd in de bronmap. Het is dus niet nodig om elke keer de configuratie in te vullen, telkens als de SIP-Creator gebruikt wordt.
...
De SIP-Creator zal dan, als de SIP klaar is, een mapje aanmaken met de naam “SIP_Creator” in de bronmap waarin de SIP-Creator staat.
1.3 Invoer
1.3.1 Dossiers toevoegen
...
Vervolgens zie je drie knoppen staan: “Voeg dossier toe”, “Voeg folder met dossiers toe” en “Start SIP”. Je begint met het toevoegen van dossiers via de knop “Voeg dossier toe” of “Voeg folder met dossiers toe”. De tool stuurt je, bij allebei de knoppen, door naar Windows Verkenner. Hier kan je selecteren van welke dossiers je een SIP wilt maken. Als je via de knop “Voeg dossier toe” (nr. 1 op print screen) gaat, kan je de dossiers één per één toevoegen. Ga je via “Voeg folder met dossier toe” (nr. 2 op print screen), dan kan je een rootfolder selecteren. Onderliggende dossiers worden dan allemaal toegevoegd. Opgelet! Dossiers met eenzelfde naam kunnen niet toegevoegd worden in de SIP-Creator. Dit geld ook voor stukken met dezelfde naam. Binnen één SIP is het niet mogelijk om stukken met eenzelfde naam toe te voegen. De SIP-Creator zal dan een melding geven welke stukken aangepast moeten worden.
Het is ook mogelijk om dossiers op te zoeken via de zoekbalk (nr. 3 op print screen). Opgelet, deze is hoofdlettergevoelig. Je kan vervolgens een aantal dossiers selecteren of je kan ze allemaal selecteren (nr. 4 op print screen). Het is ten slotte mogelijk om de geselecteerde dossiers te verwijderen (nr. 5 op print screen). Om te kunnen starten met het aanmaken van de SIP, selecteer je de dossiers die je in een SIP wilt steken en druk je op de knop “Start SIP”.
1.3.2 SIP bewerken
...
Je krijgt daarop de mogelijkheid om de naam van de SIP te bewerken. Dit kan je doen door in het bovenste vakje te klikken. In eerste instantie krijgt de SIP de naam “SIP 1”. De tool gaat voor elke SIP die je maakt een oplopende nummering toekennen.
...
Boven het grid staan nog drie filters: “Verwijder file-extensie uit ‘Naam’ kolom geeft je de mogelijkheid om in bulk alle file-extensies weg te halen uit de kolom ‘Naam’. Bij het gebruik van een externe metadatafile die gemapt wordt naar het metadatamodel van DAV, gebeurt dit op basis van de kolom ‘Naam’. Aangezien deze exact overeen moet komen met de naam van de stukken, gaan hierin steeds de file-extensies opgenomen zijn. Deze filter vereenvoudigt het proces om ze er uit te halen. De filter “Toon enkel rijen met fouten” maakt het mogelijk om enkel de rijen weer te geven waarin rode en gele cellen staan. Als een fout opgelost wordt, is deze lijn niet meer zichtbaar met de filter aan. “Toon enkel dossiers” zorgt ervoor dat je enkel dossiers kunt zien. Opgelet! Het is technisch niet mogelijk om deze twee laatste filters gelijktijdig te gebruiken. Er moet dus een keuze gemaakt worden tussen de twee.
1.3.3 Controles
Er zijn een aantal controles die de tool automatisch uitvoert:
Controle ofgegevens configuratie juist zijn, zowel voor API als FTPS
Zijn de verplichte velden ingevuld?
Zijn de openings- en sluitingsdata van dossiers/stukken in range van de serie?
Zijn de openings- en sluitingsdata niet in de toekomst?
Zijn de openings- en sluitingsdata in het formaat JJJJ-MM-DD?
Zitten er lege mappen in de selectie?
Zijn alle dossiernamen binnen de SIP uniek?
Is het importsjabloon maximaal 9999 lijnen lang?
1.4 SIP maken
Door, nadat alle problemen opgelost zijn, op de knop “maak SIP” te drukken, gaat de SIP-Creator de SIP aanmaken. Opgelet, het is dan niet meer mogelijk om de SIP opnieuw te openen en te bewerken. Als je dit wel wilt doen, moet je op de knop “opslaan” klikken of het grid sluiten via het kruisje. Je kan vervolgens het grid, dat je gesloten hebt, terug openen door op “open” te klikken in de lijst van de SIPs in het eerste scherm waarin de dossiers geselecteerd moesten worden.
...
Er kan in het eerste scherm ten slotte ook gefilterd worden op de status van de SIP’s.
1.5 Extra functionaliteiten
Volgende functionaliteiten werden eerder nog niet benoemd:
...