Introduction
tia Scan is a high-performance scan x32/x64-bit application bound to the Microsoft® Windows™-platform which can be directly controlled from the SAP GUI.
tia Scan supports all SAP storage scenarios (e.g.: "late archiving", "early archiving", etc.) and requires just a minimal customizing effort.
tia Scan also supports centralized profile and license management in case tia Scan is being connected to the tia Scan Server.
KGS Scan client also seamlessly integrates with KGS ZADOC.
Supported Barcodes, File Formats and Communication Interfaces / Protocols
tia Scan supports the following Barcode-types: Linear 1D-Barcodes BCD Matrix Codabar Code 39 Code 93 Code 128 Datalogic 2 of 5 EAN 8 EAN 13 Iata 2 of 5 Industrial 2 of 5 Interleaved 2 of 5 Matrix 2 of 5 2D-Barcodes Aztec 2D Data Matrix 2D PDF 417 QR Code 2D UPCA UPCA Extended UPCE QR Code 2D Micro QR Code 2D The following file formats are being supported by tia Scan: Supported file formats TIF TIFF PDF/A1 - A3 PDF/X 1-5 The following communication interfaces and protocols are being supported by tia Scan: Supported communication interfaces and protocols SAP OLE Object Linking and Embedding HTTP Hypertext Transfer Protocol HTTPS Hypertext Transfer Protocol Secure TWAIN Transmit Windows Advanced Interface
System Requirements
For the system requirements please see: Prerequisites for tia® and kgs Software Components
Licensing
After successfully installing the tia Scan you may immediately launch and use the application. Thirteen days after the initial installation, you’ll be required to add a valid license key in order to continue to use the tia Scan application. In case no valid license key is being obtained after that thirteen days period the functionality of the tia Scan will be restricted (in particular: TWAIN connectivity, image processing (e.g.: barcode recognition), etc.). You may request a permanent license key via our official License Request Form. Please don’t forget to add your site code to the request form. You may find the site code within the tia Scan application by opening the “About …“-window. Highlighted “About …”-menu within KGS Scan application Within that window, you’ll find information like the installed version, the expiration date as well as the site code and a button to enter a new license key you received from KGS. Highlighted site code in sample “About KGS Scan”-window In case you’re operating a tia Scan Server with active license management you won’t have to change/enter the license key locally. It will be retrieved from the tia Scan Server.
Installation
After downloading the KGS Scan from our download page ( https://download.kgs-software.com/ ) you’ll have to unzip the archive and start the installation procedure by using the setup.exe-file.
You may freely choose the installation directory to your liking. The default directory for the application will be located under C:\Program Files (x86)\Kgs\KGS Scan.
Besides installing the client application, the setup will also install the KGS Transfer service which handles the communication between KGS Scan and any partner program existing in the system environment (e.g.: communication with KGS ScanServer).
If KGS Scan is being used by multiple users on the same workstation, you’ll have to ensure that each user has assigned read and write access to the chosen installation path as well as to the directory “%AppData%\KGS Scan”.
SAP-Configuration
In order to configure communication between SAP and tia Scan please make sure to configure tia Scan within SAP as described here. Open your SAP GUI and switch to the ArchiveLink: Application Maintenance (Transaction: OAA4). SAP GUI with opened “ArchiveLink: Application Maintenance” / OAA4-Transaction and highlighted New-Button Please define within this transaction a new Application named KGS_SCAN by pressing the New-button and filling out the opened form. Filled form with Application “KGS_SCAN” Confirm the entry to close the dialog. Open the Windows SAPGUI: OLE automation-dialogue by double-clicking the new line. Within this dialogue please open the function Archive from Fronted by double-clicking on it. “Windows SAPGUI: OLE automation” with highlighted “Archive from Frontend”-dialogue By double-clicking on the Archive from Frontend-function, you’ll be presented with a dialog, which allows you to define the command and its parameters. Please make sure that the content of the Application-field is KGSOLEBRIDGE.SAPSCAN. You may enter the parameters as described here: M S G Command X ScanDocument @URL,@DTI,@AID X @EID=ScanDocumentRC After entering the necessary parameters you may close the modal by pressing the Back-button and after that store the changes by clicking the Floppy-Disk-symbol. “Archive from Frontend”-modal In case you wish to connect your KGS Scan client to a repository, please use the transaction OAC0 and double-click the desired repository. OAC0-Screenshot of repository MH with highlighted “Protocol KGS_SCAN” This screenshot shows the details of a content repository (in this example: MH). The active protocol is KGS_SCAN. Please open the “ArchiveLink: Communications Interface Administration“ by entering the transaction OAA3 and double-click the selected protocol (in this example: KGS_SCAN). Overview of the “ArchiveLink: Communications Interface Administration“ with highlighted protocol “KGS_SCAN” Double-click the protocol in order to open the overview for the protocol dialogue “ArchiveLink Protocols: Overview of Protocol”. Open within the protocol overview the frontend dialog by double-clicking the “Archive from frontend“-function. “ArchiveLink Protocols: Overview of Protocol“-dialogue Please double-click the document class you wish to connect (typically classes are TIF or PDF) and link it to the “KGS_SCAN“-application. “Archive from frontend“-dialogue with chosen TIF-document class. Dialogue to link a document class to an application Please open now the transaction OAC2 in order to create the document type, to which the scanned documents will be allocated to. Please note: It’s important to add a description, which will be shown in the selection window of SAP archive dialogs because no selection will be displayed unless a description has been defined. After that go to the transaction OAC3 in order to link the previously defined document type to the desired SAP business object type as well as a content repository. After performing these steps tia Scan is prepared for operation with the chosen content repository. Hint: In order to utilize this scenario first open KGS Scan, select a corresponding profile and execute the OAWD-SAP-transaction.
Settings and Profile settings in KGS Scan Client
General settings
Within the General-subsection you may provide a description for the scanning profile as well as choose from the Scanner:-list all TWAIN scanners that had been detected by KGS Scan when the application was started. Please note: In case your scanner isn’t listed please make sure, that you’ve installed the latest TWAIN drivers on the workstation. In case you do not have any scanners connected to the workstation or in case your workflow requires the scan of files you may choose the scanner File Importer (System)-scanner provided by KGS. This scanner allows you to scan and process existing files. Opened “General”-subsection within “Options”-menu with filled description and TWAIN scanner After entering a description and choosing the scanner, please save your changes by pressing the Save-button.
Scanning Options
By clicking within the Options-menu on the subsection Scanning you may define the parameters for the scanner like the scan-mode, whether a document should be scanned in B/W, grayscale or color and many things more. Please note: Whether an option is available to you depends on the scanner you’re using as well as the capabilities supported by the TWAIN-driver. In case you’re using a hardware scanner the options you may choose from might look similar to the ones within the screenshot. Scanning options provided by a hardware scanner Depending on the hardware scanner you’re using, you may choose and set the following options: Option name Type Description Possible values Scan-Mode List Defines whether documents are being scanned in simplex or duplex mode. Simplex: Front side is being scanned Duplex: Both sides of the documents are being scanned Simplex Duplex Color Mode List Defines whether documents are being scanned in B/W, Grayscale or Color. Black & White Grayscale Color (RGB) Resolution List Defines the pixel density in DPI of the scanned documents. Depends on your scanner Orientation List Defines the orientation of the scanned documents. Portrait Landscape Brightness Slider May be used in order to increase or reduce the brightness factor of the scan result. Please note: Depending on the hardware and the driver used, you may have access to the Auto-checkbox on the right-hand side. Default: 0 All integer values between: -100 → 100 Contrast Slider May be used in order to increase or reduce the contrast factor of the scan result. Please note: Depending on the hardware and the driver used, you may have access to the Auto-checkbox on the right-hand side. Default: 0 All integer values between: -100 → 100 Format List You may choose from the available formats which suits best your needs. Please note: Depending on the hardware and the driver used, you may have access to the Auto-checkbox on the right-hand side. You may also have the Detect Border-checkbox, in case your scanner / TWAIN driver supports that feature. Depends on your scanner Feeder List May be used in order to specify the feeder. Please note: Depending on the scanner you’re using, the TWAIN driver and the feeder you might have additional feeder-specific options in the list below the feeder to configure the feeder to your requirements even more. Depends on your scanner Scanner Options Barcodes Checkbox In case your scanner/driver supports hardware barcode detection you may tick this box. If ticked the scanner will communicate detected barcodes to KGS Scan. Ticked / Unticked Auto Deskew Checkbox When your scanner/driver is capable to detect whether scanned documents are skewed you may tick this box in order to rectify the scanned pages. Ticked / Unticked Auto Blank Page Removal Checkbox If your scanned documents contain blank pages and your scanner/driver is capable to detect those, you may tick this box in order to remove blank pages altogether. Ticked / Unticked Auto Rotation Checkbox In case you’re scanning pages and want to make sure, that none are sideways or upside down, you may tick this box in order to activate the auto rotation capabilities of your scanner (if those are existing and the driver is capable to do that). Ticked / Unticked use TwainUI Checkbox When being enabled this will launch the TwainUI-dialogue for each scan process. KGS Scan will apply the results of this user interaction accordingly. This gives you the option to modify local scanner parameters each time before scanning starts. Please note: KGS recommends to disable this option, as it will allow users to bypass many profile settings and change parameters manually. Ticked / Unticked Auto Color Checkbox If your driver/scanner is capable to automatically detect whether a document needs to be scanned in color mode, grayscale or B/W you may tick this box, if it’s being provided by your scanner. Ticked / Unticked
Loading Local Documents
In case you do not have any hardware scanner or in case your scenario requires to process documents already existing you may select the FileImporter (System) scanner within the General-tab. This software scanner is being shipped with KGS Scan and allows you to process files already existing in a directory. In this scenario, you may load files (TIFF, TIF, PDF, or DOCX) directly from disk. Opened “Scanning”-tab when “FileImporter (System)” is being selected. This software scanner is being shipped with the following capabilities: Option name Type Description Possible Values Import Path Text Defines the root directory from which KGS Scan tries to acquire files. Every path accessible from your workstation import recursively Checkbox When being checked every subfolder is being searched recursively for corresponding files. Ticked / Unticked delete file after import Checkbox Enabling this option will lead to the deletion of the documents that have been imported successfully. Please note: The source documents will be deleted fully and irrevocably, even if no export has taken place! Ticked / Unticked specify folder while scan Checkbox If you enable this option, a dialog listing all subfolders contained within the root directory will be shown right before the scanning process. This allows you to manually select specific subfolders. Please note: The checkmark at Import recursively still applies. Ticked / Unticked import complete files Checkbox Only complete files will be imported if you enabled this option. The scan buttons in the main view will change and the rescan-button will be hidden. This scenario addresses profiles for importing documents entirely instead of individual pages. Ticked / Unticked specify file while scan Checkbox A file selection dialog will be shown for each scanning process if this checkbox is being enabled. When defined, the import directory will be used as the root directory. You may select multiple files. This option, too, is being used to import complete files. Ticked / Unticked Render Form Fields Checkbox If you’re scanning PDF documents that contain form fields, you may tick this option in order to display the content saved within those fields. Ticked / Unticked DPI List The resolution of the import may be defined by setting the dots per inch from the list provided. 600 Datatypes Checkbox By ticking the related datatype you may define which types of data may be imported. The following datatypes are possible: Pdf Tif Tiff DocX Png Jpg Jpeg Pdf Tif Tiff
Document separation options
Within the third tab, you’ll find options allowing you to define how documents shall be separated during the scanning process. First, you’ll have to choose from the following separation options provided by KGS Scan. Separation Option Description None No separation is performed. Each page will be attached to the first (and only) document. File This separation option maps the imported files using the exact same folder structure as is being used on the disk. Please note: This option only makes sense in combination with the FileImporter (System) Folder This option performs separation based on the directories. This means that all pages originating from the same directory are being combined into a single document regardless of the documents the pages came from. A new document will be created only when the directory is being changed recursively. Please note: This option only makes sense in combination with the FileImporter (System) Page Count After a predetermined number of pages, KGS Scan will continuously generate a new document. Empty Feeder KGS Scan will automatically perform a separation when the feeder is empty. This applies to scenarios where scanning is performed continuously and the scanner recognizes an empty feeder, in this case, KGS Scan will perform separation and wait for the scanner to start scanning again. Barcode When barcodes are being detected on a scanned pages these can be used as barcode separators. You’ll need to specify which types of barcodes should act as separators. It’s possible to mark multiple barcode types, which makes sense if the scanned documents contain a broad range of barcodes. Blank Page This separation option performs a separation whenever an empty page is identified. Please note: Make sure, that on the Image Processing-tab Blank Page Detection is enabled. Patch Code KGS Scan will perform separation based on detected patch code sheets, if you select this separation option. The patch sheets being used have to comply with general standards. In addition to these separators you may also get additional options depending on the separator you chose. Option name Type Description Possible values Page Count number Integer Defines the number of pages after which KGS Scan will generate a new document. You may either enter the number of pages or increase or decrease the number by using the up- and down-buttons on the right-hand side. All integer values (greater than 0) Option name Type Description Possible values Separate on empty Barcodes Checkbox This separation option will cause a separation when no barcode is detected on a page. Ticked / Unticked Remove Separation Sheet Checkbox If ticked this option will remove the detected separator sheet. Please note: When combined with Separate on empty Barcodes this will lead to the behavior, that for each page that doesn’t contain a barcode a separation will be performed in addition to removing the page. Ticked / Unticked Group identical subsequent Barcodes Checkbox In some scanning scenarios multiple identical barcodes may occur consecutively (associated batches). When enabled, non-identical barcodes will be interpreted as a document separator. Ticked / Unticked Industrial 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Industrial 2 of 5-standard. Ticked / Unticked Matrix 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Matrix 2 of 5-standard. Ticked / Unticked Interleaved 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Interleaved 2 of 5-standard. Ticked / Unticked Iata 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Iata 2 of 5-standard. Ticked / Unticked Datalogic 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Datalogic 2 of 5-standard. Ticked / Unticked Codabar Checkbox When ticked, KGS Scan will look for barcodes following the Codabar-standard. Ticked / Unticked BCD Matrix Checkbox When ticked, KGS Scan will look for barcodes following the BCD Matrix-standard. Ticked / Unticked Inverted 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Inverted 2 of 5-standard. Ticked / Unticked Code 39 Checkbox When ticked, KGS Scan will look for barcodes following the Code 39-standard. Ticked / Unticked Code 128 Checkbox When ticked, KGS Scan will look for barcodes following the Code 128-standard. Ticked / Unticked Code 93 Checkbox When ticked, KGS Scan will look for barcodes following the Code 93-standard. Ticked / Unticked EAN 8 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 8-standard. Ticked / Unticked EAN 13 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 13-standard. Ticked / Unticked UPCE Checkbox When ticked, KGS Scan will look for barcodes following the UPCE-standard. Ticked / Unticked UPCA Checkbox When ticked, KGS Scan will look for barcodes following the UPCA-standard. Ticked / Unticked UPCA Extended Checkbox When ticked, KGS Scan will look for barcodes following the UPCA Extended-standard. Ticked / Unticked PDF 417 Checkbox When ticked, KGS Scan will look for barcodes following the PDF 417-standard. Ticked / Unticked Data Matrix 2D Checkbox When ticked, KGS Scan will look for barcodes following the Data Matrix 2d-standard. Ticked / Unticked QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the QR Code 2D-standard. Ticked / Unticked Micro QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the Micro QR Code 2D-standard. Ticked / Unticked Aztec 2D Checkbox When ticked, KGS Scan will look for barcodes following the Aztec 2D-standard. Ticked / Unticked best Speed Checkbox When ticked, KGS Scan will look for barcodes at higher speed resulting in a shorter processing time. Ticked / Unticked best Quality Checkbox When ticked, KGS Scan will look for barcodes at lower speed but with higher precision. Ticked / Unticked Warn on Duplicates Checkbox When ticked, warns if the scanned document contains the same barcode on at least two different pages Ticked / Unticked Warn on different Barcodes Checkbox When ticked, warns if the scanned document contains at least two different barcodes on the same page Ticked / Unticked Please note: In case your scanning scenario requires the identification of multiple barcodes you may enable multiple barcodes by ticking the box next to the name. In addition to identification of barcodes KGS Scan supports the definition of regular expression-based filters. With this you are able to check and filter for certain barcode values. This provides a fine-tuning of the processing behavior. Option name Type Description Regular Expression - Filter Textbox Within this textbox you may define the regex-pattern, which will be matched against the found barcode/-s. Regular Expression - Test Textbox You may enter strings in order to check the given regular expression against an actual sample. A green background color means, that the given sample matches with the given regular expression. An orange background color means, that the given sample didn’t match with the given regular expression. Sample regular expression matching against any give ten digits long number with valid match Sample regular expression matching against any word/character which consists between one and fifteen characters and only containing letters. (Doesn’t match in the sample due to the two numbers “2” and “5”). You may further define a rectangle of interest-area for the barcode recognition. This option is avaible to you after pressing the Extended Barcode Configuration …-button. Opened “Extended Barcode Configuration …”-menu with selected barcode-recognition-area in the top right border. Within this menu, you may draw a colored frame with your mouse, which defines the area where KGS Scan will attempt to find barcodes. After marking an area please press the Accept!-button to confirm your selection. In case you’re ticking the Show Area Live-box, the selected area will be shown on each scanned page. This option mainly serves testing purposes. Please note: KGS Scan calculates the selected area as a percentage of the page. This method ensures that the selected rectangle is placed at the correct possition - regardles of the resolution or paper size (aspect ratio is maintained). This option is available for both - separator barcodes as well as image processing. Option name Type Description Possible values Remove Separation Sheet Checkbox Enabling this option will cause each empty page to be removed. Ticked / Unticked Patch codes were initially introduced by Kodak for the purpose of separating documents based on fixed barcodes (barcodes with a fixed position on the page). Later the purpose of these sheets was extended to be used in order to trigger events. Patch codes should be positioned as follows: Parallel to the lead edge of the document. At least 0.20 inches (5.08 mm) away from the lead edge of the document. At most 3.75 inches (95,25 mm) away from thee lead edge document. Option name Type Description Possible values Remove Separation Sheet Checkbox Enabling this option will cause each separation page to be removed. Ticked / Unticked Patch Code 1 Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 1-codes. Ticked / Unticked Patch Code 2 Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 2-codes. Ticked / Unticked Patch Code 3 / Transfer Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 3-codes. Ticked / Unticked Patch Code 4 / Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 4-codes. Ticked / Unticked Patch Code 5 / Patch T / TransferPatch / T-Code Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 5-codes. Ticked / Unticked Patch Code 6 Checkbox Enabling this option will allow KGS Scan to detect and separate on Patch Code 6-codes. Ticked / Unticked Patch Unknown Checkbox Enabling this option will allow KGS Scan to detect and separate on Unknown patch-codes. Ticked / Unticked Reduce result to one Checkbox In case several Patch Codes are detected on a page KGS Scan will reduce the detected Patch codes to the most likely / occurring one. Ticked / UntickedAdditional options of Page Count-separator
Additional options of Barcode-separator
Additional options of Blank Page-separator
Additional options of Patch Code-separator
Toggle Patch
(Inverted Code 3)
Document Naming
Image Processing
The Image Processing-tab provides you with various options for software-based image processing. On the left-hand side, you’ll find the list of available options. On the right-hand side, you’ll find the options that you selected. Option name Description Barcode Detection When selecting the Barcode Detection-option KGS Scan will do a software-based barcode detection. Please note: It’s recommended to only enable barcodes that are being used in your scenarios. The number of enabled barcodes for detection might decrease the overall performance of KGS Scan. Black Border Removal When selecting the Black Border Removal-option KGS Scan will look for black borders on the edges of the scanned documents and remove those. Blank Page Removal When the option Blank Page Removal has been selected KGS Scan will look for blank pages during the scanning process and remove these. Color Detection The Color Detection-option allows KGS Scan to define whether a document should be saved in color mode or as a black and white page. Enabling this option might help you to reduce the size of the actually saved document. Deskew KGS Scan will straighten out images which, for example, were not properly aligned during the feeding/scanning process, when Deskew-option is selected. Fixed Rotation You may use this processing option to rotate the image after the scanning process. Noise Removal In case you selected the Noise Removal-option KGS Scan will attempt to reduce the optical noise by using software algorithms. This process mainly focuses on removing single unwanted black pixels from the document. Page Removal The Page Removal-option allows you to define regular expressions that identity pages with specific barcodes that should be removed during the scanning process. Please note: This option requires the identification of barcodes on a scanned page. Remove Punch Holes When enabling the Remove Punch Holes-option, KGS Scan will try to identify punch holes on scanned documents by using some software algorithms and remove those from the scanned documents. In addition to the image processing options, you may also be able to open an additional dialogue that allows you to set additional parameters of the selected option in the Selected-list. You may open the additional option dialogue by clicking on the Configure …-button below the Available-list. Option name Type Description Possible values Industrial 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Industrial 2 of 5-standard. Ticked / Unticked Matrix 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following Matrix 2 of 5-standard. Ticked / Unticked Interleaved 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Interleaved 2 of 5-standard. Ticked / Unticked Iata 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Iata 2 of 5-standard. Ticked / Unticked Datalogic 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Datalogic 2 of 5-standard. Ticked / Unticked Codabar Checkbox When ticked, KGS Scan will look for barcodes following the Codabar-standard. Ticked / Unticked BCD Matrix Checkbox When ticked, KGS Scan will look for barcodes following the BCD Matrix-standard. Ticked / Unticked Inverted 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Inverted 2 of 5-standard. Ticked / Unticked Code 39 Checkbox When ticked, KGS Scan will look for barcodes following the Code 39-standard. Ticked / Unticked Code 128 Checkbox When ticked, KGS Scan will look for barcodes following the Code 128-standard. Ticked / Unticked Code 93 Checkbox When ticked, KGS Scan will look for barcodes following the Code 93-standard. Ticked / Unticked EAN 8 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 8-standard. Ticked / Unticked EAN 13 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 13-standard. Ticked / Unticked UPCE Checkbox When ticked, KGS Scan will look for barcodes following the UPCE-standard. Ticked / Unticked UPCA Checkbox When ticked, KGS Scan will look for barcodes following the UPCA-standard. Ticked / Unticked UPCA Extended Checkbox When ticked, KGS Scan will look for barcodes following the UPCA Extended-standard. Ticked / Unticked PDF 417 Checkbox When ticked, KGS Scan will look for barcodes following the PDF 417-standard. Ticked / Unticked Data Matrix 2D Checkbox When ticked, KGS Scan will look for barcodes following the Data Matrix 2d-standard. Ticked / Unticked QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the QR Code 2D-standard. Ticked / Unticked Micro QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the Micro QR Code 2D-standard. Ticked / Unticked Aztec 2D Checkbox When ticked, KGS Scan will look for barcodes following the Aztec 2D-standard. Ticked / Unticked best Speed Checkbox When ticked, KGS Scan will look for barcodes at a higher speed resulting in shorter processing time. Ticked / Unticked best Quality Checkbox When ticked, KGS Scan will look for barcodes at a lower speed but with higher precision. Ticked / Unticked Allow Duplicates Checkbox If a page contains multiple identical barcodes, all of them will be recognized. This option is mainly used in combination with the Barcode Table-index field. Ticked / Unticked Regular Expression - Filter Textbox Within this textbox, you may define the regex-pattern, which will be matched against the found barcode/-s. Regular Expressions Regular Expression - Test Textbox You may enter strings in order to check the given regular expression against an actual sample. A green background color means, that the given sample matches the given regular expression. An orange background color means, that the given sample didn’t match with the given regular expression. Regular Expressions Delete unmatched Checkbox If the software detects invalid barcodes (declared as invalid by providing a regular expression), they’ll be deleted. Ticked / Unticked Warn on Duplicates Checkbox Using this option will mark any duplicates that appeared on an overview page after each scan and recognition of barcodes on the documents. This option applies to the entire batch, e.g. to all scanned pages. Please note: As each new barcode has to be compared to every previously scanned barcode the processing load grows exponentially with the number of barcodes detected. This might slow down the scanning process. Ticked / Unticked Option name Type Description Possible values Threshold (%) Floating Point Number Here you may define a threshold in percent. All between 0.0 and 100.0 Option name Type Description Possible values Threshold (%) Floating Point Number Here you may define a threshold in percent. Please note: In most cases, the value should be between 99.5 % and 99.8 % All between 0.0 and 100.0 Option name Type Description Possible values 90 ° CW Radio button When setting the rotation parameter to this option, every scanned page will be rotated by 90 degrees clockwise. Checked / Unchecked 180 ° Radio button When setting the rotation parameter to this option, every scanned page will be rotated by 180 degrees clockwise. Checked / Unchecked 90 ° CCW Radio button When setting the rotation parameter to this option, every scanned page will be rotated by 90 degrees counter-clockwise. Checked / Unchecked Option name Type Description Possible values Trigger Combobox With this Combobox, you may define a trigger which will lead to a check and a page removal in case of a matching condition Barcode Regular Expression - Filter Textbox Within this textbox, you may define the regex-pattern, which will be matched against the found barcode/-s. Regular Expressions Regular Expression - Test Textbox You may enter strings in order to check the given regular expression against an actual sample. A green background color means, that the given sample matches the given regular expression. An orange background color means, that the given sample didn’t match with the given regular expression. Regular ExpressionsAdditional configuration options for Barcode Detection
Additional configuration options for Black Border Removal
Additional configuration options for Blank Page Removal
Additional configuration options for Fixed Rotation
Additional configuration options for Page Removal
Attachments
Within the Attachments-tab you may define separate attachments via a barcode. When exporting, an Attachments-folder will be created, which holds all pages for which at least one (attachment) barcode was detected. These pages will still be shown within the overview. To enable this type of separation, you’ll have to specify the desired barcode and check the Enable Separation-checkbox. The following options are provided within the Attachments-tab. Option name Type Description Possible Values Enable Separation Checkbox When ticked, the separation of barcodes as attachments will be enabled. Ticked / Unticked Industrial 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Industrial 2 of 5-standard. Ticked / Unticked Matrix 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following Matrix 2 of 5-standard. Ticked / Unticked Interleaved 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Interleaved 2 of 5-standard. Ticked / Unticked Iata 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Iata 2 of 5-standard. Ticked / Unticked Datalogic 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Datalogic 2 of 5-standard. Ticked / Unticked Codabar Checkbox When ticked, KGS Scan will look for barcodes following the Codabar-standard. Ticked / Unticked BCD Matrix Checkbox When ticked, KGS Scan will look for barcodes following the BCD Matrix-standard. Ticked / Unticked Inverted 2 of 5 Checkbox When ticked, KGS Scan will look for barcodes following the Inverted 2 of 5-standard. Ticked / Unticked Code 39 Checkbox When ticked, KGS Scan will look for barcodes following the Code 39-standard. Ticked / Unticked Code 128 Checkbox When ticked, KGS Scan will look for barcodes following the Code 128-standard. Ticked / Unticked Code 93 Checkbox When ticked, KGS Scan will look for barcodes following the Code 93-standard. Ticked / Unticked EAN 8 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 8-standard. Ticked / Unticked EAN 13 Checkbox When ticked, KGS Scan will look for barcodes following the EAN 13-standard. Ticked / Unticked UPCE Checkbox When ticked, KGS Scan will look for barcodes following the UPCE-standard. Ticked / Unticked UPCA Checkbox When ticked, KGS Scan will look for barcodes following the UPCA-standard. Ticked / Unticked UPCA Extended Checkbox When ticked, KGS Scan will look for barcodes following the UPCA Extended-standard. Ticked / Unticked PDF 417 Checkbox When ticked, KGS Scan will look for barcodes following the PDF 417-standard. Ticked / Unticked Data Matrix 2D Checkbox When ticked, KGS Scan will look for barcodes following the Data Matrix 2d-standard. Ticked / Unticked QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the QR Code 2D-standard. Ticked / Unticked Micro QR Code 2D Checkbox When ticked, KGS Scan will look for barcodes following the Micro QR Code 2D-standard. Ticked / Unticked Aztec 2D Checkbox When ticked, KGS Scan will look for barcodes following the Aztec 2D-standard. Ticked / Unticked best Speed Checkbox When ticked, KGS Scan will look for barcodes at a higher speed resulting in shorter processing time. Ticked / Unticked best Quality Checkbox When ticked, KGS Scan will look for barcodes at a lower speed but with higher precision. Ticked / Unticked Regular Expression - Filter Textbox Within this textbox, you may define the regex-pattern, which will be matched against the found barcode/-s. Regular Expressions Regular Expression - Test Textbox You may enter strings in order to check the given regular expression against an actual sample. A green background color means, that the given sample matches the given regular expression. An orange background color means, that the given sample didn’t match with the given regular expression. Regular Expressions
Context Menus
Context Menus-tab allows you to customize the visibility of context menu-items for the scan user. The administrator allows you to enable or disable specific items per scan profile. For example, disabling the Email-feature for scan users may be necessary in case of dealing with sensitive data. The following three context menus can be modified. Thumbnail: The right-click menu per page in the thumbnail preview. Document: The right-click menu on the document separator. Preview: The right-click menu on the main window (on the scanned image). In the top left you’ll find the Context Menu Selection-combo box, which allows you to chose which context menu you wish to change for the currently chosen profile. Highlighted “Context Menu Selection”-combo box in “Context Menus”-options. Option name Description Default Add Page(s) If enabled the user of the profile is allowed to add new pages to a document. Ticked Delete Page(s) If enabled the user of the profile is allowed to delete pages from a document. Ticked Rescan Page(s) If enabled the user of the profile is allowed to rescan pages. Ticked Move Page(s) to new Document If enabled the user of the profile is allowed to move pages to a new document. Ticked Resort Page(s) If enabled the user of the profile is allowed to resort pages. Ticked Save selected Page(s) If enabled the user of the profile is allowed to save selected pages. Ticked Email If enabled the user of the profile is allowed to send pages via email. Ticked Print Page(s) If enabled the user of the profile is allowed to print pages. Ticked displayPostprocessing If enabled the user of the profile is allowed to display the post processing. Ticked View Properties If enabled the user of the profile is allowed to view the properties of pages. Ticked Option name Description Default Export If enabled the user of the profile is allowed to export a document. Ticked Remove Document Separation If enabled the user of the profile is allowed to remove the document separation. Ticked Send Document(s) via Email If enabled the user of the profile is allowed to send documents via email. Ticked Delete Blank Pages If enabled the user of the profile is allowed to use the Delete Blank Pages-context menu. Ticked Print Document(s) If enabled the user of the profile is allowed to print a document. Ticked Save Document(s) If enabled the user of the profile is allowed to save a document. Ticked Option name Description Default Rotate/Flip If enabled the user of the profile is allowed to rotate pages in the preview context menu. Ticked Scrollbars If enabled the user of the profile is allowed to use the scrollbars. Ticked Copy to Clipboard If enabled the user of the profile is allowed to copy pages to the clipboard. Ticked Copy Text to Clipboard If enabled the user of the profile is allowed to copy text to the clipboard. Ticked Zoom If enabled the user of the profile is allowed to use the zoom options. Ticked Mouse Mode If enabled the user of the profile is allowed to use the mouse mode. Ticked Viewer Quality If enabled the user of the profile is allowed to use the Viewer Quality-feature Ticked
Options of “Thumbnail“-context menu
Options of “Document“-context menu
Options of “Preview“-context menu
Indexing
The Indexing-tab allows you to export additional values and information which can be used for example in KGS DocumentRouter-scenarios. The associated information will be stored in index files (*.idx files). Opened “Indexing”-tab with two defined index fields When opening the Indexing-dialogue you’ll find the following options. Option name Type Description Export .idx Checkbox When this option is enabled KGS Scan will generate and export idx-files that contain information regarding the index fields. Export .xml Checkbox When this option is enabled KGS Scan will generate and export xml-files that contain the information regarding the index fields. SAP Config … Button When clicked KGS Scan will display the Index SAP Configuration-submenu, which is described in detail below. Edit Button When an existing index field is selected and the button is clicked KGS Scan will open the Edit Indexfield-dialogue described below. Remove Button When an existing index field is selected and the button Remove is clicked KGS Scan will remove the selected index field. Add … Button When clicked KGS Scan will open the New Indexfield-dialog, which allows you to enter a name for the index field that will be created. Please note: After creating an index field you won’t be able to change the name. Opened “New Indexfield”-dialogue After clicking the Edit-button or after creating a new index field name, the Edit Indexfield-menu will be opened which allows you to define and set the following parameters. Opened “Edit Indexfield”-menu. Option name Description Text When the type is being set to Text the index field will accept text values and use the Text-field-configuration. Export Documentname When the type is being set to Export Documentname the index field will accept export document names and use the Export Documentname-field-configuration. Separation Barcode When the type is being set to Separation Barcode the index field will accept separation barcodes and use the Separation Barcode-field-configuration. Barcode Table When the type is being set to Barcode Table the index field will accept values from the barcode table and use the Barcode Table-field-configuration. Date When the type is being set to Date the index field will accept date values and use the Date-field-configuration. Value List When the type is being set to Value List the index field will accept values from the defined value list and use the Value List-field-configuration. Email List When the type is being set to Email List the index field will accept email-addresses defined within a list and use the Email List-field-configuration. Indexstatus When the type is being set to Indexstatus the index field will accept index status information and use the Indexstatus-field-configuration. Page Count When the type is being set to Page Count the number of pages will be written to the exported index file. FImporter Foldername When the type is being set to Text the index field will accept text values and use the Text-field-configuration. SAP DocID When the type is being set to SAP DocID the index field will be filled with an SAP conform 32-digits random DocumentId and use the SAP DocID-field-configuration. Option name Description Document The defined index field exists within the scope of every single document and might differ from document to document. Batch The defined index field exists within the scope of the whole batch so it might be the same for every document but might differ from batch to batch. Option name Type Description Fieldname Textbox You’ll find the defined field name within this textbox. Please note: As stated before, it’s not possible to change a field name after it had been defined. Type Combobox You may choose from a list of different field types depending on your needs and the scenario. KGS Scan provides you with the following type options: Text Export Documentname Separation Barcode Barcode Table Date Value List Email List Indexstatus FImporter Foldername SAP DocID Scope Combobox Within this combo box you may define the scope of the index field. Currently, the following scopes are accepted: Document Batch Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read only Checkbox When this option is enabled the defined index field will be write-protected, which will allow the user of the profile to see the value within the Index screen, but they won’t be able to change it. Validate Checkbox When checked KGS Scan will enforce that each field for which this option has been enabled has to be confirmed by pressing the Enter-key during the export. The user will be informed that there are still unconfirmed values within index fields which have to be confirmed before the export can be processed. Allow Empty Values Checkbox When enabling this option, the profile user will be allowed to export the document even if the index field doesn’t has a value. Please note: Handle this option with caution since the processing instance (e.g.: KGS DocumentRouter) might not know how to handle empty index fields. Allow Value from removed Pages Checkbox When checked it allows the user to use values in the index field from pages that have been removed. (SAP) Prefill Parameter Checkbox When enabled KGS Scan will call the function module configured within the SAP configuration in order to prefill the index field. KGS Scan will use the value as a parameter when calling the SAP Function Module via RFC connection. (optional) mapped SAP Import Parameter Textbox In case the given field name differs from the parameter name within the SAP function module you’re able to rename the name which is being sent to the SAP function module by filling out this field. If it is empty, the field name will be sent to the SAP function module. (optional) mapped SAP Fieldname Textbox After calling SAP and retrieving the list you can define which value within the key-value-pair-resultset will be used, by filling out this field. Predefined Value Radiobutton In case SAP has been configured you can define the value that is being sent to the SAP function module by filling out this field. In case you’re not using SAP or do not use SAP prefilling you may define a default text by filling out this field. Scan User Radiobutton When setting the menu to this option by default the Microsoft Windows user including the domain will be used. Scan User Principal Radiobutton When setting the menu to this option by default the Microsoft Windows user including the domain will be used. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read only Checkbox When this option is being enabled the index field can’t be edited by the users. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Allow Value from removed Pages Checkbox When checked it allows the user to use values in the index field from pages that have been removed. Read only Checkbox When this option is being enabled the index field can’t be edited by the users. Validate Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. (SAP) Prefill Parameter Checkbox When enabled KGS Scan will call the function module configured within the SAP configuration in order to prefill the index field. (optional) mapped SAP Import Parameter Textbox In case the given field name differs from the parameter name within the SAP function module you’re able to rename the name which is being sent to the SAP function module by filling out this field. If it is empty, the field name will be sent to the SAP function module. Modify Barcode (regex) Combobox With this combobox you can either enable or disable the usage of the regular expression next to it, which is being used in order to modify the barcode which was used for separation. None (default): The barcode found on the scanned page will not be modified. Always: The barcode found on the scanned page will always be modified according to the regular expression definition. Modify Barcode (regex) Textbox Textbox There might be some scenarios in which you wish to modify the barcode which was being used for separation. In that case, you may provide a regular expression within this textbox, that modifies the barcode according to your needs. Please note: Due to the fact, that KGS Scan is a DotNet application, you may provide a regular expression that follows the dotnet-specification. Please note also: In order to work correctly, you’ll have to define Document Separation to use the index field type Separation Barcode. Invalid Barcodes - Regexp Textbox Within this textbox, you may provide a regular expression that invalidates a barcode that was being used for document separation. Please note: Due to the fact, that KGS Scan is a DotNet application, you may provide a regular expression that follows the dotnet-specification. Please note also: In order to work correctly, you’ll have to define Document Separation to use the index field type Separation Barcode. Option name Type Description Read Only Checkbox When this option is being enabled the index field can’t be edited by the users. Hide ‘Add Row’-Button Checkbox When this option is being checked, it will hide the Add Row-button from the users, so the users can’t add rows. Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Hide ‘Remove’-Button Checkbox When this option is being checked, it will hide the Remove-button from the users. No Duplicates Checkbox When this option is being enabled the detected barcodes will be distinct, which means there won’t be any duplicates even though there might have been the same barcode multiple times. Allow Add Entries Checkbox When this option is being enabled the users will be allowed to add entries. User Validation Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. (SAP) Prefill Parameter Checkbox When enabled KGS Scan will call the function module configured within the SAP configuration in order to prefill the index field. (optional) mapped SAP Import Parameter Textbox In case the given field name differs from the parameter name within the SAP function module you’re able to rename the name which is being sent to the SAP function module by filling out this field. If it is empty, the field name will be sent to the SAP function module. Modify Barcode (regex) - List Combobox Please note: Due to the fact, that KGS Scan is a DotNet application, you may provide a regular expression that follows the dotnet-specification. Please note also: In order to use barcodes, you’ll have to enable and configure the option Barcode Detection within the Image Processing-tab. None (default): The barcode found on the scanned page will not be modified. Always: The barcode found on the scanned page will always be modified according to the regular expression definition. Before SAP-Prefill: The barcode found on the scanned page will be modified before it is being sent to the SAP function module. After SAP-Prefill: The barcode found on the scanned page will not be modified before it is being sent to the SAP function module, but the returned barcode from the SAP function module will be modified instead. Modify Barcode (regex) - Textfield Textbox Within this textbox, you may enter a regular expression, which modifies the barcode/-s. Minimum Entries Combobox With this option, you may define the minimal number of entries within the barcode table. Maximal Entries (0 = all) Combobox With this option, you may define the maximal number of entries within the barcode table. Check only at Page N - Checkbox Checkbox When enabling this checkbox, KGS Scan will only search at page n per document for barcodes (n = number of the page to look for barcodes). In case the digit configured exceeds the page number, the minimum of index field (empty) will be created. Check only at Page N - Numeric Combobox Within this field, you may define the page on which KGS Scan is looking for barcodes if it is enabled by clicking the Check only at Page N. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read only Checkbox When this option is being enabled the index field can’t be edited by the users. Validate Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. Date Format - dd.MM.yyyy Radiobutton When this option is set, the date in the index field will follow the day.month.year-format. e.g.: 01.0.1.2020 Date Format - yyyyMMdd Radiobutton When this option is set, the date in the index field will follow the yearmonthday-format. e.g.: 20200101 Date Format - Custom Radiobutton When this option is set, you may specify a date format, which matches your requirements within the text-field right next to it. Please note: Due to the fact that KGS Scan is a DotNet application, you may only enter formats matching the DotNet-standard for time formats. e.g.: dd.MM.yy HH:mm Predefined Value - Current Date Radiobutton When this option is set, the index field will contain the current date. Option name Type Description User Confirmation Checkbox When this checkbox is being checked a user confirmation is required when exporting the documents. Allow Empty Values Checkbox When enabling this option, the profile user will be allowed to export the document even if the index field doesn’t have a value. Please note: Handle this option with caution since the processing instance (e.g.: KGS DocumentRouter) might not know how to handle empty index fields. Default Checkbox Marks one value within the value list as the default value. Value Textbox Within this textbox, you may define the value the user may set as an index field. Option name Type Description Default Checkbox Marks one value within the value list as the default value. Subject Textbox The text you’re entering will be used as the subject of the mail. Configuration Button By clicking on this button you may open the Configure email address-menu, which allows you to set the sender, recipient, and filename of an email. Subject Textblock Show you the subject of the mail. Email Sender Textbox Within this textbox, you can define the sender of the mail. Email Receiver Textbox Within this textbox, you can define the recipient/receiver of the mail. Filename Textbox Within this textbox, you can define the filename. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read-Only Checkbox When this option is being enabled the index field can’t be edited by the users. Fields were automatically filled Textbox Waiting for answer from Matthias. Fields were manually changed Textbox Waiting for answer from Matthias. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read-Only Checkbox When this option is being enabled the index field can’t be edited by the users. Validate Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read-Only Checkbox When this option is being enabled the index field can’t be edited by the users. Validate Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. Read only Checkbox When this option is being enabled the index field can’t be edited by the users. Validate Checkbox When this option is being checked, the index field for which this option has been enabled has to be confirmed by the user by pressing the Enter-key. The exporter will inform the user that there are still fields with unconfirmed values when the export takes place. Allow Empty Values Checkbox When enabling this option, the profile user will be allowed to export the document even if the index field doesn’t have a value. Please note: Handle this option with caution since the processing instance (e.g.: KGS DocumentRouter) might not know how to handle empty index fields. Option name Type Description Hidden Checkbox When this option is enabled the defined index field will not be visible to the users of this profile, but will still be entered in the idx file. Please note: Due to the fact that users of this profile are not able to see the index field, they’re also not able to edit or manipulate it. KGS Scan can communicate with the SAP application servers as well as the SAP message servers. In order to communicate with SAP, you’ll have to install the SAP .Net Connector (SAP NCo) and follow the steps described in Install SAP .NET Connector (SAP NCo). After following these steps you may set up the Index SAP Configuration by clicking on the SAP Config …-button within the Indexing-options menu. “Indexing”-options menu with highlighted “SAP Config …”-button After clicking on this button, you’ll be lead to the SAP Config which allows you to enter the credentials necessary to connect to your SAP system. By default, you’ll see the SAP application server configuration, but you may switch to the message server configuration instead by clicking on the Use Message Server-button. You may define the following parameters, depending on your setup and requirements. Parameter Type Mandatory Description Destination Name Textbox ✔ Defines the name or alias of the target. You may freely define this parameter, but you may not leave it blank. E.g.: Callisto App Server Host / IP Textbox ✔ The address of the application server - either an IP-address or a hostname. E.g.: callisto.sap-system.com 123.42.125.126 System Number Textbox ✔ The SAP system number of the system you wish to connect to. E.g.: 00 System ID Textbox ✘ The unique identifier of the SAP system (SAP SID) E.g.: E67 SAP User Textbox ✔ The user name used for logging in to the SAP system. E.g.: JANEDOE SAP User Password Textbox ✔ The password associated with the SAP user for logging in to the SAP system. E.g.: MyPassword123 SAP Client Textbox ✔ The SAP client number to be used for logging in to the SAP system. E.g.: 800 Use SNC Checkbox ✘ (Except if SNC SSO needs to be used) When this checkbox is being enabled SNC will be used. SNC Name Textbox ✘ (Except if SNC SSO needs to be used) In case SNC is being used, you may define here the SNC partner name of the SAP system. E.g.: p:CN=ACX, O=KGS-Software, C=US Use SNC SSO Checkbox ✘ (Except if SNC SSO needs to be used) When this checkbox is being enabled SNC SSO will be used. Language Selection ✔ Language that is used to logon on the SAP-systems. REturn values from SAP function calls are usually shown in that language Possible Values: Automatic - choose language from scan client settings English - Englisch language German - German language SAP RouterString Text ✘ Used to establish a connection to SAP ERP with a SAP Router. After defining the parameters to your needs, you may test the connection by clicking the Ping SAP System-button in the top-right corner. When clicking on the Ping SAP System-button you’ll either get a status message that tells you the connection was successful or that the connection wasn’t successful. In that case please check the parameters you entered. SAP Configuration with unsuccessful connection SAP Configuration with a successful connection In addition to the application-server-method described above, you may also connect to an SAP message server. In order to set up an SAP Message Server configuration please click on the button Use Message Server. Here you may define the following parameters (depending on your requirements). Parameter Type Mandatory Description System ID / R3 Name Textbox ✔ The name or alias name of the target computer. You may freely assign this parameter, but you may not leave it blank. E.g.: Callisto-Message-Server Message Server Host Textbox ✔ The address of the message server - either an IP-address or a hostname. Msg Server Service Textbox ✘ In case a specific message server service is used you may define it here. Logon Group Textbox ✘ In case a logon group is being used, please define it heer. SAP User Textbox ✔ The username is being used in order to login into the SAP system. E.g.: JANEDOE SAP User Password Textbox ✔ The password, which is being associated with the SAP user used for logging into the SAP system. E.g.: MyPassword123 SAP Client Textbox ✔ The SAP client number to be used for logging in to the SAP system. E.g.: 800 use SNC Checkbox ✘ When this checkbox is being enabled SNC will be used. SAP SNC SSO Checkbox ✘ When this checkbox is being enabled SNC SSO will be used. Language Selection ✔ Language that is used to logon on the SAP-systems. REturn values from SAP function calls are usually shown in that language Possible Values: Automatic - choose language from scan client settings English - Englisch language German - German language SAP RouterString Text ✘ Used to establish a connection to SAP ERP with a SAP Router. In order to make documents that have been scanned and archived to the archive available in the SAP system, it’s necessary to call an SAP function module, which will perform the so-called linking procedure. As part of this procedure, the function module links the document to suitable SAP business objects. In order to choose the SAP Function module please click on the Module Function tab within the Index SAP Configuration. After clicking on the tab Module Function you may either use the standard function module /KGS1/SCAN_ATTR or in case you did not install it on your SAP system and are using another module you may also choose a Custom module and enter the module within the Custom-field. Opened “Module Function”-tab with “Custom”-SAP Function module textbox. Please note: In order to perform such linking procedures (in the BDS_BAR_EX-table) for the late archiving SAP ArchiveLink scenario, you need to pass a linking barcode value to the SAP system. To ensure this is possible, you have to configure at least one index field of the type Barcode Table or Separation Barcode!
Description of options in “Indexing”-dialogue
Description of options in “Edit Indexfield“-dialogue
Options for parameter “Type”
Additional options for parameter “Scope”
Type-specific options for parameter “Text”
Type-specific options for parameter “Export Documentname”
Type-specific options for parameter “Separation Barcode”
Type-specific options for parameter “Barcode Table”
Type-specific options for parameter “Date”
Type-specific options for parameter “Value List”
Type-specific options for parameter “Email List”
Type-specific options for parameter “Indexstatus”
Type-specific options for parameter “Page Count“
Type-specific options for parameter “Batch Name“
Type-specific options for parameter “FImporter Forldername”
Type-specific options for parameter “SAP DocID”
Index SAP Configuration
SAP Application Server Configuration
SAP Message Server Configuration
Configuring the SAP function modul
Batch Naming
The Batch Naming-tab allows you to define how a batch will be named once it’s being exported using one of the available exporters. This option is similar to the document naming, but instead allows you to define naming parameters for the entire export, which is reffered to as a batch. On the left-hand side you’ll see a list of available parameters. on the right hand-side you’ll see the list of the defined parameters. The parameters define the name of the batch starting from top to bottom. Opened Batch Naming tab with two naming options enabled. You may add naming parameters by clicking on the left list on the parameter you wish to add and clicking on the double-angle-bracket-button pointing to the right-hand side ( >> ) and you may remove selected items by clicking on the item in the left list and clicking the double-angle-bracket-button poiting to the left-hand side ( << ). Depending on your setup, KGS ScanClient will provide you with the following three options. Option name Type Description Possible Values Text Textbox By adding Text-fields to the naming options, you’re able to add texts to the file-names generated by KGS Scan. e.g.: Batch_ Please note: These texts are static and do not change. Strings Index Value Combobox By adding Index Value-fields you’re able to use defined index fields for your batch-naming (if you’ve defined index fields within the Indexing-tab). e.g.: 20200826 kgsuser Please note: This option is only available when index fields are defined within the Indexing-tab. All index fields defined in the Indexing-tab Export index Combobox This option will add consecutive numbering to the file name/-s generated by KGS Scan. You may choose from three different options: 0:D3} => Consecutive numbering with three digits {0:D4} =>Consecutive numbering with four digits {0:D5} =>Consecutive numbering with five digits {0:D3} {0:D4} {0:D5} Please note: By adding the same option multiple times and configuring it’s own configuration (like choosing from different defined index values), you’re able to define the name of the document according to your needs.
e.g.: 037
e.g.: 0042
e.g.: 00001
Export
Within the Export-tab you may choose from a wide variety of available exporters depending on your needs and requirements. Most exporters are being shipped with additional options, which allows you to define the export even further and customize it to your needs. The exporter User Selection allows your users to save scanned documents to any directory they have access to. The documents might be saved as .tiff-files or .pdf-files This exporter allows you to define the format of the exported documents, the path where these documents will be saved to, as well as the compression. Suboption name Type Description Possible Values Export Format List You may choose one of the following entries from the list, which will define the output format, the scanned documents will be saved as. Multi Page PDF Multi Page PDF/A Multi Page Tiff Multi Page Tif Export Path Textbox Within this textbox you may define the path, KGS ScanClient will exports the documents to. You may open the directory-selector by pressing the …-button on the right-hand side. Please note: In order to work properly, the user who’s scanning the documents has to has access to that path. Every path leading to an directory Compression List Depending on your export-format you’ll get a list of different compression methods and algorithms which can reduce the amount of space required by the exported documents. Please note: Depending on the import format of the documents (black and white, grayscale, color) as well as the documents itself, each compression algorithm might have it’s advantages or disadvantages. Multi Page PDF and Multi Page PDF/A: NONE STRONG Multi Page Tiff and Multi Page Tif: NONE AUTO CCITT3 CCITT4 LZW JPEG DEFLATE ADOBEDEFLATE OJPEG THUNDERSCAN NEXT Folder Browser Checkbox Enabling the Folder Browser-option allows your users to select a folder of their choice. Checked Unchecked Searchable PDFs Checkbox When enabling the option Searchable PDFs KGS ScanClient will start an OCR process and scan the documents for characters recognized by the OCR engine. Checked Unchecked Languages Combobox By default KGS ScanClient supports the following three languages for OCR: German English French In case you require additional language you might add additional Tesseract-Language-Packs to the installation folder. ( C:\ProgramData\KGS Scan\OCRData). You can combine multiple language packs by adding a +-sign between each name. Please note: OCR is a resource and time consuming job which might increase the amount of time KGS ScanClient needs in order to process the documents, depending on the number of languages you do OCR scans for. English French German English+French+German English+French English+German French+German This exporter allows to export to a scp server Suboption name Type Description Possible Values Host Text Host of the SCP Server Hostname or IP-Addres Port Number Portnumber of the SCP Server (default 22) allowed port User Text Username to login in SCP Server Password Text Password for the SCP Server user Exportfolder Text Folder to export files to. Please note: In order to work properly, the user who’s scanning the documents has to has access to that path. valid Linux/Unix path When using the SAP Export OLE, KGS ScanClient will use the integrated OLE bridge in order to connect to the SAP system (which has to be configured) and perform the export. There are two different scenarios: KGS Scan is called directly from within SAP and the profile will be named according to the scheme <ContentRepository>_<FileFormat>. After a valid call from SAP with the corresponding content repository, KGS ScanClient will store the documents in SAP or via the specified content server. KGS Scan is already opened and the scanning will take place based on any desired profile (for which SAP has been set as the export type) and scanning is commenced via SAP. Depending on the format you choose for the export you might have additional options. Suboption anme Type Description Possible values Export Format List You may choose one of the following entries from the list, which will define the output format, the scanned documents will be saved as. Multi Page PDF Multi Page PDF/A Multi Page Tiff Multi Page Tif Searchable PDFs Checkbox When enabling the option Searchable PDFs KGS ScanClient will start an OCR process and scan the documents for characters recognized by the OCR engine. Checked Unchecked Languages Combobox By default KGS ScanClient supports the following three languages for OCR: German English French In case you require additional language you might add additional Tesseract-Language-Packs to the installation folder. ( C:\ProgramData\KGS Scan\OCRData). You can combine multiple language packs by adding a +-sign between each name. Please note: OCR is a resource and time consuming job which might increase the amount of time KGS ScanClient needs in order to process the documents, depending on the number of languages you do OCR scans for. English French German English+French+German English+French English+German French+German The exporter KGS Scanserver will export the documents to the defined Scanserver within the General Options. This comes in handy in scenarios in which you want to store documents externally on a server or do OCR and wish not to put the load to the hardware resources on a client. Please note: In order to work properly some configurations have to be done on KGS Scanserver. You need to specify at least one queue and valid users on the server side. Suboption name Type Description Possible values Export Format List You may choose one of the following entries from the list, which will define the output format, the scanned documents will be saved as. Multi Page PDF Multi Page PDF/A Multi Page Tiff Multi Page Tif Export Queue List You may choose from the list of the defined queues that exists on KGS Scanserver. Every defined queue on KGS Scanserver Batch Separation after Number In case you wish to separate batches after n documents, you may define the number of documents after which the export is interpretated as a new batch. All numbers >= 0 Compression List Depending on your export-format you’ll get a list of different compression methods and algorithms which can reduce the amount of space required by the exported documents. Please note: Depending on the import format of the documents (black and white, grayscale, color) as well as the documents itself, each compression algorithm might have it’s advantages or disadvantages. Multi Page PDF and Multi Page PDF/A: NONE STRONG Multi Page Tiff and Multi Page Tif: NONE AUTO CCITT3 CCITT4 LZW JPEG DEFLATE ADOBEDEFLATE OJPEG Searchable PDFs Checkbox When enabling the option Searchable PDFs KGS ScanClient will start an OCR process and scan the documents for characters recognized by the OCR engine. Checked Unchecked Languages Combobox By default KGS ScanClient supports the following three languages for OCR: German English French In case you require additional language you might add additional Tesseract-Language-Packs to the installation folder. ( C:\ProgramData\KGS Scan\OCRData). You can combine multiple language packs by adding a +-sign between each name. Please note: OCR is a resource and time consuming job which might increase the amount of time KGS ScanClient needs in order to process the documents, depending on the number of languages you do OCR scans for. English French German English+French+German English+French English+German French+German This exporter type allows you to directly save scanned documents to an archive via the SAP Content Server http interfaces. This means, that every archive system certified for SAP ArchiveLink 4.5 or higher can be used as a target system. After placing a document successfully in an archive, KGS Scan will automatically link the corresponding index fields in the SAP system according to the configuration. Within this tab you may define the connection to the destination contentserver. Option name Type Description Possible Values ContentServer Address Textbox Here you may enter the http-connection-string to the desitnation contentserver http://123.123.123.124:8080/KGSAdmin-CS/contentserver http://localserver.com/sapcs Test Connection Button This button allows you to test the connection parameters you entered. Please note: It’s recommended to test the connection in order to make sure, that KGS ScanClient is able to connect to the destination archiving system. *contRep Textbox Here you may enter the content repository KGS ScanClient will export the documents to. FI, AB, AS, HR, … *compId Textbox Here you may define the component id, the name of the component that will be stored within the archiving system. data, scanned_document, document, … Enable Security Checkbox When enabling security, KGS ScanClient will activate the security level for ArchiveLink communication. You have to configure additional parameters for this option within the security tab. Checked Unchecked *pVersion Textbox Within this field you may define the protocol version for ArchiveLink communication 0047, 0046, … Within this tab you might import certificates, enable imported certificates and send certificates to the contentserver in order to use ArchiveLink security for communication. Within this Tab, it is possible to create and export a note-component. The components content can be configured with a template. Operation name Type Description Possible Values Note Template Textbox Allows to enter a text that represents the content of the note-component. Following variables are subsituted: {user name} → the current logged in User {hostname} → the name of the host that is running the Scan Application {date} → the current date in format YYYY-MM-DD {time} → the current time in format HH:MM:SS “This is a note component from user {user name} and was sent from workstation {hostname} at {date} : {time}” Within the Connection-tab you may provide the information required by KGS ScanClient in order to connect to your SAP system. In case you’re using an SAP application server you may provide the following parameters. Suboption name Type Description Possible values Destination Name * Textbox Defines the name or alias of the target. You may freely define this parameter, but you may not leave it blank. E.g.: Callisto App Server Host / IP * Textbox The address of the application server - either an IP-address or a hostname. E.g.: 123.42.125.126 System Number * Textbox The SAP system number of the system you wish to connect to. E.g.: 00 System ID Textbox The unique identifier of the SAP system (SAP SID) E.g.: E67 SAP User * Textbox The user name used for logging in to the SAP system. E.g.: JANEDOE SAP User Password * Textbox The password associated with the SAP user for logging in to the SAP system. E.g.: MyPassword123 SAP Client * Textbox The SAP client number to be used for logging in to the SAP system. E.g.: 800 Enable SNC Checkbox When this checkbox is being enabled SNC will be used. Checked Unchecked SNC Name Textbox In case SNC is being used, you may define here the SNC partner name of the SAP system. E.g.: p:CN=ACX, O=KGS-Software, C=US SNC SSO Checkbox When this checkbox is being enabled SNC SSO will be used. Checked Unchecked SNC Library List When enabling SNC you might choose the type of cryptographic library here. None (use System Default) Common Crypto Lib Kerberos 5 System Variable SNC_LIB Protection Level List Here you may choose the level of protection. Auto (provided from SAP System) Authentication only Integrity protection Privacy protection Maximum security Path to X509 Cert Textbox You may provide the path to the x509-certificate file here. Please note: You may also select a file by clicking on the Load …-button. SAP Language Textbox Here you may provide the langugage used within the SAP system. Trace Log Level List You may choose from the provided list the level of trace logging that shall be done during the communication processes with SAP. 0 - No Tracing (default) 1 - Function Calls 2 - Function Calls, API Calls 3 - Function Calls, API calls, Internal methods 4 - Function Calls,API,Internal and Network Hex Dump In case you’re using an SAP message server you may provide the following parameters. Suboption name Type Description Possible values System ID / R3 Name Textbox The name or alias name of the target computer. You may freely assign this parameter, but you may not leave it blank. E.g.: Callisto-Message-Server Message Server Host Textbox The address of the message server - either an IP-address or a hostname. Msg Server Service Textbox In case a specific message server service is used you may define it here. Logon Group Textbox In case a logon group is being used, please define it heer. System ID textbox The unique identifier of the SAP system (SAP SID) E.g.: E67 SAP User Textbox The username is being used in order to login into the SAP system. E.g.: JANEDOE SAP User Password Textbox The password, which is being associated with the SAP user used for logging into the SAP system. E.g.: MyPassword123 SAP Client Textbox The SAP client number to be used for logging in to the SAP system. E.g.: 800 Use SNC SSO Checkbox When this checkbox is being enabled SNC will be used. Checked Unchecked SNC Partnername Textbox Here you may provide the name of the SNC partner. SAP SNC SSO Checkbox When this checkbox is being enabled SNC SSO will be used. Checked Unchecked SNC Bibliothek List When enabling SNC you might choose the type of cryptographic library here. None (Defualt) Common Crypto Lib Kerberos 5 System Variable SNC_LIB SAP Language Textbox Here you may provide the langugage used within the SAP system. Within this tab you may define the SAP function module, that will Suboption name Type Description Possible values Export Format List You may choose one of the following entries from the list, which will define the output format, the scanned documents will be saved as. Multi Page PDF Multi Page PDF/A Multi Page Tiff Multi Page Tif Mail From Textbox Here you may enter the SMTP mail address, which will be used to login to the SMTP server and send mails from. Any existing mail address on your SMTP server. From Alias Textbox Within the From Alias field you may define an Alias used for the mail that will be sent. E.g.: scanstation42@localserver.com Sender Password Textbox In order to login to the SMTP server you may have to provide the password associated with the account you entered at the Mail From field. SMTP Host Textbox In the field SMTP Host you have to enter the address of the SMTP host, which will be used for the communication. Port Textbox Here you may enter the port which is being used during the communication process with the SMTP host. Use SSL Checkbox You may check this box in order to enable SSL for communications. E-Mail Text (optional) Textbox In case your scenario requires it, you may enter a text to the Searchable PDFs Checkbox When enabling the option Searchable PDFs KGS ScanClient will start an OCR process and scan the documents for characters recognized by the OCR engine. Checked Unchecked Languages Combobox By default KGS ScanClient supports the following three languages for OCR: German English French In case you require additional language you might add additional Tesseract-Language-Packs to the installation folder. ( C:\ProgramData\KGS Scan\OCRData). You can combine multiple language packs by adding a +-sign between each name. Please note: OCR is a resource and time consuming job which might increase the amount of time KGS ScanClient needs in order to process the documents, depending on the number of languages you do OCR scans for. English French German English+French+German English+French English+German French+German Please note: In order to use this exporter, you’ll have to define an index field of type Email List in order to work properly. In case you did not create such an index field, KGS ScanClient will show a message that you should create it. The SAP Export (OLE) - Scan Server Exporter is a combination of the SAP Export (OLE) and the ScanServer Exporter. You may call the KGS ScanClient from within SAP, but instead of archivnig the document directly, you may send it to the scanserver for further processing ( like OCR on the server side). Option name Type Description Possible values Export Format List You may choose one of the following entries from the list, which will define the output format, the scanned documents will be saved as. Multi Page PDF Multi Page PDF/A Multi Page Tiff Multi Page Tif Export Queue List You may choose from the list of the defined queues that exists on KGS Scanserver. Every defined queue on KGS Scanserver Batch Separation after Number In case you wish to separate batches after n documents, you may define the number of documents after which the export is interpretated as a new batch. All numbers >= 0 Compression List Depending on your export-format you’ll get a list of different compression methods and algorithms which can reduce the amount of space required by the exported documents. Please note: Depending on the import format of the documents (black and white, grayscale, color) as well as the documents itself, each compression algorithm might have it’s advantages or disadvantages. Multi Page PDF and Multi Page PDF/A: NONE STRONG Multi Page Tiff and Multi Page Tif: NONE AUTO CCITT3 CCITT4 LZW JPEG DEFLATE ADOBEDEFLATE OJPEG Searchable PDFs Checkbox When enabling the option Searchable PDFs KGS ScanClient will start an OCR process and scan the documents for characters recognized by the OCR engine. Checked Unchecked Languages Combobox By default KGS ScanClient supports the following three languages for OCR: German English French In case you require additional language you might add additional Tesseract-Language-Packs to the installation folder. ( C:\ProgramData\KGS Scan\OCRData). You can combine multiple language packs by adding a +-sign between each name. Please note: OCR is a resource and time consuming job which might increase the amount of time KGS ScanClient needs in order to process the documents, depending on the number of languages you do OCR scans for. English French German English+French+German English+French English+German French+GermanExporter: User Selection
Exporter: Batch Export
Exporter SCP Export
Exporter: SAP Export (OLE)
Exporter: KGS Scanserver
Exporter: ContentServer Exporter / SAP Linking
Subconfiguration: HTTP ContentServer - Tab: Connection
Subconfiguration: HTTP ContentServer - Tab: Security
Subconfiguration: HTTP ContentServer - Tab: Note
Subconfiguration: SAP Configuration - Tab: Connection
Subconfiguration: SAP Configuration - Tab: Module Function
Subconfiguration: SAP Configuration - Tab: Module Parameter
Subconfiguration: SAP Configuration - Tab: Common Settins
Exporter: Mail Exporter
Exporter: SAP Export (OLE) - ScanServer Exporter