User guide v1.x

 Scanner Client allows capturing images from scanners, optionally converting to PDF, uploading to OpenKM, and setting metadata values.

Toolbar buttons

ButtonAction

Scan.

Convert to PDF.

Refresh the tree.

Upload document.

Delete a page from PDF.

Add the page to PDF.

OpenKM Server Configuration

The Configuration / Server configuration menu option shows the configuration popup.

The following configuration parameters are available:

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

Choose the correct version:

VersionTypeDescriptionStatus

6.3.x

Community

Web services 1.0+

Active

6.2.x

Community

Web services 1.0+

Deprecated

6.0.x

Community

Com 6.0+

Deprecated

6.4.10

Professional

Web services 2.0

Deprecated

6.4.9

Professional

Pro 6.4.9+

Deprecated

6.4.6

Professional

Pro 6.4.6+

Deprecated

6.4.1

Professional

Pro 6.4+

Deprecated

Users of OpenKM Professional should use the OpenKM Scanner Professional version.

To accept configuration parameter changes, click the Accept button.

Setting destination folder

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

 A tree explorer popup will be shown.

Select the destination folder and finally click the Select button.

Scanner configuration

The Configuration / Scanner configuration menu option shows the scanner configuration popup.

The following configuration parameters are available:

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

To accept configuration parameter changes, click the Accept button.

Scan

Click toolbar button  . Depending on whether you've selected WIA or TWAIN, the next screen will be quite different.

Follow the on-screen instructions.

 

The images will be saved in a folder based on the date (year-month-day) on your server at My images/OKMScan/Images

 

Convert to PDF

Select one or more image files from the tree.

 

Click the toolbar button  to convert all selected images to PDF. When the conversion is finished, a message will appear indicating this.

The PDF file will be created in a folder based on the date (year-month-day) on your server at My images/OKMScan/PDFs

Uploading

Select one or more files (images or PDFs) and click the button  to upload the document.

If the application detects that a file already exists in the OpenKM repository, it will require you to accept an updated version or rename it.

The application will require you to optionally set metadata groups for documents.

If you want to set a metadata group, click the Add button and follow the wizard.

At the end of the process, a popup is shown indicating the documents have been successfully uploaded.

Add images into existing PDF files

You can add images to existing PDF files. To do this, click the  Add page to PDF toolbar icon.

The following extra icons will be shown to help with this action:

Adding images to a PDF file has three steps:

  • First, select a PDF file and then click the icon  to confirm the PDF selection.

 

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

  • Finally, click the icon  to add images. A popup will be shown to confirm the action.

A popup confirming that the operation has been completed will be shown.

Remove pages from existing PDF files

You can remove pages from existing PDF files. To do this, click the toolbar option  Delete page from PDF. A popup will be shown indicating which page or range of pages you want to delete.

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

Compression CCITT Group4

The Configuration / Compression group4 menu option shows the configuration popup.

The following configuration parameters are available:

  • Enable black-and-white CCITT Group 4 compression
  • Percentage (Threshold)
  • Convert directly to PDF

To accept configuration parameter changes, click the Accept button.