Introductie

Met dit programma kunnen (meta)databestanden rechtstreeks worden geïmporteerd in Swing zonder tussenkomst van Swing Studio. Het is ook mogelijk om dit periodiek met de Windows taakplanner uit te voeren. De (meta) data wordt dus op vaste tijdstippen volledig geautomatiseerd geimporteerd en levert hierdoor tijdwinst op.

Vaak bestaat het beheren van een Swing versie uit het op vaste momenten importeren van data, zoals het wekelijks importeren van bevolkings- of woningdata afkomstig van het BPR of BAG. Daarnaast neemt het importeren van data ongemerkt tijd in beslag; zoals het inloggen in Studio, via het importmenu de bestanden selecteren, de bestanden uploaden, het selecteren van de gewenste importopties en het importproces zelf. Door dit proces te automatiseren wordt tijdswinst geboekt.

In deze instructie wordt uitgelegd hoe u deze handelingen geautomatiseerd uit kan laten voeren middels het programma FilesToSwing in combinatie met de Windows taakplanner. Indien u hierin interesse heeft kunt u contact opnemen met de Swing Helpdesk via telefoonnummer 015 – 27 99 399 of per mail: helpdesk@swing.eu.

Een schematische weergave van het proces is hieronder weergegeven;

filestoswing

Installatie

Het volgende is vereist:

  • Het programma (FilesToSwing.exe) dat de daadwerkelijke taken uitvoert.
  • De importbestanden die in Swing moeten worden ingelezen.
  • Een batchbestand (*.bat) waarmee het programma, inclusief opgegeven parameters, aangeroepen wordt zodat de bestanden geimporteerd worden. Dit batchbestand kan middels de Windows taakplanner geautomatiseerd en op vaste momenten gestart worden.

Het programma (FilesToSwing.exe) dient geinstalleerd te zijn op de computer waar de (periodieke) taak wordt uitgevoerd, dit kan ook een server zijn. Dit programma moet leesrechten hebben voor de map waar de bestanden staan die naar Swing worden verzonden. Ook zal Http(s) verkeer (80 een 443) moeten worden toegestaan.

De bestanden moeten 'importklaar' zijn en voldoen aan de import eisen van Studio zodat deze geimporteerd kunnen worden. Voorbeelden van importbestanden kunt u hier downloaden. De locatie van de bestanden kan elke willekeurige plek zijn; als ze maar door het programma FilesToSwing.exe te benaderen zijn.

In het batchbestand dient een regel te worden opgenomen waarbij het programma FilesToSwing.exe wordt aangeroepen inclusief de gewenste parameters. Een aantal parameters zijn vereist en een aantal zijn optioneel. Ze worden hieronder besproken.

Vereiste parameters

Een aantal parameters zijn verplicht en dienen altijd opgegeven te worden.

url

De URL van de doel Swing versie. Wanneer het de bedoeling is om data te importeren in Swing Studio dan moet de URL eindigen met ‘/admin’ zoals bijvoorbeeld 'https://demo5.swing.eu/admin'. Bij het importeren van data in de live versie moet het gedeelte ‘/admin’ achterwege gelaten worden. Bijvoorbeeld 'https://demo5.swing.eu'. De URL moet beginnen met ‘https’.

apikey

Een API key, zoals :a0bc12d3-4e56-7890-123f-456789g0h12. Als er nog geen API key bekend is kan deze opgevraagd worden bij ABF. De API key wordt gebruikt ter autorisatie.

datadir

De map waarin één of meerdere bestanden staan die geïmporteerd moeten worden, zoals “D:\Import bestanden”. Wanneer het pad een spatie bevat dan moet deze opgegeven worden met aanhalingstekens. De importbestanden moeten kolomnamen hebben die automatisch door Swing herkend worden. Een voorbeeld van Swing importbestanden kunt u hier downloaden.

clearCache (true/false)

