Koppelprofiel Scanstraat: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(Installatie en Configuratie)
(Windows aanlevertool)
Regel 28: Regel 28:
  
 
== Windows aanlevertool ==
 
== 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:
+
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.
  
* Directory watcher: het programma "Watch 4 Folder" welke een directory in de gaten kan houden, en wanneer nodig een commando kan uitvoeren
+
Op deze manier heeft u de scanstraat volledig in eigen beheer en verloopt deze niet via een "blackbox". Wel is een windows server is vereist.
* 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
 
  
 
=== Installatie en Configuratie ===
 
=== Installatie en Configuratie ===
Voor de configuratie van de componenten, gaat u als volgt te werk
+
Voor de configuratie van de tool gaat u alsvolgt te werk:
  
<u>Microsoft Visual C++</u>
 
 
<ul>
 
<ul>
<li>Installeer [http://www.microsoft.com/en-us/download/confirmation.aspx?id=14632 Microsoft Visual C++ 2010 Redistributable Package]</li>
+
<li>Download: [http://zaaksysteem.nl/download/ZaaksysteemUploadSetup.msi Zaaksysteem Configureertool]</li>
</ul>
+
<li>Installeer de configureertool</li>
 
+
<li>Start de configureertool en stel in:
<u>Mappenstructuur</u>
+
  <ul>
<ul>
+
  <li>Het domein van uw zaaksysteem. Bijvoorbeeld: https://mijn.gemeente.nl/</li>
<li>Plaats op uw C:\ schijf (of andere locatie naar keuze) een folder genaamd 'Scanstraat'</li>
+
  <li>Selecteer de folder van waaruit de scans geupload moeten worden naar de omgeving</li>
<li>Plaats in Scanstraat-folder de folders genaamd 'bin', 'documenten' en 'log'</li>
+
  </ul>
<li>Plaats in de log-folder een leeg tekstbestand genaamd 'scanstraat.txt'</li>
 
</ul>
 
 
 
<u>curl.exe</u>
 
<ul>
 
<li>Ga naar http://curl.haxx.se/download.html en download de laatste versie van 'Win32 zip' met SSL support</li>
 
<li>Plaats het curl.exe bestand in de C:\Scanstraat\bin</li>
 
</ul>
 
{| width="100%"
 
|- style="vertical-align:top"
 
|
 
<u>run.bat</u>
 
<ul>
 
<li>Maak een textbestand run.bat met de volgende inhoud: [https://bitbucket.org/mintlab/zaaksysteem/src/master/bin/scanstraat.sh?at=master&fileviewer=file-view-default Mac] / [https://bitbucket.org/mintlab/zaaksysteem/src/master/bin/scanstraat.bat?at=master&fileviewer=file-view-default Windows]<br>
 
Let op: Voor de API key vereist Windows dat sommige tekens escaped worden. Zie hiervoor: [http://ss64.com/nt/syntax-esc.html ss64] en/of [http://www.robvanderwoude.com/escapechars.php robvanderwoude]. Bijvoorbeeld: 'Command&Conquer' moet 'Command^&Conquer' worden.
 
 
</li>
 
</li>
<li>Ga via bestandsbeheer naar C:\Scanstraat\bin, en open hier run.bat in een editor naar keuze (notepad.exe)</li>
 
<li>Verander de APIKEY naar de APIKEY die u heeft ingesteld onder het koppelprofiel "Scanstraat" in zaaksysteem</li>
 
<li>Verander de HOST naar uw omgeving, bijvoorbeeld: https://mijn.gemeente.nl.<br>Zorg dat u begint met "https://" en aan het einde geen "/" heeft staan</li>
 
<li>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.<br>Zorg dat u hier wel "\" aan het einde heeft staan</li>
 
</ul>
 
 
|[[bestand:scanstraat_runbat_settings.png|thumb|run.bat settings]]
 
|}
 
{| width="100%"
 
|- style="vertical-align:top"
 
|
 
<u>Watch 4 Folder</u>
 
<ul>
 
<li>Installeer: [http://leelusoft.blogspot.nl/p/watch-4-folder-25.html Watch 4 Folder] (let op AD-Ware)</li>
 
<li>Open Watch 4 Folder, en zorg dat je in het tabblad 'Watch List' alle aanwezige taken 'removed'</li>
 
<li>Ga naar het tabblad 'watch settings', en neem de screenshot over</li>
 
<li>Sla de settings op met 'apply'</li>
 
<li>Ga naar het tabblad 'watch list' en activeer de 'watch' met de 'start'-knop</li>
 
 
</ul>
 
</ul>
 
|[[bestand:Watch_for_folder_settings.png|thumb|Watch 4 Folder settings]]
 
|}
 
  
 
=== Troubleshooting ===
 
=== Troubleshooting ===
  
Mocht een en ander niet werken, dan worden 2 logs bijgehouden in C:\Scanstraat\logs
+
Mocht een en ander niet werken, dan kunt u de logs inzien in [under_construction]
 
 
* 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
 
  
 
= Type documentintake =
 
= Type documentintake =

Versie van 21 dec 2015 om 16:55

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.

Op deze manier heeft u de scanstraat volledig in eigen beheer en verloopt deze niet via een "blackbox". Wel is een windows server is vereist.

Installatie en Configuratie

Voor de configuratie van de tool gaat u alsvolgt te werk:

Troubleshooting

Mocht een en ander niet werken, dan kunt u de logs inzien in [under_construction]

Type documentintake

De documentintake is één onderdeel, maar wordt op twee manieren gebruikt: De algemene documentintake en de persoonlijke documentintake.

Algemene documentintake

Alle documenten in de documentintake zijn zichtbaar voor gebruikers met de rollen: Administrator, Zaaksysteembeheerder, Zaakbeheerder. Deze gebruikers hebben de mogelijkheid om te schakelen tussen de algemene documentintake (alle documenten) en de persoonlijke documentintake (de documenten op hun naam).

Persoonlijke documentintake

Gebruikers die niet de Systeemrollen 'Administrator', 'Zaaksysteembeheerder' of 'Zaakbeheerder' hebben kunnen enkel documenten zien die op hun naam staan. Zij zien dus niet de documenten van anderen en de andere zien niet de documenten van die persoon.

Documenten kunnen op naam van een gebruiker gezet worden door de documentnaam van de scan als volgt op te stellen: <gebruikersnaam><scheidingsteken><documentnaam>. Het gebruik van prefixes voor persoonlijke documenten sluit de normale werking niet uit. Wanneer een documentnaam geen scheidingsteken bevat zal het document zoals normaal voor iedereen zichtbaar zijn.

Voorbeeld

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.
Toelichting opbouw documentnaam
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.
Inrichting scanners

De gemeente kan zelf kiezen hoe zij de opbouw van de documentnamen bewerkstelligd, zolang het uiteindelijke resultaat niet meer dan één scheidingsteken bevat. De meest gebruikelijke inrichting is dat gebruikers inloggen op de scanner, zodat de gebruikersnaam van de scannende persoon bekend is en gebruikt kan worden voor het opbouwen van de documentnaam. Een inrichting waarbij gebruikers andere gebruikers kunnen selecteren is ook denkbaar, of een inrichting waarbij gebruikers na het inloggen nog kunnen kiezen om hun gebruikersnaam toe te voegen aan het document of niet. De limiet hierbij is de software van de scanner/scanserver.

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