Difference between revisions of "Scanner Client"

From OpenKM Documentation
Jump to: navigation, search
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOCright}} __TOC__
 
{{TOCright}} __TOC__
  
 +
Take a look at [[Scanner client change log]] to see the release notes.
 +
 +
== Requeriments ==
 +
Before running the application be sure you get installed Visual C++ Redistributable for Visual Studio
 +
*.NET 4.0: Visual C++ Redistributable for Visual Studio 2012 ([http://www.microsoft.com/en-us/download/details.aspx?id=30679 x86or x64]) ( Recommended )
 +
*.NET 2.0: Visual C++ Redistributable for Visual Studio 2008 ( [http://www.microsoft.com/en-us/download/details.aspx?id=29 x86] or  [http://www.microsoft.com/en-us/download/details.aspx?id=15336 x64])
 +
 +
== Introduction ==
 
Scanner Client allows to capture images from scanners, obtionally convert to pdf and upload to OpenKM setting metadata values.
 
Scanner Client allows to capture images from scanners, obtionally convert to pdf and upload to OpenKM setting metadata values.
  
 
[[File:Okm_user_guide_518.png]]
 
[[File:Okm_user_guide_518.png]]
  
* [[File:Scan.png]] Scan action
+
== Toolbar buttons ==
 +
* [[File:Scan.png|32px]] Scan action
 +
* [[File:Convert pdf.png|32px]] Convert to pdf
 +
* [[File:Refresh_scanner_icon.png|32px]] Refresh tree
 +
* [[File:Server upload.png|32px]] Upload document
 +
* [[File:Page delete scanner icon.png|32px]] Delete page from pdf
 +
* [[File:AddPage.jpg|32px]] Add page to pdf
  
  
== Configuration ==
+
== OpenKM Server Configuration ==
 
With '''Configuration''' / '''Server configuration''' menu option is shown the configuration Popup.  
 
With '''Configuration''' / '''Server configuration''' menu option is shown the configuration Popup.  
  
Line 22: Line 36:
  
 
To accept configuration parameters changes, click in '''Accept''' button.
 
To accept configuration parameters changes, click in '''Accept''' button.
 +
 +
== Setting destination folder ==
 +
To change OpenKM destination folder where document will be uploaded, click '''top right button Change'''.
 +
 +
[[File:Okm_user_guide_534.png]]
 +
 +
Will be shown a tree explorer popup.
 +
 +
[[File:Okm user guide 533.png]]
 +
 +
Select the destination folder and finally click on '''Select''' button.
  
 
== Scanner configuration ==
 
== Scanner configuration ==
Line 40: Line 65:
 
To accept configuration parameters changes, click in '''Accept''' button.
 
To accept configuration parameters changes, click in '''Accept''' button.
  
 +
== Scan ==
 +
* Click toolbar button [[File:Scan.png|20px]]. Depeding if you've selected WIA or TWAIN the next screen will be quite different.
 +
 +
[[File:Okm_user_guide_520.png|900px]]
 +
 +
Follow the screen instructions.
 +
 +
[[File:Okm_user_guide_521.png]]
 +
 +
Will be created a folder based on date ('''year-month-day''') into your server at My '''images/OKMScan/Images'''
 +
 +
[[File:Okm_user_guide_522.png]]
 +
 +
[[File:Okm_user_guide_523.png]]
 +
 +
== Convert to pdf ==
 +
Select one or more image files from tree.
 +
 +
[[File:Okm_user_guide_524.png]]
 +
 +
Click toolbar button [[File:Convert pdf.png|20px]] to convert all selected images to pdf. When conversion will be finished will appear a message indicating it.
 +
 +
[[File:Okm_user_guide_525.png]]
 +
 +
The pdf file will be created into a folder based on date ('''year-month-day''') into your server at '''My images/OKMScan/Pdfs'''
 +
 +
[[File:Okm_user_guide_526.png]]
 +
 +
[[File:Okm_user_guide_527.png]]
 +
 +
== Uploading ==
 +
Select one or more files ( images or pdf ) and click button [[File:Server upload.png|20px]] to upload document.
 +
 +
[[File:Okm_user_guide_528.png]]
 +
 +
If application detects file already exist into OpenKM repository will require you validate update version or rename.
 +
 +
[[File:Okm_user_guide_529.png]]
 +
 +
Aplication will require you optionally set property groups (metadata) to documents.
 +
 +
[[File:Okm_user_guide_530.png]]
 +
 +
If you want to set property groups (metadata) click on '''Add''' button. And follow the wizard.
 +
 +
[[File:Okm_user_guide_531.png]]
 +
 +
At ends of process is shown a popup indicating the documents has successfuly uploaded.
 +
 +
[[File:Okm_user_guide_532.png]]
 +
 +
== Add images into existing pdf ==
 +
Can be added images on existing pdf files. For doing it click [[File:AddPage.jpg|20px]] Add page to pdf toolbar icon. Will be shown extra icons what will help on this action.
 +
 +
[[File:Okm_user_guide_535.png]]
 +
 +
Action has tree steps, first is select a pdf file and then click the icon [[File:Step1.png|20px]] to confirm pdf selection.
 +
 +
[[File:Okm_user_guide_536.png]]
 +
 +
The second step is select one or more images and click the icon [[File:Step2.png|20px]] to confirm images selection
 +
 +
[[File:Okm_user_guide_537.png]]
 +
 +
A finally clicke the icon [[File:Step3.png|20px]] to add images. Will be shown a popup to confirm the action.
 +
 +
[[File:Okm_user_guide_538.png]]
 +
 +
And a popup to confirm that operation has been done.
 +
 +
[[File:Okm_user_guide_539.png]]
 +
 +
== Remove pages from existing pdf ==
 +
Can be removed pages from existing pdf. For doing it click the toolbar option [[File:Page delete scanner icon.png|20px]] delete page from pdf. Will be shown a popup indicating what page or range of pages want to delete.
 +
 +
[[File:Okm_user_guide_540.png]]
 +
 +
Click Accept button and the pages will be removed from pdf.
 +
 +
== Compression CCITT Group4 ==
 +
To enable compression '''Configuration''' / '''Compression group4''' menu option is shown the configuration Popup.
 +
 +
Configuration parameters available are:
 +
* Enable black and white CCITT Group4 compression
 +
* Percentage (Thereshold)
 +
 +
[[File:Okm_user_guide_541.png]]
 +
 +
 +
To accept configuration parameters changes, click in '''Accept''' button.
  
 
[[Category: User Guide]]
 
[[Category: User Guide]]

Latest revision as of 07:28, 27 June 2014

Take a look at Scanner client change log to see the release notes.

Requeriments

Before running the application be sure you get installed Visual C++ Redistributable for Visual Studio

  • .NET 4.0: Visual C++ Redistributable for Visual Studio 2012 (x86or x64) ( Recommended )
  • .NET 2.0: Visual C++ Redistributable for Visual Studio 2008 ( x86 or x64)

Introduction

Scanner Client allows to capture images from scanners, obtionally convert to pdf and upload to OpenKM setting metadata values.

Okm user guide 518.png

Toolbar buttons

  • Scan.png Scan action
  • Convert pdf.png Convert to pdf
  • Refresh scanner icon.png Refresh tree
  • Server upload.png Upload document
  • Page delete scanner icon.png Delete page from pdf
  • AddPage.jpg Add page to pdf


OpenKM Server Configuration

With Configuration / Server configuration menu option is shown the configuration Popup.

Configuration parameters available are:

  • OpenKM version which client connects to.
  • User interface language
  • User and password to connect
  • The OpenKM server host


Okm user guide 488.png


To accept configuration parameters changes, click in Accept button.

Setting destination folder

To change OpenKM destination folder where document will be uploaded, click top right button Change.

Okm user guide 534.png

Will be shown a tree explorer popup.

Okm user guide 533.png

Select the destination folder and finally click on Select button.

Scanner configuration

With Configuration / Scanner configuration menu option is shown the configuration Popup.

Configuration parameters available are:

  • Protocol WIA or TWAIN ( we suggest TWAIN for better scanner features support ).
  • Scanner
  • Origin
  • Color format ( Color / Grayscales / White and Black )
  • Page size
  • Image type ( PNG, BMP, JPEG, TIFF, GIF )


Okm user guide 519.png


To accept configuration parameters changes, click in Accept button.

Scan

  • Click toolbar button Scan.png. Depeding if you've selected WIA or TWAIN the next screen will be quite different.

Okm user guide 520.png

Follow the screen instructions.

Okm user guide 521.png

Will be created a folder based on date (year-month-day) into your server at My images/OKMScan/Images

Okm user guide 522.png

Okm user guide 523.png

Convert to pdf

Select one or more image files from tree.

Okm user guide 524.png

Click toolbar button Convert pdf.png to convert all selected images to pdf. When conversion will be finished will appear a message indicating it.

Okm user guide 525.png

The pdf file will be created into a folder based on date (year-month-day) into your server at My images/OKMScan/Pdfs

Okm user guide 526.png

Okm user guide 527.png

Uploading

Select one or more files ( images or pdf ) and click button Server upload.png to upload document.

Okm user guide 528.png

If application detects file already exist into OpenKM repository will require you validate update version or rename.

Okm user guide 529.png

Aplication will require you optionally set property groups (metadata) to documents.

Okm user guide 530.png

If you want to set property groups (metadata) click on Add button. And follow the wizard.

Okm user guide 531.png

At ends of process is shown a popup indicating the documents has successfuly uploaded.

Okm user guide 532.png

Add images into existing pdf

Can be added images on existing pdf files. For doing it click AddPage.jpg Add page to pdf toolbar icon. Will be shown extra icons what will help on this action.

Okm user guide 535.png

Action has tree steps, first is select a pdf file and then click the icon Step1.png to confirm pdf selection.

Okm user guide 536.png

The second step is select one or more images and click the icon Step2.png to confirm images selection

Okm user guide 537.png

A finally clicke the icon Step3.png to add images. Will be shown a popup to confirm the action.

Okm user guide 538.png

And a popup to confirm that operation has been done.

Okm user guide 539.png

Remove pages from existing pdf

Can be removed pages from existing pdf. For doing it click the toolbar option Page delete scanner icon.png delete page from pdf. Will be shown a popup indicating what page or range of pages want to delete.

Okm user guide 540.png

Click Accept button and the pages will be removed from pdf.

Compression CCITT Group4

To enable compression Configuration / Compression group4 menu option is shown the configuration Popup.

Configuration parameters available are:

  • Enable black and white CCITT Group4 compression
  • Percentage (Thereshold)

Okm user guide 541.png


To accept configuration parameters changes, click in Accept button.