Leegt de cache van Swing na het importeren van bestanden. Kan soms benodigd zijn om er zeker van te zijn dat de meest recente data in Swing Viewer getoond wordt.

Optionele parameters

Een aantal parameters zijn optioneel. De onderstreepte waarde (true of false) van de optionele parameters zijn de standaardwaarden wanneer de parameter niet wordt opgegeven. De parameter 'adjustStartAndEndperiod' wordt dus altijd toegepast indien deze niet is opgegeven. De optionele parameters komen grotendeels overeen met de beschikbare opties in Swing Studio wanneer er data wordt geïmporteerd.

adjustStartAndEndperiod (true/false)

Automatisch start- en eindperioden van geïmporteerde onderwerpen aanpassen in de onderwerpentabel van Studio.

appendData (true/false)

Records met dezelfde kenmerken automatisch totaliseren (alleen mogelijk bij absolute waarden, niet mogelijk bij gegevenstype: Data - Waarde per record).

importEmptyAndNvt (true/false)

Data records met alleen NVT (-99998) of EMPTY (-99996) waarden verwijderen. Deze records worden dus niet geimporteerd.

skipRecordsWithUnknownDimItems (true/false)

Records met onbekende kenmerken overslaan. Onbekende geoitems of dimensie items worden genegeerd tijdens het importproces en dus niet geimporteerd.

clearData (true/false)

Eerst alle data verwijderen uit Studio (van de onderwerpen in het importbestand), voordat de data geimporteerd wordt.

Email (e-mailadres)

Verzend een e-mail naar het opgegeven adres nadat de bestanden zijn verzonden naar Swing. Op deze manier is het snel bekend of het verzenden van het bestand is gelukt.

Het batchbestand

Het programma FilesToSwing.exe kan aangeroepen worden via een batchbestand (.bat). In dit bestand dient een regel te worden opgenomen naar onderstaand voorbeeld:

FilesToSwing.exe --url https://demo5.swing.eu/admin --apikey a0bc12d3-4e56-7890-123f-456789g0h12 --datadir "D:\Files" --clearCache true --appendData true --adjustStartAndEndperiod true --importEmptyAndNvt false --skipRecordsWithUnknownDimItems true --clearData false --email naam@domein.com

Alle parameters worden vooraf gegaan door een spatie en een dubbel minteken gevolgd door een spatie en de waarde van de parameter. De volgorde van de parameters is niet van belang.

Uitvoeren batchbestand via taakplanner

Nadat het batchbestand is opgemaakt, kan deze worden gestart waarna de bestanden worden ingelezen. Het is echter ook mogelijk om dit batchbestand geautomatiseerd op vooraf ingestelde momenten te starten. Dit kan middels de taakplanner van Windows en is een programma dat standaard beschikbaar in het Windows besturingssysteem. Via de volgende stappen kan een taak in Windows gemaakt worden die op een specifiek tijdstip een batchbestand uitvoert.

1. Open taakplanner.

stap_1

2. Maak een basistaak.

stap_2

3. Vul een naam in en klik daarna op volgende.

stap_3

4. Selecteer wanneer de taak moet worden gestart en klik daarna op volgende.

stap_4

5. Bij de meeste opties uit de vorige stap volgt een stap waarbij het tijdstip van uitvoeren nog specifieker gedefinieerd dient te worden. Wanneer bijvoorbeeld wekelijks is geselecteerd dan volgt onderstaande stap waarin een dag, tijdstip en herhalingsfrequentie gekozen dienen te worden. Klik daarna op volgende.

stap_5

6. Selecteer ‘Een programma starten’ en klik daarna op volgende.

stap_6

7. Selecteer het uit te voeren batchbestand en klik daarna op volgende.

stap_7

8. Klik op voltooien.

stap_8

9. De taak is nu zichtbaar in het overzicht van taken. De eigenschappen van de taak kunnen gewijzigd worden door de taak te openen via een dubbele muisklik op de taak of via ‘Eigenschappen’ middels de rechtermuis knop.

stap_9