Koppelprofiel Scanstraat: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
(→‎Configuratie van software componenten)
 
(52 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 13: Regel 13:
 
= Aanlevermethoden =
 
= Aanlevermethoden =
  
−
== Beheerbox ==
+
=== Beheerbox ===
  
−
Wanneer Mintlab een beheerbox heeft geinstalleerd binnen uw netwerk, dan zullen zij zorgdragen voor een zogenaamde "fileshare", via het [http://en.wikipedia.org/wiki/Samba_(software) 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.  
+
Wanneer Mintlab een beheerbox heeft geinstalleerd binnen uw netwerk, dan zullen zij zorg dragen voor een zogenaamde "fileshare", via het [http://en.wikipedia.org/wiki/Samba_(software) 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 ===
 
=== 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.
 
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'''
+
=== Windows aanlevertool ===
−
* U heeft geen beheer over de server, dit wordt door Mintlab geregeld
+
Het aanleveren van bestanden naar zaaksysteem gaat via dezelfde weg als dat u normaal bestanden upload in zaaksysteem. Het is daarom mogelijk om op andere manieren bestanden aan te leveren, mits gebruik gemaakt wordt van onze API. Mintlab heeft hiervoor een tool ontwikkeld die door de gemeente zelf op een server geïnstalleerd en beheerd kan worden. Op deze manier is het beheer van de scanstraat volledig in eigen beheer en verloopt deze niet via een "black box". Neem hiervoor contact op met Mintlab.
  
−
'''Nadelen'''
+
==== Installatie en Configuratie ====
−
* Bij problemen geen zicht op de oorzaak, contact loopt via Mintlab
+
{| width=100%
−
* Installatie van een beheerbox in uw netwerk
+
|- style="vertical-align:top;"
 +
|Voor de configuratie van de tool gaat u als volgt te werk:
  
−
== Windows aanlevertool ==
+
<ul>
−
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:
+
<li>Installeer de service</li>
−
 
+
<li>Start de meegeleverde configuratietool en stel in:
−
* Directory watcher: het programma "Watch 4 Folder" welke een directory in de gaten kan houden, en wanneer nodig een commando kan uitvoeren
+
  <ul>
−
* Het uit te voeren commando: een batch bestand welke via curl.exe (zie hieronder) het bestand aanlevert aan zaaksysteem
+
  <li>Het domein van uw zaaksysteem. Bijvoorbeeld: <nowiki>https://mijn.gemeente.nl/</nowiki></li>
−
* Curl. Een opensource tool voor het verzenden van gegevens naar een URL of het ophalen van data vanaf een URL
+
  <li>De API-sleutel ("[https://simple.wikipedia.org/wiki/Shared_secret shared secret]") zoals ingesteld in het koppelprofiel in Zaaksysteem</li>
−
 
+
  <li>Selecteer de folder van waaruit de scans geupload moeten worden naar de omgeving</li>
−
'''Voordelen'''
+
  <li>Klik op "Opslaan"</li>
−
 
+
  </ul>
−
* Scanstraat in eigen beheer: u heeft de koppeling volledig zelf in eigen hand
+
</li>
−
* Aan de hand van de gegenereerde logfiles kunt u zelf probleem analyses uitvoeren
+
</ul>
−
* 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
 
−
* [http://leelusoft.blogspot.nl/p/watch-4-folder-25.html Watch 4 Folder] - De tool die zorgt voor het monitoren van de scan directory
 
−
* [http://www.microsoft.com/en-us/download/confirmation.aspx?id=14632 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
+
De upload-service gebruikt het standaard Windows-Toepassings-logboek voor informatieve meldingen en fouten. Als bestanden niet (goed) verzonden worden, kan daar ook de reden gevonden worden.
−
* Plaats de aangeleverde scanstraat_VERSIE.zip van Mintlab op uw C:\ schijf of andere locatie, en zorg dat u deze uitpakt
+
|[[bestand:Scanstraat_service_configuratie.png|thumb|Service configuratie]]
−
* Installeer "Microsoft Visual C++ 2010 Redistributable Package"
 
−
 
 
−
=== Configuratie ===
 
−
 
 
−
==== Configuratie van software componenten ====
 
−
Voor de configuratie van de componenten, gaat u als volgt te werk
 
−
{| width="100%"
 
−
|- style="vertical-align:top"
 
−
|
 
−
<u>Watch 4 Folder</u>
 
−
* Open Watch 4 Folder, en zorg dat je in het tabblad 'Watch List' alle aanwezige taken 'removed'
 
−
* Ga naar het tabblad 'watch settings', en neem de screenshot over
 
−
* Sla de settings op met 'apply'
 
−
* Ga naar het tabblad 'watch list' en activeer de 'watch' met de 'start'-knop
 
−
<u>run.bat</u>
 
−
* 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.
 
−
|[[bestand:Watch_for_folder_settings.png|thumb|Watch 4 Folder settings]]
 
−
[[bestand:scanstraat_runbat_settings.png|thumb|run.bat settings]]
 
 
|}
 
|}
  
−
==== Configuratie van uw fileshare ====
+
= Type documentintake =
 +
De documentintake is één onderdeel, maar wordt op twee manieren gebruikt: De algemene documentintake en de persoonlijke documentintake.
  
−
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"
+
=== 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).
  
−
=== Troubleshooting ===
+
=== Persoonlijke documentintake ===
 +
Gebruikers die niet de [[Gebruikers#Systeemrollen|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.
  
−
Mocht een en ander niet werken, dan worden 2 logs bijgehouden in C:\Scanstraat\logs
+
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.
  
−
* 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
+
===== Voorbeeld =====
−
* scanstraat.log: de log van Watch 4 Folder
+
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:
 +
<ul>
 +
<li>Martinus Haan scant een document in</li>
 +
<li>De scanstraat noemt dit document: mhaan-20140101.pdf</li>
 +
<li>Zaaksysteem ontvangt het document, hernoemt naar 20140101.pdf en zet het op naam van Martinus Haan</li>
 +
<li>Enkel Martinus Haan kan dit document nu zien.
 +
</ul>
  
−
= Bestandsnamen =
+
===== Toelichting opbouw documentnaam=====
−
 
 
−
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><br>
 
−
<br>
 
−
Hierbij zijn:
 
 
{| class="wikitable"
 
{| class="wikitable"
 
!Variabele
 
!Variabele
Regel 102: Regel 73:
 
|-  
 
|-  
 
|<scheidingsteken>
 
|<scheidingsteken>
−
|De '[http://wiki.zaaksysteem.nl/Configuratie#File_username_seperator file username seperator]' die is opgegeven onder de geavanceerde opties van de zaaksysteemconfiguratie.
+
|De '[[Configuratie#File_username_seperator|File username separator]]' die is opgegeven onder de geavanceerde opties van de zaaksysteemconfiguratie.
 
|-  
 
|-  
 
|<documentnaam>
 
|<documentnaam>
 
|De (rest van de) 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:
+
 
−
<ul>
+
===== Inrichting scanners =====
−
<li>Martinus Haan scant een document in</li>
+
De gemeente kan zelf kiezen hoe zij de opbouw van de documentnamen bewerkstelligt, 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.
−
<li>De scanstraat noemt dit document: mhaan-20140101.pdf</li>
 
−
<li>Zaaksysteem ontvangt het document, hernoemt naar 20140101.pdf en zet het op naam van Martinus Haan</li>
 
−
<li>Enkel Martinus Haan kan dit document nu zien.
 
−
</ul>
 
−
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 =
 
= Transacties =

Huidige versie van 22 aug 2016 om 06:34

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 zorg dragen 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.

Windows aanlevertool

Het aanleveren van bestanden naar zaaksysteem gaat via dezelfde weg als dat u normaal bestanden upload in zaaksysteem. Het is daarom mogelijk om op andere manieren bestanden aan te leveren, mits gebruik gemaakt wordt van onze API. Mintlab heeft hiervoor een tool ontwikkeld die door de gemeente zelf op een server geïnstalleerd en beheerd kan worden. Op deze manier is het beheer van de scanstraat volledig in eigen beheer en verloopt deze niet via een "black box". Neem hiervoor contact op met Mintlab.

Installatie en Configuratie

Voor de configuratie van de tool gaat u als volgt te werk:
  • Installeer de service
  • Start de meegeleverde configuratietool en stel in:
    • Het domein van uw zaaksysteem. Bijvoorbeeld: https://mijn.gemeente.nl/
    • De API-sleutel ("shared secret") zoals ingesteld in het koppelprofiel in Zaaksysteem
    • Selecteer de folder van waaruit de scans geupload moeten worden naar de omgeving
    • Klik op "Opslaan"

De upload-service gebruikt het standaard Windows-Toepassings-logboek voor informatieve meldingen en fouten. Als bestanden niet (goed) verzonden worden, kan daar ook de reden gevonden worden.

Service configuratie

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 separator' 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 bewerkstelligt, 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
Overgenomen van "http://wiki.zaaksysteem.nl/index.php?title=Koppelprofiel_Scanstraat&oldid=9316"