Koppelprofiel Scanstraat: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(Configuratie van software componenten)
(Configuratie van software componenten)
Regel 64: Regel 64:
 
|- style="vertical-align:top"
 
|- style="vertical-align:top"
 
|Voor de configuratie van de componenten, gaat u als volgt te werk<br>
 
|Voor de configuratie van de componenten, gaat u als volgt te werk<br>
 +
<u>Watch 4 Folder</u>
 
* Open Watch 4 Folder, en zorg dat je in het tabblad "Watch List" alle aanwezige taken "removed"
 
* Open Watch 4 Folder, en zorg dat je in het tabblad "Watch List" alle aanwezige taken "removed"
 
* Ga naar watch settings, en neem de screenshot over.
 
* Ga naar watch settings, en neem de screenshot over.
 +
<u>run.bat</u>
 
* Ga via bestandsbeheer naar C:\Scanstraat\bin, en open hier run.bat in een editor naar keuze (notepad.exe)
 
* Ga via bestandsbeheer naar C:\Scanstraat\bin, en open hier run.bat in een editor naar keuze (notepad.exe)
 
* Verander de APIKEY naar de APIKEY die u heeft ingesteld onder het koppelprofiel "Scanstraat" in zaaksysteem
 
* Verander de APIKEY naar de APIKEY die u heeft ingesteld onder het koppelprofiel "Scanstraat" in zaaksysteem

Versie van 10 nov 2014 om 04:15

Inleiding

Wanneer deze koppeling actief is kunnen ingescande documenten automatisch geimporteerd worden naar de documentintake van het zaaksysteem. Vanuit de documentintake kunnen deze vervolgens in zaken geplaatst worden.

Er zijn twee manieren om documenten toe te voegen aan de documentintake.

  • Via de beheerserver
  • Via een aparte tool op een willekeurige windows server

Hieronder zijn beide methode opgenomen.

Aanlevermethoden

Beheerbox

Wanneer Mintlab een beheerbox heeft geinstalleerd binnen uw netwerk, dan zullen zij zorgdragen voor een zogenaamde "fileshare", via het Samba protocol, welke aangesproken kan worden binnen uw organisatie. Bestanden geplaatst op deze share zullen binnen enkele minuten verzonden worden aan zaaksysteem, waarna u de documenten terug kunt vinden in de documentintake.

Zaaksysteem

De zaaksysteemkant van de koppeling zal volledig beheerd worden door Mintlab: Er zal een koppelprofiel van het type 'Scanstraat' aangemaakt worden, waarin een unieke api-key wordt opgegeven.

Voordelen

  • U heeft geen beheer over de server, dit wordt door Mintlab geregeld

Nadelen

  • Bij problemen geen zicht op de oorzaak, contact loopt via Mintlab
  • Installatie van een beheerbox in uw netwerk

Windows aanlevertool

Omdat het aanleveren van bestanden naar zaaksysteem via dezelfde weg gaat als dat u normaal bestanden upload in zaaksysteem, is het ook mogelijk om op andere manieren bestanden aan te leveren. Mits gebruik gemaakt wordt van onze API. Wij hebben hiervoor een voorbeeld tool beschikbaar gesteld, welke u kunt installeren op uw windows omgeving. Deze tool bestaat uit drie componenten, welke zorgen voor het versturen van bestanden vanaf een windows directory naar zaaksysteem:

  • Directory watcher: het programma "Watch 4 Folder" welke een directory in de gaten kan houden, en wanneer nodig een commando kan uitvoeren
  • Het uit te voeren commando: een batch bestand welke via curl.exe (zie hieronder) het bestand aanlevert aan zaaksysteem
  • Curl. Een opensource tool voor het verzenden van gegevens naar een URL of het ophalen van data vanaf een URL

Voordelen

  • Scanstraat in eigen beheer: u heeft de koppeling volledig zelf in eigen hand
  • Aan de hand van de gegenereerde logfiles kunt u zelf probleem analyses uitvoeren
  • Koppeling is direct, loopt niet via een "blackbox" .

Nadelen

  • Een inhouse windows server dient te worden ingericht
  • Een beperkte set expertise is nodig om de tool te beheren

Downloaden

  • Mintlab Scanstraat: neem contact op met Mintlab voor de laatste versie - De scripts die de bestanden dmv curl verzenden aan zaaksysteem
  • Watch 4 Folder - De tool die zorgt voor het monitoren van de scan directory
  • Microsoft Visual C++ 2010 Redistributable Package - Standaard libraries om windows programma's te kunnen draaien gemaakt in Visual C++

