User guide v4.x

Scan Station Tool is an assistant for mass scanning of documents. It also allows conversion to PDF, uploading to the OpenKM repository, and adding metadata.

OpenKM Server Configuration

The Configuration / Server configuration menu option is used to display the configuration popup.

The available configuration parameters are:

Property	Type	Description
Language	Select	User interface language.
User	String	User ID for accessing OpenKM. user1
Password	String	The user's password. pass1
Host	String	OpenKM URL. http://localhost:8080/openkm/
Use personal token	Bool	Authentication will be performed using the access token.
Personal token	String	The personal access token. okmpat-Ky1t16O2Rwx4ttPmOK0R

Scan tab

Property	Type	Description
Driver	Bool	Set the driver (WIA / TWAIN) used with the scanner.
Scanner	Select	Select the scanner. When the scanner is not detected, change the driver (WIA/TWAIN).
Use predefined settings	Bool	When enabled, the scanning process will take into account the parameters specified below.
Use native UI	Bool	When enabled, the scanning process will ignore the parameters specified below and use the native UI of the scanner driver.
Paper source	Select	Set the paper input source. Options: Glass Feeder Duplex
Color format	Select	Set the color format. Options: Color Grayscale Black & White
Resolution	Select	Set the resolution in DPI.
Page size	Select	Set the size of the page.
Type	Select	Set the image format.
Scale	Select	Set a scale.
Horizontal align	Select	Set the horizontal alignment.
Brightness	int	Set the brightness.
Contrast	int	Set the contrast.

Convert to PDF tab

Property	Type	Description
Request through a popup	Bool	When enabled, the wizard will request the following parameters during the process through a pop-up.
File options	Select	Option 1 - Create one file for all pages Option 2 - Create a file every N pages. Option 3 - Create a file according to the page range. Option 4 - Split pages using a barcode separator. An example range: 1,2-7,8-11,12
Black and white with CCITT G4 compression	Bool	When enabled, the image is compressed using the Group4 method of CCITT.
Percentage	Select	Set the compression percentage.
Force fit to A4 format	Bool	Force the image to fit an A4 size.
Barcode engine path	String	Path to the Zbarimg barcode tool. C:\Program Files (x86)\ZBar\bin\zbarimg.exe
Barcode text	String	Barcode text separator. For example: OPENKM
Remove barcode page	Bool	When enabled, barcode pages are not included in the generated PDF.

Upload tab

Property	Type	Description
Request through a popup	Bool	When enabled, the wizard will request the following parameters during the process through a pop-up.
Path to upload	String	It allows you to select a path within OpenKM to which the documents will be uploaded.

Metadata groups tab

Set the metadata groups that will be used by the assistant.

Encrypt tab

Property	Type	Description
Request through a popup	Bool	When enabled, the wizard will request the following parameters during the process through a pop-up.
Password	String	Define the password used to encrypt the document.

Import / Export profile settings

In the upper-right corner of the profile configuration window, there are the "Import" and "Export" buttons. These allow you to import or export profiles.

When you choose the import action, all current profiles will be deleted and replaced by newer ones.

The exported and imported file is in JSON format.

Use

Once the OpenKM server is configured and a profile has been created, the "Profiles" button is enabled.

You can select a profile. According to the selected profile and the steps defined, several buttons will be shown. These buttons indicate the sequence followed by the assistant until the end.

When starting a new process, the wizard will create a folder based on the current date and time (year-month-day-hour_minute_second). Within this folder, the scanned images will be saved in the "Images" folder and the generated PDF documents will be saved in the "Pdfs" folder.

For example:

C:\Users\...\Pictures\OKMScanStation\2019-11-01-112637\Images
C:\Users\...\Pictures\OKMScanStation\2019-11-01-112637\Pdfs

Main form

Toolbar buttons

The buttons on the main toolbar will be displayed according to the stages enabled in the selected profile.

Button	Name	Action
	Profiles.	Select a profile.
	Scan.	Proceed to scan. The images will be saved into a folder structure based on the current date (year-month-day-hour-minute-seconds) on your PC at "C:\Users\...\Pictures\OKMScanStation\yyyy-mm-dd-hhmmss\Images".
	Convert to PDF.	Convert scanned images to PDF format. When the "Request through a popup" option is enabled in the profile, a pop-up will be displayed requesting the parameters for the conversion. The PDF files will be saved into a folder structure based on the current date (year-month-day-hour-minute-seconds) on your PC at "C:\Users\...\Pictures\OKMScanStation\yyyy-mm-dd-hhmmss\Images".
	Reset	Go back to the scan step and delete all the PDF files that have been created up to this point.
	Change the document name.	Shows a form through which you can browse and rename each of the generated files.
	Upload.	Upload images or PDF files to the OpenKM repositories. When the "Request through a popup" option is enabled in the profile, a pop-up window will be shown asking you to select an OpenKM destination path.
	Add metadata groups.	Shows the metadata forms set in the profile.
	Encrypt	Encrypt documents.
	Finalize.	End of the process.