Installatie

  • Installeer Watch 4 Folder. Bij de installatie, zort u ervoor dat u de meegeleverde AD-Ware niet accepteert. Dit voorkomt vervuiling van uw server
  • Plaats de aangeleverde scanstraat_VERSIE.zip van Mintlab op uw C:\ schijf of andere locatie, en zorg dat u deze uitpakt
  • Installeer "Microsoft Visual C++ 2010 Redistributable Package"

Configuratie

Configuratie van software componenten

Voor de configuratie van de componenten, gaat u als volgt te werk

Watch 4 Folder

  • Open Watch 4 Folder, en zorg dat je in het tabblad "Watch List" alle aanwezige taken "removed"
  • Ga naar watch settings, en neem de screenshot over.

run.bat

  • Ga via bestandsbeheer naar C:\Scanstraat\bin, en open hier run.bat in een editor naar keuze (notepad.exe)
  • Verander de APIKEY naar de APIKEY die u heeft ingesteld onder het koppelprofiel "Scanstraat" in zaaksysteem
  • Verander de HOST naar uw omgeving, bijvoorbeeld: https://mijn.gemeente.nl. Zorg dat u geen "/" aan het einde heeft staan
  • Mocht u besloten hebben om de tools van Mintlab op een andere locatie uit te pakken, past u dan ROOTPATH aan naar de nieuwe locatie.

Configuratie van uw fileshare

Mintlab gaat ervan uit dat er binnen uw organisatie een gedegen kennis aanwezig is voor het aanbieden van fileshares binnen het netwerk van uw organisatie. De scantool zal standaard de directory C:\Scanstraat\documenten uitlezen, maar dit mag elke andere directory zijn. Dit kunt u configureren binnen "Watch 4 Folder"

Troubleshooting

Mocht een en ander niet werken, dan worden 2 logs bijgehouden in C:\Scanstraat\logs

  • transfer.log: hierin vindt u de gegevens uit het Mintlab script. U zult hierin uit kunnen lezen of een bestand overgebracht kon worden of niet
  • scanstraat.log: de log van Watch 4 Folder

Bestandsnamen

De documentintake is zichtbaar voor alle gebruikers en standaard zijn de documenten hierbinnen dat ook. Het is echter wel mogelijk om documenten enkel zichtbaar te maken voor één gebruiker (per document). Dit kan gedaan worden door de documentnaam als volgt op te stellen: <gebruikersnaam><scheidingsteken><documentnaam>

Hierbij zijn:

Variabele Uitleg
<gebruikersnaam> De gebruikersnaam waarmee de gebruiker op het zaaksysteem inlogt.
<scheidingsteken> De 'file username seperator' die is opgegeven onder de geavanceerde opties van de zaaksysteemconfiguratie.
<documentnaam> De (rest van de) documentnaam.

De prefix zal bij het importeren van de documenten herkend en verwijderd worden door het zaaksysteem, en het document wordt vervolgens op naam van de gebruiker gezet. Bijvoorbeeld:

  • Martinus Haan scant een document in
  • De scanstraat noemt dit document: mhaan-20140101.pdf
  • Zaaksysteem ontvangt het document, hernoemt naar 20140101.pdf en zet het op naam van Martinus Haan
  • Enkel Martinus Haan kan dit document nu zien.

Let op: De meest gebruikelijke inrichting is dat de gebruiker zichzelf identificeert voor het scannen waardoor de scanstraat de gebruikersnaam van deze gebruiker kan meegeven in de documentnaam, maar het is voor de gemeente in principe ook mogelijk om ervoor te zorgen dat gebruikers naar andere gebruikers kunnen scannen.

Transacties

In het transactieoverzicht kan gezien worden of de transfers geslaagd of mislukt zijn. Bij mislukte transfers wordt ook de reden opgegeven, zodat de zaaksysteembeheerder hier actie op kan ondernemen, bijvoorbeeld: contact opnemen met de IT-afdeling of contact opnemen met Mintlab.


Mogelijke foutmeldingen zijn bijvoorbeeld:

  • Bestandtype niet toegestaan
  • Api-key komt niet overeen
  • Bestand bevat een virus
Transactieoverzicht
Voorbeeld van een mislukte transfer