1. Manuals
  2. Brands
  3. Adaptive Recognition Manuals
  4. Rfid Systems
  5. Osmond
  6. User manual

Adaptive Recognition Osmond User Manual

Hide thumbs Also See for Osmond:
1
Table Of Contents
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
Table of Contents

Advertisement

Quick Links

Download this manual
Osmond
User Manual
This manual contains instructions on accessing
the web interface, system settings and setup guidelines,
as well as usage and maintenance.
© Copyright Adaptive Recognition Inc.
All rights reserved.
25.06.2024

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Osmond and is the answer not in the manual?

Questions and answers

Related Manuals for Adaptive Recognition Osmond

Summary of Contents for Adaptive Recognition Osmond

  • Page 1 Osmond User Manual This manual contains instructions on accessing the web interface, system settings and setup guidelines, as well as usage and maintenance. © Copyright Adaptive Recognition Inc. 25.06.2024 All rights reserved.

  • Page 2: Table Of Contents

    Passport Reader Software Package v. 2.1.11.1 Firmware v. 1.8.0011 Document version: 25.06.2024 Table of Contents I. QUICKSTART GUIDE OF OSMOND L, R AND N..................6 WHAT’S IN THE BOX ..........................6 HOW TO GET STARTED ........................... 7 2.1. USB DEVICES – OSMOND R AND L ....................7 2.2.
  • Page 3 CORRECT DOCUMENT PLACEMENT ....................227 OLED DISPLAY STATUS ICONS ......................229 2.1. OLED DISPLAY STATUS ICONS OF OSMOND NETWORK DEVICES ........229 2.2. OLED DISPLAY STATUS ICONS OF OSMOND USB DEVICES ..........231 WEB INTERFACE READING PHASES – ICON DESCRIPTION ............233 3.1.
  • Page 4 14.3. SETTING ON OSMOND ......................316 14.4. TESTING THE SETUP ......................319 14.5. TROUBLESHOOTING ....................... 320 SETTING THE SMB (SMB1) PROTOCOL ON OSMOND ............322 15.1. SETTING SMB ON WINDOWS 10 ..................323 15.2. SETTING ON OSMOND ......................327 15.3.
  • Page 5 24.2. SETUP SERVER ON PC ......................433 24.3. SETUP CLIENT .......................... 434 24.4. USING FULL PAGE READER WITH OSMOND N THROUGH NETAPI ......435 NETWORK WEB APPLICATION API (NWA MODE) ..............440 25.1. REQUIREMENTS ........................440 25.2. SUPPORT FOR OTHER LANGUAGES ................... 444 25.3.

  • Page 6: Quickstart Guide Of Osmond L, R And N

    OSMOND User Manual I. QUICKSTART GUIDE OF OSMOND L, R AND N WHAT’S IN THE BOX 6/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...

  • Page 7: How To Get Started

    OSMOND User Manual HOW TO GET STARTED 2.1. USB DEVICES – OSMOND R AND L 1. Connect the USB cable to the scanner (USB-C) and to the PC (USB-A). 2. Connect the power supply to the scanner. 3. Connect the power cord to the to the power supply and to the wall socket.
  • Page 8 OSMOND User Manual 9. Operating the device according to application areas: 9.1. For end-user, or testing the software setup: Full Page Reader application (default operation mode) (included in the PR Software Package) Authentication Checker application (included in the PR Software Package) 9.2.
  • Page 9 - After the device is connected successfully, place a document on the scanning surface of the reader. The device starts the scanning process automatically. - After the scanning process is finished, the extracted data can be examined in the application. For more information on Osmond USB devices, see Osmond R and L (USB Devices) chapter.

  • Page 10: Dual Usb/Network Interface Devices - Osmond N

    POE source is 100 m. If the given PC has an adequate PCI card with 20W PowerDelivery functionality and USB type-C slot, then the Osmond N device can be powered via USB regardless of the operation mode (USB or network).
  • Page 11 However, in case of purchasing VIZ OCR or VIZ AUTH OCR engine, download the required VIZ OCR VIZ AUTH OCR engine from the ADAPTIVE RECOGNITION website and perform the installation. For more information on it, see VIZ OCR and VIZ AUTH OCR Engine Management chapter.
  • Page 12 OSMOND User Manual 9. Operating the device: 9.1. In Network mode according to application areas: 9.1.1. For end-user: Network Web Interface (NWI) (default operation mode): Using the device with web browser 9.1.2. For integration: Network Web Application (NWA): Using the device in NWI mode managed by Open...
  • Page 13 OSMOND User Manual - Start a browser and enter the following into the browser’s address bar in order to access the web interface: a. If DHCP and local DNS services are available: {hostname and port} OSMOND-N{serial number and port} E.g., http://OSMOND-N204203:3000 Type the serial number without the very first character.

  • Page 14: Device Integration

    - After the scanning process is finished, the extracted data can be examined in the START APP menu of the web interface organized into different sections. For more information on Osmond Network device, see Osmond N (Network device) chapter.

  • Page 15: Introduction

    (optional). The available multiple illumination sources are visible white, IR, UV, OVD and edge light. A special feature of the Osmond device (type N) is that it has a built-in OS (no other installation is needed) which runs a fully functional web server that is accessible virtually with any device once the reader is connected to a network.

  • Page 16: Device Overview

    Osmond N: Network device with UV illumination, built-in RFID module and dual operational mode (USB and network mode) For more information on the technical parameters and the comparison of the Osmond L, R and N models, click on this link.

  • Page 17: Parts And Components

    OSMOND User Manual PARTS AND COMPONENTS The device is produced in a plastic (ABS) housing (1) and an aluminum base plate (2). The object-plate (3) is protected from the external light-striking by the plastic (ABS) shield/cover (4). The shield has a document holder (5) in order to facilitate the placing of the document.
  • Page 18 Ethernet port is only available at Osmond N model. The Osmond device is designed with a removable document holder built in the shield. This feature can be vital in special cases e.g., scanning extremely thick documents which cannot fit to the device due to their size being incompatible with the document holder. In that case, this holder can be removed and replaced with the so called ‘blind plug’.

  • Page 19: Hardware Setup

    OSMOND User Manual IV. HARDWARE SETUP In this section instructions and recommendations concerning the hardware integration are described, which are the following: • The device should be on a stable surface, placed horizontally. Do not install the device to an unsteady place.

  • Page 20: Hardware Installation

    OSMOND User Manual HARDWARE INSTALLATION Follow the next steps to connect the Osmond USB (L, R) or network (N) device to the PC: 1. Connect the power supply to the unit. Connect the power supply to the device by completely screwing on to the right the round, dotted part of the power supply closest to the housing.
  • Page 21 2. Connect the reader to the PC or to your environment: • In case of Osmond R and L (USB devices): Connect the device to one of the USB 2.0 or 3.0 ports of the PC with the supplied USB cable.

  • Page 22: Safety

    OSMOND User Manual V. SAFETY Equipment modifications: This equipment must be installed and used according with the instructions given in its documentation. This equipment contains no serviceable components. Unauthorized equipment changes or modifications cause warranty to void. Only operate the device with the power supply it was shipped with.

  • Page 23: Osmond R And L (Usb Devices)

    OSMOND User Manual VI. OSMOND R AND L (USB DEVICES) Osmond R and L models are USB devices that operate as any other ADAPTIVE RECOGNITION passport reader. They can be used with the Full Page Reader or Authentication Checker application as well as our SDK.

  • Page 24: Software Installation

    OSMOND User Manual SOFTWARE INSTALLATION Due to the fact that Osmond USB devices operate similar to any other ADAPTIVE RECOGNITION passport reader in order to use it, the ADAPTIVE RECOGNITION driver package is necessary. For Osmond devices, the Passport Reader software package 2.1.10.2 or higher version is required.

  • Page 25: Installation On Windows Operating Systems

    OSMOND User Manual 2.1. INSTALLATION ON WINDOWS OPERATING SYSTEMS Administrator rights are needed for installation. Upon installation of the 32-bit version to a 64-bit PC, the 64-bit device drivers are installed automatically. 32-bit application development 64-bit PCs, install 32-bit version of the Passport Reader software as well.
  • Page 26 OSMOND User Manual 4. The installation starts with the following window: Welcome Page of Passport Reader x64 setup 5. Click [Next] to launch installation. 6. Accept the EULA (by ticking the checkbox) and start the custom installation process by clicking on [Next].
  • Page 27 OSMOND User Manual 7. In the Custom Setup window, select the modules you wish to install on the PC. Installing the Device Drivers and the Passport Reader modules are necessary for device operation, the installation of all other modules is optional.
  • Page 28 OSMOND User Manual PCSC Settings Please select the Autostart option only if you intend to use your document reader device via the PC/SC interface. This setting can also be modified after the installation is finished. For more information, please see the PC/SC section.
  • Page 29 OSMOND User Manual Please select the Automatically start NetAPI server on system startup option only if you intend to use your document reader device in NAI mode. In this mode the device is used with the Passport Reader Network API.
  • Page 30 OSMOND User Manual If the PR Software Package version is below 2.1.11, then in order to use the OCR functionality of your document reader device, please also install the procr-2.0.x.xx.msi package located in the win folder of the Passport Reader install package, after current installation is finished.
  • Page 31 OSMOND User Manual 8. Clicking on [Install] will begin installation. 31/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 32 OSMOND User Manual 9. Click [Finish] to complete the installation. 32/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 33 OSMOND User Manual 10. After the installation has finished, open the Device Manager. If the installation was successful, a group named AR Devices together with Passport Reader Osmond device (Osmond models) should be listed. 33/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 34: Installation On Linux Operating System

    OSMOND User Manual 2.2. INSTALLATION ON LINUX OPERATING SYSTEM Please read through this manual carefully! The Passport Reader is a travel document reader and analyzer system by AdaptiveRecognition Inc., which bases on the GX system and provides for software developers an easy-to-program interface through its Application Programming Interface.
  • Page 35 OSMOND User Manual 2.2.2. CONTENTS OF THE INSTALL PACKAGE GX system gx-7.2.x-x.tar.gz Passport Reader Passport Reader system pr-2.1.x-x.tar.gz PRDDRV driver for Passport Reader prd-2.1.x-x.tar.gz devices OCR engine procr-2.x.x-x.tar.gz USB Neural Network Controller devices fxmcusb-7.x.x-x.tar.gz License manager licutils-7.x.x-x.tar.gz Full Page Reader application pr-fullpagereader-2.x.x-x.tar.gz...

  • Page 36: The Installation Procedure

    OSMOND User Manual 2.2.3. THE INSTALLATION PROCEDURE 1. Unpack and copy all files into your system: - use _install.sh Dependencies: Please install the following libraries with your distribution package manager or manually (these libraries are apart from services): − SDL (A library for portable low-level access to a video framebuffer, audio output, mouse, and keyboard) −...
  • Page 37 OSMOND User Manual 2. Compile kernel modules: • Download a kernel source from https://github.com/torvalds/linux and unpack into /usr/src directory. If you have an older GX version in the kernel tree, please remove it manually by using the script _uninstall.sh. You can use the kernel source package of your distribution (e.g., Ubuntu 10.04 → linux-kernel- headers).
  • Page 38 OSMOND User Manual 3. Install new kernel modules: For PRDDRV: /sbin/insmod /usr/src/gx/kernel/gxsd/gxsd.ko /sbin/insmod /usr/src/gx/kernel/prddrv/prddrv.ko 4. Automatic driver loading is enabled by the pr-udev module. This module enables the automatic installation of the driver modules upon connecting the reader to the PC. As a result, there is no need to start the driver manually.

  • Page 39: After Installation

    OSMOND User Manual 2.2.4. AFTER INSTALLATION Once installation is complete, you can find the manual for the GX and PR systems under /usr/share/doc/gx. The header files can be found in the SDK, the library files in /usr/lib64/gx. The basic GX library is in /usr/lib64 (libgxsd.so.7). The file containing the property data is /var/gx/gxsd.dat.

  • Page 40: Reader Configuration

    PRDTool is part of the Passport Reader software packages from version 2.1.9.1 and above. This program is for querying device information and performing some low-level operations for Passport Reader USB devices, especially for the Osmond device. License Manager is a license handling application which is designed to upload ADAPTIVE RECOGNITION passport reader license files to a specific document reader device.

  • Page 41: Authentication Checker Application

    OSMOND User Manual AUTHENTICATION CHECKER APPLICATION ADAPTIVE RECOGNITION provides its Authentication Checker application included in the 2.1.9 and above Passport Reader (PR) software packages. This software offers full-spectrum ID document authentication with a range of security checks and visualization features. After each scanning, the software informs the user about the authenticity of the scanned document in a comprehensive way, with 4 views on one display.

  • Page 42: Requirements

    4.2. START AUTHENTICATION CHECKER Windows After installing ADAPTIVE RECOGNITION software package on your computer, you will be able to open Authentication Checker from Windows Start menu > Adaptive Recognition > (Passport Reader) > Authentication Checker x86 or x64 (based on your computer architecture and previous installation).

  • Page 43: Connection

    OSMOND User Manual 4.3. CONNECTION In order to scan with any ADAPTIVE RECOGNITION reader device, you have to make sure that there is an available reader connected to your computer and it is turned on. You can check the DEVICES list in the OPTIONS menu.

  • Page 44: Dashboard

    OSMOND User Manual 4.5. DASHBOARD You can direct the operation of the program, change views, start or delete a scanning as well as perform some basic settings. In ALL VIEW mode the Dashboard is located in the middle of the opened window, while in the selected view (VIEWER, VALIDITY, SUMMARY, ALL DATA) on the right side of the window.
  • Page 45 OSMOND User Manual SCAN Click on the [SCAN] button to start the scanning process, if the AUTO DETECTION mode is not selected. The status signal around the SCAN button indicates the progression of the scanning process. AUTO DETECTION mode is switched on by default, thereby the scanning will start automatically.
  • Page 46 OSMOND User Manual Click on the [OCR] button to enable/disable optical character recognition. The green outline around the button indicates that the function is turned on. The MRZ reading is part of the OCR, but since it is needed for RFID reading in the most cases of the documents, the RFID and OCR buttons impact the enabling of MRZ reading.
  • Page 47 OSMOND User Manual 4.5.1. OPTIONS 1. DEVICES You can see the list of the document scanners connected to your computer. By opening the app, the device is connected automatically. You can work with only one device at a time. 47/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 48 This option will save every scanning into the same path. If the AUTOSAVE is not turned on, the saving process is skipped. If you want to save encrypted files which can only be decoded in ADAPTIVE RECOGNITION’s network, then, when saving the file select .ecz extension.
  • Page 49 The non-default settings of the OCR ENGINE and DOCUMENT DATABASE PATH are not saved. If you close and reopen the app, the default settings will be valid again. For availability and more information on OCR engines and software licenses, please contact your ADAPTIVE RECOGNITION sales representative. 49/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 50 OSMOND User Manual 4. TASKS Select between the provided functions: MRZ, VIZ+AUTH, DUAL PAGE, RFID reading and AUTO DETECTION. • MRZ: Select this task to get the data of the Machine Readable Zone. • VIZ+AUTH: Enable this task to read document-specific data and verify the optical authentications from the Visual Inspection Zone of different national documents.
  • Page 51 OSMOND User Manual Click on the button of the given task to enable (green background) or disable (grey background) it. After performing settings, close the window with the [CLOSE] button to start document reading. 51/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 52: Sections

    OSMOND User Manual 4.6. SECTIONS 4.6.1. VIEWER In the VIEWER section the scanned and/or selected images are displayed. Observe the images under various illuminations, zoom in/out, crop and fit the image to screen as well as perform manual security feature checks.
  • Page 53 OSMOND User Manual 2. CROP Enable/Disable CROP by clicking on the button. It crops and rotates documents into upright position. 3. SELECT The SELECT function shows you the read authentication and OCR fields. If SELECT is turned on and the cursor is over the SELECT button, at that time the frame of every read field will appear.
  • Page 54 OSMOND User Manual 4. IMAGE TYPES The number of image types depends on the capabilities of the given scanner. • WHITE: visible white illumination (with reflection removal) Enable/Disable WHITE illumination by right-clicking on its button. An image scanned in white light is a simple photo of the document – as it can be seen by the human eye.
  • Page 55 OSMOND User Manual • INFRA: B900 infrared illumination Enable/Disable INFRA illumination by right-clicking on its button. In this illumination, the background patterns are not visible, so optical recognition algorithms provide better results. • UV: ultraviolet (UV-A) illumination Enable/Disable UV illumination by right-clicking on its button.
  • Page 56 OSMOND User Manual • Enable/Disable illumination by right-clicking on its button. The Passport Reader system is capable of visualizing and removing simple holograms and most types of patterns. Holograms can be observed by viewing the OVD image or the OVD pattern (clean OVD) image.
  • Page 57 OSMOND User Manual • PHOTO The Photo light is only available for Osmond USB models manufactured from December 2022. Enable/Disable the PHOTO light by right-clicking on its button. Photo light is optimized for scanning photos with very high image details and color accuracy.
  • Page 58 OSMOND User Manual • EDGE Enable/Disable EDGE light by right-clicking on its button. When using Edge light, the document is illuminated at a flat angle in order to make the protruding objects located on the document cast a shadow. 58/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 59 OSMOND User Manual • Other page Enable/Disable Other page by left-clicking on its button. Select this option to check the back side of the read double paged documents. When the DUAL PAGE function is enabled, after scanning the front side of the document, the application asks the user if the back side of the document is needed.
  • Page 60 OSMOND User Manual In the VIEWER section two image types can be examined alternately. Select one of the required image types by clicking on its icon, then click on the other and continue clicking on it as long as it is necessary.
  • Page 61 OSMOND User Manual 4.6.2. VALIDITY In the VALIDITY section the results of the authenticity checks are displayed, including digital data verification (RFID), optical (OPTICAL) and comparison checks (COMPARE). 1. OVERALL RESULT GENUINE WARNING FAILED Questionable authentication Unsatisfactory authentication This document has been found results or reading failures.
  • Page 62 OSMOND User Manual 2. AUTHENTICATION CATEGORIES • RFID: authentications in relation to e-documents (performing various access control functions and checking data integrity/genuineness of the chip) • OPTICAL: security checks of optical security features, including ink, paper material, pattern matching using various illuminations, etc.
  • Page 63 OSMOND User Manual 4. THE CHART In the chart the different checks and their results are displayed. By clicking on a check, a short description about the given check as well as the interpretation of its result, image(s) from the reference database (if the OCR ENGINE and the DOCUMENT DATABASE PATH are set), picture(s) about the given data on the document (optional) and the read data (optional) can be seen.
  • Page 64 OSMOND User Manual If you click on the ALL VIEW button, you will get back to the divided view. If you click on a certain data in the VALIDITY section in ALL VIEW mode, a red frame will be displayed around the original location of the data in the VIEWER section as well as in the ALL DATA section the related check(s) to the data will be highlighted in grey.
  • Page 65 OSMOND User Manual 4.6.3. SUMMARY In the SUMMARY section, selection of the essential personal and document data is displayed. The scanned data is displayed in two separate windows depending on the data type (personal or document data). SUMMARY section summarizes the result of the scanning process.
  • Page 66 OSMOND User Manual 4.6.4. ALL DATA The ALL DATA section displays all available data retrieved from the document. More details (e.g., more columns) can be found in the ALL DATA panel than in the ALL VIEW mode. If you click on the header of the columns, the data order will be reversed as well as the aspect of the order can be modified because the app categorizes the related ones.
  • Page 67 OSMOND User Manual If you click on the ALL VIEW button, you will get back to the divided view. If you click on a certain data in the ALL DATA section in ALL VIEW mode, a red frame will be displayed around the original location of the data in the VIEWER section as well as in the VALIDITY section the related check(s) to the data will be highlighted in grey.

  • Page 68: Certificates

    OSMOND User Manual 4.7. CERTIFICATES For successful authentication, the reader needs digital certificates from the document issuer authorities. This software contains these certificates for currently used passports, but in order to support the latest documents, the certificates should be updated from time to time.

  • Page 69: Full Page Reader Application

    OSMOND User Manual FULL PAGE READER APPLICATION ADAPTIVE RECOGNITION provides its Full Page Reader (FPR) application included in the Passport Reader (PR) software package. Full Page Reader application is able to fully exploit the ADAPTIVE RECOGNITION document reader devices’ capabilities on user level.

  • Page 70: Overview

    OSMOND User Manual 5.1. OVERVIEW 70/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...

  • Page 71: Requirements

    Depending on your distribution, you can open command terminal and insert: FullPageReader or use dashboard search bar: Linux Start menu > Applications > Adaptive Recognition Apps > Full Page Reader 64-bit version (based on your computer architecture and previous installation).

  • Page 72: Connection

    OSMOND User Manual 5.4. CONNECTION In order to scan with any ADAPTIVE RECOGNITION reader device, you have to make sure that there is an available reader connected to your computer and it is turned on. You can check the DEVICES list in the OPTIONS tab at GENERAL layer.
  • Page 73 OSMOND User Manual Connect your device by clicking on [CONNECT] or clicking on the selected reader in the DEVICES list. Readers hold a factory default calibration file. Reading this file from the device for the first time may take some time, which consequently slows down the system startup. In order to save time, the file is automatically copied to the local file system on the first attempt of using the device to speed up communication.

  • Page 74: Tabs

    OSMOND User Manual 5.5. TABS Enable/Disable any of the checkboxes on vertical layers (columns) in the OPTIONS tab. These checkboxes switch on/off software functions like image capturing, OCR, barcode and RFID reading. By switching on functions, you will make visible the corresponding tab menu and related data as well.
  • Page 75 OSMOND User Manual 5.5.1. IMAGE 1. IMAGE On the IMAGE layer, the scanned and/or selected images are displayed. Navigate among images by clicking on the thumbnail view on top or double clicking on the ones at details of the document field.

  • Page 76: Save Image

    OSMOND User Manual 2. DETAILS INFO Light or field ID, format, dimension and resolution information about the selected image are displayed. SMOOTH IMAGE Use linear filtering for zooming by estimating intermediate points among end points automatically. This results a smooth image to display.
  • Page 77 OSMOND User Manual VIEW LAYERS By selecting between UV (VIEW UV FLASHLIGHT) and flashlights (VIEW OVD FLASHLIGHT) on the right, you can check the document under these two illumination types separately. If you do not choose from these flashlights, you can grab the corner/edge of a given layer (except for infra) to optically remove each and every layer from the image of the scanned ID document by left-click.
  • Page 78 To check the JURA IPI security feature, enable Photo camera on CAPTURE layer in the OPTIONS tab and click on the Photo image from the thumbnail images. The Photo light is only available for Osmond USB models manufactured from December 2022.
  • Page 79 OSMOND User Manual READ FIELD This function is only available with engines 2.0.6.xx. The READ FIELD function is equivalent to manual OCR. It can be used on White and Infrared image. Draw a rectangle around any text or barcode and its content will be displayed in the field at the bottom-right corner of the window.
  • Page 80 OSMOND User Manual 5.5.2. Displays processed MRZ data and a photo of each field. This tabulator option is displayed when OCR checkbox is filled in on the OPTIONS / OCR (vertical) layer and MRZ ONLY or ADVANCED mode is selected.
  • Page 81 OSMOND User Manual The extracted MRZ data fields can be copied to clipboard. Clipboard copy function can be activated by right clicking on any data line and in the pop-up window clicking on the [Copy] button. 81/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 82 OSMOND User Manual 5.5.3. Displays processed VIZ data and a photo of each field. The results of the authentication will be displayed in VIZ tab. The VIZ and AUTH results will be displayed only if you have special engine, that supports the scanned document.
  • Page 83 OSMOND User Manual The extracted VIZ data fields can be copied to clipboard. Clipboard copy function can be activated by right clicking on any data line and in the pop-up window clicking on the [Copy] button. 83/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 84 OSMOND User Manual 5.5.4. displays barcode data and a photo of the barcode itself. To see this option, enable barcode recognition on OPTIONS / BARCODE layer by filling in the checkbox on the vertical layer. For more information on customizing the barcode settings, see Barcode chapter.
  • Page 85 OSMOND User Manual The extracted barcode data fields can be copied to clipboard. Clipboard copy function can be activated by right clicking on any data line and in the pop-up window clicking on the [Copy] button. 85/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 86 OSMOND User Manual 5.5.5. RFID Displays RFID chip data. To see this option, enable RFID reading in OPTIONS by filling in the checkbox of the RFID vertical layer. RFID function turns off automatically, if there is no RFID reader module built in the device.
  • Page 87 OSMOND User Manual The extracted RFID data fields can be copied to clipboard. Clipboard copy function can be activated by right clicking on any data line and in the pop-up window clicking on the [Copy] button. For more information on customizing the settings of the RFID reading, see RFID chapter.
  • Page 88 OSMOND User Manual 5.5.6. Displays all available data retrieved from the document. Select VIEW DETAILED RESULT filter to review formatted data. Choose format in the header of the DATA column. 88/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 89 OSMOND User Manual The extracted data fields displayed in the ALL tab can be copied to clipboard. Clipboard copy function can be activated by right clicking on any data line and in the pop-up window clicking on the [Copy] button.
  • Page 90 OSMOND User Manual 5.5.7. SUMMARY Brief summary of the personal data, document data and the results of the security crosschecks. Face compare result is also displayed in the SUMMARY tab. 5.5.8. OPTIONS Customize application properties, lights, logs and much more on the OPTIONS tab. For more details,...
  • Page 91 OSMOND User Manual 5.5.10. LOAD Load scanned documents, including images illuminated by various light sources, as well as corresponding data. This functionality is supported only for .zip files that have been saved earlier by ADAPTIVE RECOGNITION passport reader software. 5.5.11.

  • Page 92: Options

    OSMOND User Manual 5.6. OPTIONS 5.6.1. GENERAL DEVICES OPTIONS > GENERAL > DEVICES You can see the list of document scanners connected to your computer. You can work with only one device at a time. Also, you can navigate across devices by clicking on the chosen one.
  • Page 93 The Full Page Reader application is equipped with a configurable logging feature to support any troubleshooting activities with ADAPTIVE RECOGNITION support team. By enabling different log options, you can include various events of the passport reader software in the log files.
  • Page 94 OSMOND User Manual REPROCESS ZIP FILE OPTIONS > GENERAL > REPROCESS ZIP FILE When loading .zip files saved earlier, the program either process them again with your current software version (REPROCESS ZIP FILE is enabled) or displays the original saved data (REPROCESS ZIP FILE is disabled).
  • Page 95 The given password is not saved in the computer, you have to type it after every program launch. If you want to save encrypted files which can only be decoded in ADAPTIVE RECOGNITION’s network, then, when saving the file select .ecz extension.
  • Page 96 OSMOND User Manual VIEW DETAILED RESULT OPTIONS > GENERAL > VIEW DETAILED RESULT Formatted data can be displayed on MRZ, VIZ, BCR, RFID and ALL tabs. The following formatting types are available: • Basic (BAS) • Raw (RAW) • Formatted (FMT) •...
  • Page 97 OSMOND User Manual • White OPTIONS > CAPTURE > LIGHTS > WHITE Enable White illumination by filling in the checkbox. An image scanned in white light is a simple photo of the document – as it can be seen by the human eye.
  • Page 98 OSMOND User Manual • OPTIONS > CAPTURE > LIGHTS > UV Enable UV illumination by filling in the checkbox. Images scanned in ultraviolet illumination can be used to check authenticity features (graphics and text printed with special fluorescent ink) which are only visible under UV light.
  • Page 99 • Photo OPTIONS > CAPTURE > LIGHTS > PHOTO The Photo light is only available for Osmond USB models manufactured from December 2022. Enable Photo light by filling in the checkbox at OPTIONS / CAPTURE / LIGHTS. Photo light is optimized for scanning photos with very high image details and color accuracy. Photo image is similar to an image scanned in white light with more sharpness and contrast.
  • Page 100 OSMOND User Manual • Edge OPTIONS > CAPTURE > LIGHTS > EDGE LIGHT Enable Edge light by filling in the checkbox at OPTIONS / CAPTURE / LIGHTS. When using Edge light, the document is illuminated at a flat angle in order to make the protruding objects located on the document cast a shadow.
  • Page 101 OSMOND User Manual 2. REFLECTION REMOVAL (RR) OPTIONS > CAPTURE > REFLECTION REMOVAL Improve OCR processing by eliminating glare on the scanned image of the document. By enabling RR, the device takes two pictures of the document from two different angles.
  • Page 102 3. ADAPTIVE LIGHT CONTROL OPTIONS > CAPTURE > ADAPTIVE LIGHT CONTROL ADAPTIVE RECOGNITION’s ADAPTIVE LIGHT CONTROL feature compensates for external light interference and make routine operation independent of the environment. In order to use this feature, fill in the checkbox(es) you wish to apply before starting the illumination process.
  • Page 103 OSMOND User Manual 5.6.3. Enable OCR process by filling in the checkbox on top-left corner of the layer. 1. OCR MODE OPTIONS > OCR > OCR MODE Select between two OCR modes to configure the OCR tasks to be performed.
  • Page 104 OSMOND User Manual ADVANCED mode is increasing processing time. ADVANCED mode MRZ ONLY mode 2. AUTO DOUBLE PAGE OPTIONS > OCR > AUTO DOUBLE PAGE Enable AUTO DOUBLE PAGE to read double paged documents automatically. When this option is enabled, after scanning the front side of the document, the application asks the user if the back side of the document is needed.
  • Page 105 OSMOND User Manual When the scanning of both sides is finished, use the blue colored left and right arrows to navigate among the scanned images. Left and right arrows are displayed, when more than 8 images are scanned from a document.
  • Page 106 OSMOND User Manual 3. USE OCR-IP FOR IP DEVICE OPTIONS > OCR > USE OCR-IP FOR IP DEVICE When enabling USE OCR-IP FOR IP DEVICE option, for performing OCR, the FPR application uses the OCR engine that can be found on the remote network device.
  • Page 107 (3:ERRO) [prapi] > (cmd:2008006f) (1012) - Hardware key does not work properly [prapi] (license). → It is referring to the missing PR software license. Please, contact your ADAPTIVE RECOGNITION sales representative to ask for license update. • (3:ERRO) [prdoc] > Ocr read: FAILED: Hardware key does not work properly [gxmodule].
  • Page 108 The values of the AUTH fields are in thousandths. The limits are the following: • 0-329: ERROR • 330-659: WARNING • 660-1000: OK These limits are ADAPTIVE RECOGNITION standard values. 108/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 109 OSMOND User Manual Scanned image Reference image By double clicking on the corresponding AUTH field, the accurate place of the image fragment will be shown in the complete image. 109/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 110 OSMOND User Manual 5.6.4. BARCODE Enable BARCODE recognition by filling in the checkbox on top left corner of the layer. If you do not need barcode recognition, disable this option to speed up processing. 1. BARCODE RECOGNITION ORDER OPTIONS > BARCODE > BARCODE RECOGNITION ORDER Set the order of tries in recognizing barcodes.
  • Page 111 • Autocontrast values: -1, -2 and -3 By clicking on the [GET] button you will get the current value. For more information on BARCODE CONTRAST, please contact ADAPTIVE RECOGNITION support team. AUTOCONTRAST It is recommended to use instead of manual settings.
  • Page 112 OSMOND User Manual 3. DOUBLE BC READING OPTIONS > BARCODE > DOUBLE BC READING Enable the DOUBLE BC READING function in order to scan multiple barcodes from the same document page in a single scanning attempt. 112/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 113 OSMOND User Manual 5.6.5. RFID View the RFID layer in the OPTIONS tab to customize the parameters of RFID chip reading: authentications to perform and data groups to read. RFID Authentication is a process that validates claimed identity of a participant in an electronic transaction.
  • Page 114 OSMOND User Manual 3. ACTIVE AUTH OPTIONS > RFID > ACTIVE AUTH Enable/Disable ACTIVE AUTHENTICATION. Active Authentication protects against chip cloning by verifying if DG15 is not a copy. It is basically a two-way interaction between the reader and the document that involves communication with the non-accessible memory of the chip.
  • Page 115 OSMOND User Manual The Passport Reader software package is implemented with German Master List that includes CSCA certificates of hundreds of documents. You may download and use the latest version of this Master List from https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/ElekAusweise/CSCA/GermanM asterList.html 5. CHIP AUTH OPTIONS >...

  • Page 116: Select Application

    OSMOND User Manual 7. SELECT APPLICATION OPTIONS > RFID > SELECT APPLICATION Enable/Disable SELECT APPLICATION function. If it is selected, the Passport Reader software automatically selects a supported application on the RFID chip: ePassport, eID, eDL or IDL. 8. DG1-16 OPTIONS >...
  • Page 117 OSMOND User Manual 12. RFID DETECTION OPTIONS > RFID > RFID DETECTION Use the RFID DETECTION feature to determine if there is an eDocument positioned onto the document reader device. If you click on this button, a window will pop up with the fundamental data of the document/chip.

  • Page 118: Manual Settings

    Fine-tune your software by changing default system property values to customize operation according to your preferences. Changing parameters may have negative effect on system performance and operation. If in doubt with the proper value, please consult with ADAPTIVE RECOGNITION support team. 1. PROPERTY NAME OPTIONS > MANUAL SETTINGS > PROPERTY NAME Every property has a name and most properties have path as well.
  • Page 119 OSMOND User Manual 5.6.7. PROCESSING 1. PROCESSING TIME OPTIONS > PROCESSING > PROCESSING TIME Brief summary of the PROCESSING TIME of each processing phase. 2. PROCESSING LOG OPTIONS > PROCESSING > PROCESSING LOG The PROCESSING LOG displays the main events of each document reading process.
  • Page 120 OSMOND User Manual 5.7. FAQ 5.7.1. BASICS How to connect reader before scanning? 1. Open Full Page Reader (FPR) app. 2. View GENERAL layer in OPTIONS tab to see available reader(s). 3. Connect reader to your system to gain access its features by a.
  • Page 121 OSMOND User Manual 5.7.2. SCANNING How to scan? 1. Connect reader. 2. Open vertical layers in OPTIONS tab and enable/disable filters to customize the FPR’s operation according to your needs. a. Activate CAPTURE layer for scanning documents by filling in the checkbox and set the illumination types you wish to apply.
  • Page 122 OSMOND User Manual b. Activate OCR layer by filling in the checkbox and select your OCR ENGINE for performing character recognition. Select ADVANCED mode to read data from MRZ and VIZ fields as well. c. Activate BARCODE layer by filling in the checkbox to read barcode(s) from documents.
  • Page 123 OSMOND User Manual d. Activate RFID layer by filling in the checkbox to read RFID chip data from e-documents. Select the data groups to read and the authentication mechanisms to execute. 3. Start scanning by pressing the [START] button or use DOCUMENT DETECTION.
  • Page 124 OSMOND User Manual How to enable document presence detection (aka Motion Detection, Freerun Mode, Auto-scan)? Select DOCUMENT DETECTION option on OPTIONS / GENERAL layer to enable document presence detection. This feature automatically scans images using the selected filters whenever a document is available on the surface of the reader.
  • Page 125 OSMOND User Manual 5.7.3. SAVE, LOAD, REPROCESS How to save a scanning? 1. Select filters and scan a document. 2. Choose from the following saving methods: a. Click on [SAVE] and browse the path as well as specify the filename to finish the saving process.
  • Page 126 OSMOND User Manual d. Select ENABLE EASY SAVE and turn on AUTOSAVE to perform automatic saving. If the EASY SAVE PATH is not specified, the automatic saving is not performed. 3. If you have selected ENABLE EASY SAVE, you will find the images of the scanned document in the folder that you have selected at OPTIONS / GENERAL / EASY SAVE PATH.
  • Page 127 OSMOND User Manual How to load or reprocess a previous scanning? What is the difference? • LOAD 1. Click on the [LOAD] button. 2. Browse for your .zip file and click on it. 3. Open the selected file. 4. You get the original data and images in the app as it was processed earlier.
  • Page 128 OSMOND User Manual How to make a collection of sample documents to send to ADAPTIVE RECOGNITION? 1. Open Full Page Reader. 2. Select all available illumination types for both LIGHTS and REFLECTION REMOVAL. REFLECTION REMOVAL ensures glare-free images that provides higher OCR accuracy.

  • Page 129: Osmond N (Network Device)

    OSMOND User Manual VII. OSMOND N (NETWORK DEVICE) Osmond N device operates as a network device. It could be connected to any internal network with DHCP, and the reader could be controlled via Web GUI. Osmond N model is able to operate in USB and Network mode as well. For more information Devices Capable of Dual Operational Mode chapter.

  • Page 130: Integration Options

    OSMOND User Manual 1.1. INTEGRATION OPTIONS 130/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...

  • Page 131: Accessing The Web Interface Of The Device From A Browser (Nwi Mode)

    LED on the power touch button switches to green. 2. A few seconds later the ADAPTIVE RECOGNITION logo is displayed on the OLED display (the booting is in progress). 3. After the boot process, the status display appears on the screen:...
  • Page 132 E.g., http://OSMOND-N204203:3000 Type the serial number without the very first character. E.g., 204203 instead of 2204203. The hostname of your device is OSMOND-N{serialnumber }. The serial number of your device is printed to the sticker located at the bottom of your scanner.
  • Page 133 OSMOND User Manual If all information was entered correctly, the following screen should come up in your browser window. If login fails due to invalid username/password, delete the browser cache (Ctrl + F5), then retry login. When there is a time difference between device and host PC, the web interface allows the login, but only the DATE AND TIME menu will be available.
  • Page 134 OSMOND User Manual When the device is not in network mode, but e.g., in USB mode, and the user signs in the web interface, the interface directs the user to the MAINTENANCE / OPERATING MODE menu, where one of the following options must be selected: •...
  • Page 135 OSMOND User Manual The system sends notifications about events which may concern the user. Such event can be for example the success or failure of saving a data sheet as well as if the document is to be changed in the document reader after scanning a page.
  • Page 136 OSMOND User Manual In the case of a two-sided document the application indicates to the user which page is missing and should be inserted to the scanner. 136/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore...
  • Page 137 OSMOND User Manual If you are signed in, you will find the following screen in your browser window: This is the home page, the START APP menu, where you can scan identity documents. Before scanning, it is important to check the Main menu (the three horizontal stripes; at the top left corner of the webpage) and perform the required settings.

  • Page 138: Web Interface

    OSMOND User Manual WEB INTERFACE 2.1. ADMINISTRATION 2.1.1. USERS In the USERS menu, you can create and delete users, you can also change the passwords and the roles of the users. Click on the [+NEW USER] button to add a user.
  • Page 139 • NAI: This user role belongs to the NetAPI operating mode. NetAPI user is required to operate the Osmond N device via Passport Reader NetAPI. • NWA: This user role belongs to the Network Web Application API operating mode and can only be used in Network Web Application API operating mode.
  • Page 140 OSMOND User Manual Providing Public key is required only for establishing SSH connection to the device upon remote troubleshooting sessions. The Owner users can upload public key to the device: in the possession of the private key belonging to this public key, the device is accessible through SSH with a user named "baas"...
  • Page 141 OSMOND User Manual Using the Session timeout option, owners may specify the length of user sessions. Session timeout value is applied for each user. From each role, only one user can be logged in, at the same time. The only exception is the Owner that can be logged in together with other, non-owner users.

  • Page 142: Date And Time

    The Device local time and the Client local time are displayed, which thereby can be checked. The Device local time indicates the accurate time of the Osmond N device used by the client while the Client local time indicates the accurate time of the computer, tablet or phone used by the client.
  • Page 143 Setting the correct time is necessary for the appropriate operation of the device. The Osmond device has a built-in protection to prevent access to its web interface when time difference between the scanner and the client device is greater than 30 seconds.
  • Page 144 OSMOND User Manual 2.1.3. LANGUAGE In the LANGUAGE menu, you can select the language of your Osmond device web interface. After language is selected, click [SAVE] to apply changes. English and Hungarian languages are currently available. 144/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 145 OSMOND User Manual 2.1.4. UI COLORS In the UI COLORS menu, the color theme of the user interface can be customized. The selected theme can be viewed by clicking on the [PREVIEW] button. After color theme is selected, click on the [SAVE] button to preserve the changes.
  • Page 146 OSMOND User Manual 2.1.5. ENGINES AND LICENSES The ENGINES AND LICENSES menu is designed to manage OCR engines and software licenses on the Osmond device. The selected OCR engine defines: what data can be extracted if authentication feature is available...
  • Page 147 OSMOND User Manual For availability and more information on OCR engines and software licenses, please contact your ADAPTIVE RECOGNITION sales representative. For more information on uploading OCR engines, see OCR Engine Management appendix. For more information and detail on the Passport Reader licenses and license handling, see License Management appendix.
  • Page 148 OSMOND User Manual 2.1.6. RESULT UPLOAD The Osmond supports numerous saving options and communication protocols for uploading document images and data to remote targets. Configuration of each protocol can be performed in this menu. For setting up communication protocols, please contact your IT department or system integrator.
  • Page 149 OSMOND User Manual The Osmond built-in storage offers a feature to save scanned information to the device directly. In order to configure this function, click on [Edit] in the line of the local_database, then just select "local_1", "local_2" or "local_3"...
  • Page 150 The device attempts to upload the data at specified intervals, if the Upload frequency field is defined. The Enable partial upload function is currently not supported for Osmond devices. The device sends the configuration file version in WS header if the box of the Send the version number of the loaded configuration is ticked.
  • Page 151 OSMOND User Manual − WSS (WebSocket Secure) The WSS protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of WSS. Host, Port and Access directory can be set in the corresponding text fields by simply typing the desired addresses.
  • Page 152 Upload frequency field is defined. The Enable partial upload function is currently not supported for Osmond devices. The device sends the configuration file version in WSS header if the box of the Send the version number of the loaded configuration is ticked.
  • Page 153 OSMOND User Manual − FTP (File Transfer Protocol) The FTP protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of FTP. Host and Port can be set in the corresponding text fields by simply typing the desired values.
  • Page 154 OSMOND User Manual − SFTP (SSH File Transfer Protocol) The SFTP protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of SFTP. Host and Port can be set in the corresponding text fields by simply typing the desired values.
  • Page 155 OSMOND User Manual − FTPS (FTP over SSL) The FTPS protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of FTPS. Host and Port can be set in the corresponding text fields by simply typing the desired values.
  • Page 156 OSMOND User Manual You can specify the name of the folder accessible from the server’s root directory with the Remote directory field. Enter the number of the Reconnect attempts in order to set the maximum number of the connections without error message. The device attempts to upload the data at specified intervals, if the Upload frequency field is defined.
  • Page 157 OSMOND User Manual − SMTP (Simple Mail Transfer Protocol) The SMTP protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of SMTP. Select a service from the Set SMTP defaults list.
  • Page 158 OSMOND User Manual − SMB (Server Message Block) The SMB protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of SMB. Host can be set in the corresponding text field by simply typing the desired value.
  • Page 159 OSMOND User Manual − WebDAV (Web Distributed Authoring and Versioning) The WebDAV protocol can be customized on the EDIT RESULT-UPLOAD window appearing by clicking on the [Edit] button in the line of WebDAV. Host, Port and Access directory can be set in the corresponding text fields by simply typing the desired values.
  • Page 160 OSMOND User Manual Besides uploading data to remote hosts, the Osmond also supports sending automatic e-mail notifications on scanned documents. Just fill standard e-mail parameters configure SMTP settings ADMINISTRATION / RESULT UPLOAD / SMTP menu as well as make sure to enable the...

  • Page 161: Log Upload

    OSMOND User Manual 2.1.7. LOG UPLOAD The LOG UPLOAD menu is designed to upload operation log files to remote log servers. The LOG UPLOAD menu can be configured by entering the parameters of one of the following protocols: • SFTP •...
  • Page 162 OSMOND User Manual ARCHIVE LOG UPLOAD When rotating the log file, this mode uploads the log file and the system starts a new one. There is a system level logrotate which is performed every day at 00:00. At this time the syslog is saved as zip file, which is automatic.
  • Page 163 IP address or FQDN field can be set in the corresponding text field by typing the required value. To the Port field enter the number of the port where the log server is waiting for the data. The Osmond requires certificates for secure connection. Upload the: •...
  • Page 164 OSMOND User Manual Enter the Log server common name into the Central LogServer CERTIFICATION CN-name field. This is an optional field. In case of specifying it, the connection is only established when the server corresponds to this. The identification is performed based on the CN-name.
  • Page 165 OSMOND User Manual 2.1.8. DATABASE UPLOAD In case of storing the reading in local database, the upload of the stored database can be set by defining the parameters of one of the following protocols: • SFTP • FTPS • •...

  • Page 166: Config Upload

    Setting the Configuration and Software Update on Osmond Device through Network chapter of the Osmond User Manual. The configuration values can be uploaded in j_on file format. The j_on extension configuration file is not JSON, because it consists of two concatenated JSON structure and contains notes. Its field names can be formatted from the names of the properties included in the table in such way that the name-sections separated by slash symbols (/) give the levels of the JSON structure.
  • Page 167 OSMOND User Manual J_on file structure and formal requirements: Each block begins with a comment depending on which table you want to insert it into. These can be (without quotation marks): • "//Properties" • "//Doc_fields" After that, the aforementioned values follow per blocks separated by comma in square brackets ([…]).
  • Page 168 OSMOND User Manual Currently supported values: • UpdateServerMain/update_time • UpdateServer/1/host: • UpdateServer/1/remote_directory • UpdateServer/1/protocol • UpdateServer/1/password • ResultUpload/WSS/access_directory • ResultUpload/WSS/host • ResultUpload/WSS/authority/RawData • ResultUpload/WSS/authority/UploadName • ResultUpload/WSS/certificate/RawData • ResultUpload/WSS/certificate/UploadName • ResultUpload/WSS/private_key/RawData • ResultUpload/WSS/private_key/UploadName • ResultUpload/WSS/reconnect_attempts • ResultUpload/WSS/upload_frequency • UpdateServer/1/username • LogUpload/ipAddress •...
  • Page 169 OSMOND User Manual For remote device management, the upload of the J_on configuration file can be set by defining the parameters of one of the following protocols: • SFTP • FTPS • • WebDav Only those protocols can be selected from the list, that have the following parameters specified: •...

  • Page 170: Update Server

    Upon clicking Edit, you may specify access details to the remote server. By default, it is configured to ADAPTIVE RECOGNITION update server. The Osmond device searches for updates at every start up. If new firmware or configuration file is available, it is downloaded automatically. Depending on the update, the device is either restarted automatically after software download or not.
  • Page 171 OSMOND User Manual The update process is marked by a cogwheel icon with a progress bar on the device display: When the installation of the new software is finished, a cogwheel with the tick is displayed: If updating fails for any reason, that is also signaled on the device display: Username and Password protection is not yet supported for update servers.

  • Page 172: Network

    In this menu, you can inspect the Hostname and MAC address. You can also change Netmask, DNS IP as well as IP addresses of the Osmond device. In special cases MTU field can be specified. Network parameters can be modified by users with owner or network admin privileges.

  • Page 173: Web Server

    HTTPS certificate for accessing the web interface of the device The Osmond device requires SSL certificate for HTTPS connection. This certificate should be uploaded in the NETWORK / WEB SERVER menu (using the Upload HTTPS certificate button) and must have .pem format that includes both the public certificate and the private key.
  • Page 174 For successful HTTPS connection, the rootCA of the uploaded certificate must be added to the browser trusted publishers list. For more information on the steps of establishing HTTPS connection, see Using HTTPS Protocol with Osmond Devices chapter. 174/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 175 OSMOND User Manual 2.2.3. PROXY When uploading any image or data to a remote server, there might be a need to configure a proxy server − if such server is used to establish connection between the device and the target network then...

  • Page 176: Application

    2.3. APPLICATION 2.3.1. START APP The Osmond device includes a built-in application to scan document images, perform OCR and authentication, read barcodes and RFID chip information and to send the results to a specific target. In Interactive scan mode (see MAIN CONFIGURATION) just click [SCAN] to scan &...

  • Page 177: Summary Section

    The icons appearing on the OLED display indicate the status of the reading process regardless of the scanning mode. For more details on the display icons and their meanings OLED Display Status Icons of Osmond Network Devices appendix. Acquired information from a document scan is organized into different sections, based on the content of the read data.
  • Page 178 OSMOND User Manual Colored frame appears around the first two images located on the right side (below in mobile view) if Face Compare has taken place (between the visually detected and stored in the RFID chip). color frame alters according...
  • Page 179 2. IMG SECTION Here inspect scanned document under different illuminations. The available lights depend on your Osmond model as well as on the configuration set under the SCAN PROCESS / LIGHT SETTINGS menu. Only those image types seen which have...
  • Page 180 OSMOND User Manual 3. OCR DATA In the OCR DATA section, the processed MRZ and VIZ data can be examined. The OCR DATA section shows data fields that are configured in the EDIT APP / FIELD SETUP menu. 180/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 181 OSMOND User Manual 4. MRZ DATA If the scanned document has printed MRZ lines, those are displayed in this section. 5. RFID DATA In the RFID DATA section, data read from the RFID chip of the document is displayed. These data include segmented MRZ line information (DG1 in ePassports) as well as RFID face image (DG2 in ePassports).
  • Page 182 OSMOND User Manual 6. BARCODE If you scan a document with barcode on it, image of the barcode and its decoded data are displayed in this section. Make sure to configure which barcodes would you like to read in the SCAN PROCESS / BARCODE SETTINGS menu before scanning a document with barcodes.
  • Page 183 OSMOND User Manual 2.3.2. EDIT APP In order to meet different user requirements, the reader Application can be fully customized using the EDIT APP option. The interface of the document reader device is divided into sections. At every section it is possible to perform the following settings: •...
  • Page 184 OSMOND User Manual Starting with the header of the Application (Show logo, Show text and CHANGE LOGO options), each section can be customized in the following aspects: SECTION: If selected, the section is present in the Application. OPEN: If selected, the Application shows the contents of the section by default.
  • Page 185 OSMOND User Manual Using the FIELD SETUP menu, all data appearing in the application can be customized. Every field can be displayed in the APP Summary (Show in Summary), RFID (Show in RFID) and OCR (Show in OCR) sections. When selecting multiple fields for the same APP section, use the icon to select all fields in the same column or line.

  • Page 186: Config Backup

    OSMOND User Manual 2.3.3. CONFIG BACKUP In the CONFIG BACKUP menu, the configuration schemes relating to the reading interface can be saved and reloaded as well. In order to save a backup file, first, under the Saved name field, select a new or a former backup option.
  • Page 187 2.3.4. HISTORY The Osmond device is equipped with internal storage space to save images and data of scanned documents. This feature can be activated by selecting the "local database" option in the ADMINISTRATION / RESULT UPLOAD menu and together with zip format (PACKAGE FORMAT menu).
  • Page 188 OSMOND User Manual Besides document fields like Surname, Given names, Period, Type, Nationality Date of birth, advanced searches can also be performed to list documents according to the following criteria: Documents with OCR error Documents with security issue Documents belonging to male and female bearers...

  • Page 189: File Upload

    OSMOND User Manual 2.3.5. FILE UPLOAD The Osmond device provides support to upload and process document packages that have been created earlier, using zip format (SCAN PROCESS / PACKAGE FORMAT). The zip format includes document images, OCR-, and RFID data as well.
  • Page 190 2.3.6. LIST QUEUE The Osmond device uses upload queue for uploading documents into remote servers. Using such queue, it is not necessary to wait for a document until it is uploaded but the next scanning process can be started immediately.

  • Page 191: Scan Process

    Appendix. - When Autonomous mode is selected, reading of a document is automatic, based on the built-in motion detection feature of Osmond. See reading phase icon description in Appendix. - Switch on/off automatic Document cropping and rotation and Face comparison.
  • Page 192 OSMOND User Manual - Logging should be used for troubleshooting purposes involving ADAPTIVE RECOGNITION support team. The value of the Log level consists of 2 digits: 1. value: 0-2 This is the log level of the interface and the operation of the webserver and modules behind it.
  • Page 193 OSMOND User Manual 2. NUMBER OF PAGES TO SCAN The NUMBER OF PAGES TO SCAN option specifies the number of pages to be scanned from the same document. - The Default value must be specified. If the document size cannot be determined, upon using the Auto by document size mode, the Default value will be applied.
  • Page 194 OSMOND User Manual In the case of documents with 2 pages you must choose the illumination types of the 2 page too. If the reading process is interrupted then the scanning will go on with reading the first page when returning to the reading process – regardless of the scanning mode.
  • Page 195 OSMOND User Manual 3. PACKAGE UPLOAD OPTIONS - By using the Auto mode at AutoSend, every scanned document is automatically uploaded via the protocol selected at Communication type, in a format selected at Package Type. If Approve mode is selected, document is uploaded only upon user confirmation, by clicking on the [Approve] button, at the bottom of the App.
  • Page 196 OSMOND User Manual 4. SITE OPTIONS Users can also change the Site title of Osmond web interface website in browsers. The text displayed in the header of the browser can be customized in the Site title field, if the application is on the reading interface (START APP menu). In case of other menu items, the displayed address can be specified in NETWORK / LAN.
  • Page 197 OSMOND User Manual 2.4.2. SCAN LIGHT In the SCAN LIGHT menu, users can select the illumination types of the image capturing process. Only those image types seen which have been enabled APPLICATION / EDIT APP / Img Section menu and the corresponding illumination type has been selected in the SCAN PROCESS / SCAN LIGHT menu.

  • Page 198: Image Types

    OSMOND User Manual IMAGE TYPES: • WHITE: visible white illumination (with reflection removal) Enable/Disable WHITE illumination by right-clicking on its button. An image scanned in white light is a simple photo of the document – as it can be seen by the human eye.
  • Page 199 OSMOND User Manual • UV: ultraviolet (UV-A) illumination Enable/Disable UV illumination by right-clicking on its button. Images scanned in ultraviolet illumination can be used to check authenticity features (graphics and text printed with special fluorescent ink) which are only visible under UV light. These authenticity features can be observed by viewing the UV image or the UV pattern (clean UV) image.
  • Page 200 OSMOND User Manual • PHOTO The Photo light is only available for Osmond USB models manufactured from December 2022. Enable/Disable the PHOTO light by right-clicking on its button. Photo light is optimized for scanning photos with very high image details and color accuracy.
  • Page 201 OSMOND User Manual • EDGE Enable/Disable EDGE light by right-clicking on its button. When using Edge light, the document is illuminated at a flat angle in order to make the protruding objects located on the document cast a shadow. 201/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 202 OSMOND User Manual The Flip timeout value specifies a time interval between capturing two sides of the same document. If the time specified here is up before entering the second page of a document, then scanning is performed automatically. This feature is designed to avoid endless waiting if second page of a document is not scanned for some reason.
  • Page 203 OSMOND User Manual 2.4.3. OCR SETTINGS Using the OCR SETTINGS menu, users can configure which OCR engine is used for scanning the and the 2 page (front side & back side) of the document. For more information on OCR engines, please contact our technical support team.

  • Page 204: Barcode Settings

    OSMOND User Manual 2.4.4. BARCODE SETTINGS In the BARCODE SETTINGS menu, users can also specify which barcode types should be searched for on the first and second pages of the scanned documents. Just click on [Edit] to customize the settings of the 1. page, 2. page or both (Default:).

  • Page 205: Rfid Settings

    OSMOND User Manual 2.4.5. RFID SETTINGS In the RFID SETTINGS menu, users can - Select the RFID scanning mode (Off/Default/Advanced) - Select which RFID authentication should be performed (PA, AA, CA, TA) - Which RFID files should be read from eDocuments (DG1…DG16)
  • Page 206 OSMOND User Manual 2.4.6. DISPLAY The DISPLAY menu lists the device statuses displayed on the OLED screen. For the various device states, the App can display an image, a text or blank screen which can be checked and viewed in this menu.
  • Page 207 OSMOND User Manual 2.4.7. CLIPBOARD COPY The CLIPBOARD COPY feature is designed to copy OCR-ed fields to the clipboard automatically, after scanning a document. This function can be customized for different document types: Upon clicking [Edit], the feature can be activated by selecting the Enable clipboard copy option and the document fields to be copied to clipboard can be selected (Basic field –...

  • Page 208: Package Format

    The Osmond device can upload images and data to remote targets packed into different formats: • The Osmond-specific zip includes images, OCR-, and RFID data as well, packed into a single zip file. This kind of package can also be uploaded to the Application and displayed like results of any live scan.
  • Page 209 OSMOND User Manual 2.4.9. PDF TEMPLATE In the PDF TEMPLATE menu, you can upload your customized PDF template file. The template defines the appearance of the file containing OCR, RFID data as well as document images packed into PDF package format.
  • Page 210 OSMOND User Manual 2.4.10. QUEUE OPTIONS In this menu, owners may configure different queue settings. The Minimum available disc space option specifies a minimal amount of free space that should always be present on the device. If this limit is hit for any reason, it may have effect on queue sizes.
  • Page 211 OSMOND User Manual The Maximum number of items specifies that how many documents can be waiting for uploading at the same time. In order to delete all these documents, use the Delete all deferred uploads option. For any documents failed to upload, owners may limit the number of such items (Maximum number of unsuccessful items) and can also delete all of them permanently by using the Delete all unsuccessful uploads option.
  • Page 212 OSMOND User Manual 2.4.11. GX PROPERTY GX PROPERTY menu is designed to customize certain properties, which belong to one of the following categories: 1. Barcode 2. Capture 3. Document 4. RFID 5. Result 6. MotDet 7. Image Cropping In the followings section these properties will be listed and explained.
  • Page 213 OSMOND User Manual 1. Barcode - barcode/contrast • Value type: Float • Default value: 1.5 min: -3.0 max: 10.0 • Description: Barcode reading fine-tuning. Usable for barcodes with poor printing quality. Possible settings: -2: Automatic adaptation for barcode quality. Recommended if the same type and quality of barcodes are read.
  • Page 214 OSMOND User Manual 2. Capture - ctrl/always_gray • Value type: Boolean • Default value: 0 • Description: If 1, it provides gray output images. Recommended for time critical applications. - ctrl/white/capture_style • Value type: Integer • Default value: 899 - ctrl/infra/capture_style •...
  • Page 215 OSMOND User Manual 3. Document - document/tip_century • Value type: Integer • Default value: 0 min: 0 max: 1 • Description: It has effect on dates that do not contain the century, the algorithm tries to figure it out from the year and current date.
  • Page 216 OSMOND User Manual 4. RFID - rfid/air_speed • Value type: Integer • Default value: 848 min: 106 max: 848 • Description: Speed of communication with the RFID chip (106, 212, 424, 848). - rfid/pref_ext_ds • Value type: Integer • Default value: 0...
  • Page 217 OSMOND User Manual 5. Result - save_cleanovd • Value type: Boolean • Default value: 0 • Description: Black OVD image is saved in the ZIP file. - save_cleanuv • Value type: Boolean • Default value: 0 • Description: Enhanced UV image is saved in the ZIP file.
  • Page 218 OSMOND User Manual 7. Image Cropping - docrect/algorithm • Value type: Integer • Default value: 0 min: 0 max: 2 • Description: It configures the document cropping algorithm. Possible settings: 0 – Standard algorithm 1 – OCR engine-specific algorithm 2 – First use the standard algorithm, then – if the first was unsuccessful – the OCR engine-specific one.

  • Page 219: Maintenance

    2.5.1. SYSTEM INFORMATION The Osmond N is equipped with a built-in OS (no other installation is needed). Current status of different elements of this PC can be observed here. Under SYSTEM INFORMATION among others, you can check or perform the following: •...
  • Page 220 OSMOND User Manual • Create logpack and operation log under SYSTEM INFORMATION / LOG MANAGEMENT. The following description of LOG MANAGEMENT is valid from version 1.8.x. These functions are available from 1.8.x version. The log files, mainly used for troubleshooting, can be downloaded in the LOG MANAGEMENT section.

  • Page 221: Operating Mode

    OSMOND User Manual 2.5.2. OPERATING MODE In the OPERATING MODE menu select one of the following options which meets the requirements: • NWI (Network Web Interface): Using the device with web browser. This is the default mode, when logging in to the web interface.
  • Page 222 OSMOND User Manual 2.5.3. UPDATE The purpose of the UPDATE menu is to provide an easy-to-use device firmware update feature for users with Owner privileges. Update files can be browsed and uploaded after clicking on the corresponding buttons. The device updates are available and can be downloaded from the ADAPTIVE RECOGNITION website.
  • Page 223 (in most Windows and Linux browsers: Ctrl + F5 keyboard shortcut), because the features in the new firmware may not be appeared on the interface. Osmond N devices can be updated with MSI installer as well. For more information on firmware installation with MSI, see the Firmware Installation for Osmond with Updater MSI chapter.

  • Page 224: Quit

    OSMOND User Manual 2.5.4. BACKUP The BACKUP option is designed to offer a feature to save all device settings and to load it back in the future, at any time. Backup option helps to avoid data loss upon any mayor software or hardware damage.

  • Page 225: Maintenance

    CLEANING THE DEVICE ADAPTIVE RECOGNITION document reader devices generally do not need any kind of special maintenance; however, they should be regularly cleaned in order to ensure that they are fully operational and are able to extract data from the IDs properly.
  • Page 226 OSMOND User Manual 1.1.1. DISINFECTION Isopropyl alcohol (70%) can be used to safely clean and disinfect the surface of the document reader devices, both the scanning window glass and plastic parts. For the exact concentration of isopropyl alcohol which is sufficient to eliminate COVID19, please consult WHO and other trusted sources.

  • Page 227: Appendix

    CORRECT DOCUMENT PLACEMENT The following section provides a short guide on how different types of documents should be placed on the scanning surface of the Osmond device in order to acquire the best OCR and authorization results. In case of ID1 and ID2 size cards (like national ID cards, driver licenses, EHIC – European Health Insurance Card, name/business cards or any other 86x54mm = 3.4"x2.1"...
  • Page 228 OSMOND User Manual In case of passports, place them horizontally in the upper left corner of the scanning surface according to the following images. In case of contact smart cards with chip, use the smart card slot on the side of the device according to the following image.

  • Page 229: Oled Display Status Icons

    OLED DISPLAY STATUS ICONS 2.1. OLED DISPLAY STATUS ICONS OF OSMOND NETWORK DEVICES Unlike previous document scanner models, the Osmond device is equipped with OLED display. This screen is able to display the following status icons on Osmond network devices.
  • Page 230 OSMOND User Manual The data package upload is started. Starting data upload The data package upload is successfully done. Upload done The upload is failed or the documents in Upload error / unsuccessful status have reached the maximum Unsuccessful queue is full number of the unsuccessful queue.

  • Page 231: Oled Display Status Icons Of Osmond Usb Devices

    OSMOND User Manual 2.2. OLED DISPLAY STATUS ICONS OF OSMOND USB DEVICES Unlike previous document scanner models, the Osmond device is equipped with OLED display. This screen is able to display the following status icons on Osmond USB devices. DISPLAY ICON...
  • Page 232 OSMOND User Manual If you see the "Update error" icon during the update process, this indicates that the update has failed for some reason. In this case, the device automatically rollbacks to the original firmware version. 232/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...

  • Page 233: Web Interface Reading Phases - Icon Description

    OSMOND User Manual WEB INTERFACE READING PHASES – ICON DESCRIPTION 3.1. ICONS OF THE READING PHASES IN INTERACTIVE MODE • Arrow icon: the SCAN button is clickable, by clicking on it the reading process begins • Card icon: the document reading is in progress •...

  • Page 234: Removing The Osmond Document Holder

    OSMOND User Manual REMOVING THE OSMOND DOCUMENT HOLDER The Osmond device is designed with a removable document holder built in the shield. Document holder under the shield This feature can be vital in special cases e.g., scanning extremely thick documents which cannot fit to the device due to their size being incompatible with the document holder.
  • Page 235 OSMOND User Manual The process is simple and easy to perform in which the following steps will guide the user: 1. Hold firmly the document holder and carefully pull it towards the front side of the device (OLED display, ON/OFF touch button) to remove it.
  • Page 236 OSMOND User Manual 3. Gently push the blind plug into the slot of the document holder. 4. If the document holder is to be put back to the device later on, then the blind plug can be removed by using a long and flat screwdriver.

  • Page 237: Oled Standby Mode

    OSMOND User Manual OLED STANDBY MODE In order to protect the lifetime of the OLED display, the OLED screen enters idle mode. The OLED display switches to standby state after 15 minutes of inactivity. The blinking green LED with the black OLED screen indicates this state.
  • Page 238 OSMOND User Manual 2. In the Full Page Reader application: This method is currently available only in USB mode. In the Full Page Reader application navigate to the OPTIONS / MANUAL SETTINGS tab, and type "ctrl/screen_standby" (without apostrophes) into the "PROPERTY NAME" field and specify any decimal value as "PROPERTY VALUE".
  • Page 239 OSMOND User Manual 3. In the gxsd.dat file: This method is currently available only in USB mode. In the gxsd.dat file, add the following: <ctrl> <screen_standby value="X"/> </ctrl> This is to be pasted anywhere into the <pr> section. The value "X" must be a decimal value in seconds.

  • Page 240: Shutdown Process

    OSMOND User Manual SHUTDOWN PROCESS To turn off the device, perform the following steps: 1. Press and hold the power touch button until the shutdown process starts. Hold the power touch button for another 5 seconds. The progress bar on the OLED screen shows the remaining time.

  • Page 241: Devices Capable Of Dual Operational Mode

    OSMOND User Manual DEVICES CAPABLE OF DUAL OPERATIONAL MODE Osmond N model is able to operate in both USB and Network mode. On this device you can easily switch between modes by using a small utility tool called PRDTool. PRDTool is part of the PR software packages from version 2.1.9.1 and above, so in order to use it you...

  • Page 242: License Management

    OSMOND User Manual LICENSE MANAGEMENT This short description will guide you through the steps of uploading ADAPTIVE RECOGNITION Passport Reader licenses to your document reader device. In case of a new order, license upload is required only when the ordered software license was supplied separately (not pre-installed on the scanner).
  • Page 243 In addition, license upload to one or more network devices can be performed in USB mode as well by using the License Manager application. Thereby, when operating the Osmond N in USB mode, there is no need to change the operation mode of the device. •...

  • Page 244: License Upload Using License Manager

    OSMOND User Manual 8.1. LICENSE UPLOAD USING LICENSE MANAGER The License Manager application is designed to upload ADAPTIVE RECOGNITION passport reader license files to a specific document reader device. 8.1.1. INSTALLATION The application gets automatically installed by installing Passport Reader version 2.1.7. and above versions.
  • Page 245 OSMOND User Manual 3. Select the license(s) to upload to your device. In order to select more licenses at the same time, use Ctrl + left click. In order to select all the licenses at the same time, use the Ctrl + A keyboard shortcut.
  • Page 246 OSMOND User Manual 4. Click "Upload licenses" to copy the selected license(s) to your device and check their presence in the "Licenses" textbox. Enable "Auto summary after upload" to have an instant pop-up feedback after successful upload. 246/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 247 OSMOND User Manual 5. Click on "Save changes" and exit the application. Enable "Auto save after upload" to skip using "Save changes" after each license upload. 247/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore...

  • Page 248: Automated Ways For License Upload

    2. Move the license files to ProgramData\GX\pr folder. 3. Once that is completed, upload will be performed automatically, by the UseDevice() function. In practice, it happens when the scanner is started by either ADAPTIVE RECOGNITION Full Page Reader or any end user application.

  • Page 249: License Upload Via Web Interface

    This functionality is only available for Osmond N in network mode. 1. First you need to sign in on the web interface of the Osmond N reader. In order to access the web interface of the Osmond N device, please follow the steps of the following chapter: Accessing the Web Interface of the Device from a Browser.
  • Page 250 OSMOND User Manual 4. When you have added the required license file, press F5 in order to refresh the page. Then, the uploaded license is listed under LICENSES. The system also sends a notification about the success or failure of the saving. Check the notification panel by clicking on the notification icon displayed on the left side of the status bar located at the bottom of the screen.

  • Page 251: Viz Ocr And Viz Auth Ocr Engine Management

    OSMOND User Manual VIZ OCR AND VIZ AUTH OCR ENGINE MANAGEMENT This short description will guide you through the steps of uploading ADAPTIVE RECOGNITION Passport Reader engines to your document reader device. OCR engines are add-on modules of the Passport Reader software. They are required for reading and identifying the VIZ (Visual Inspection Zone) fields of the documents.
  • Page 252 In addition, OCR engine upload to one or more network devices can be performed in USB mode as well, with MSI installer. Thereby, when operating the Osmond N in USB mode, there is no need to change the operation mode of the device. For more information on this, see Uploading OCR Engines to USB Devices chapter.

  • Page 253: Uploading Ocr Engines To Usb Devices

    OSMOND User Manual 9.1. UPLOADING OCR ENGINES TO USB DEVICES Administrator rights are needed for installation. OCR engines are available and can be downloaded from the ADAPTIVE RECOGNITION website. 1. On the website click on Engines and click on the [Download] button belonging to the selected OCR engine (VIZ OCR or VIZ AUTH OCR).
  • Page 254 OSMOND User Manual 8. Accept the EULA (by ticking the checkbox) and start the custom installation process by clicking on [Next]. 9. In the Custom Setup window, select the modules to be installed according to your preferences. 254/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America...
  • Page 255 OSMOND User Manual 10. Select the bit version of the engine to be installed according to your system architecture. 255/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 256 OSMOND User Manual 11. Clicking on [Install] will begin installation. 256/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 257 OSMOND User Manual 12. Click [Finish] to complete the installation. 13. After finishing the installation, select the installed OCR engine in the Full Page Reader or Authentication Checker application. In case of Full Page Reader In case of Authentication Checker 257/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...

  • Page 258: Uploading Ocr Engines To Network Devices

    OSMOND User Manual 9.2. UPLOADING OCR ENGINES TO NETWORK DEVICES OCR engines are available and can be downloaded from the ADAPTIVE RECOGNITION website. 1. On the website click on Engines and click on the [Download] button belonging to the selected OCR engine (VIZ OCR or VIZ AUTH OCR).

  • Page 259: Direct Ethernet Connection

    OSMOND User Manual 10. DIRECT ETHERNET CONNECTION If you connect the device directly to the PC with an Ethernet cable, you can reach the device on its default IP 192.0.2.3, but you need to modify your Ethernet adapter settings manually.
  • Page 260 OSMOND User Manual 3. Select "Use the Following IP address", and set: • 192.0.2.4 as "IP address" • 255.255.255.0 as "Subnet mask" • 192.0.2.1 as "Default gateway" 4. Click on [OK] to apply changes. 260/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 261: Using Https Protocol With Osmond Devices

    11. USING HTTPS PROTOCOL WITH OSMOND DEVICES The following procedure details the steps of establishing secure HTTP connection (HTTPS) when using the Osmond device web interface. The main focus of the method described below is to avoid using certificates from any third-party publisher for such purpose.
  • Page 262 "/CN=devicename.subdomain.company.hu/C=HU/ST=Budapest/L=Budapest/O =CompanyShortName" "devicename" is the hostname of your device. The hostname of your device is OSMOND-N{serialnumber }, e.g., OSMOND-N204109. serial number of your device is printed to the sticker located at the bottom of your scanner. Type the serial number without the very first character.
  • Page 263 OSMOND User Manual 1.2.3 Creating the HTTPS certificate The HTTPS certificate can be created by simply copying the device key and cert files together, as follows: - Linux: cat devicename.crt devicename.key > devicename.ssl.cert - Windows: devicename.crt devicename.key Get-Content | Set-Content devicename.ssl.cert...
  • Page 264 2.1 Uploading certificate and activating HTTPS via Osmond web interface HTTPS can be activated and HTTPS cert can be uploaded via the NETWORK / WEB SERVER menu of the Osmond device web interface. For more information, please refer to the SERVER chapter of the Osmond User Manual.
  • Page 265 OSMOND User Manual 3. Browser settings In order to establish secure connection to Osmond device web interface via web browser, the root CA must be imported to browser so the device cert. can be trusted. The following steps should be performed once for any browser: 3.1 Firefox...

  • Page 266: Installation Of The Ssl Certificate

    OSMOND User Manual 12. INSTALLATION OF THE SSL CERTIFICATE In this section the installation of the SSL certificate on Windows and Linux operating systems will be discussed. The acquisition of the SSL certificate will not be detailed, but a website will be linked. By...
  • Page 267 OSMOND User Manual 4. In the appearing window: - Enter the filename and the path of the certificate to the Certificate file (.pfx) field. Alternatively, browse the certificate file by clicking on the […] button. • The file format must be .pfx. If the file has a different format, convert it to .pfx by using OpenSSL (or other utility program).

  • Page 268: Installing The Ssl Certificate On Ubuntu

    OSMOND User Manual 12.2. INSTALLING THE SSL CERTIFICATE ON UBUNTU The following commands apply to Ubuntu 22.04. However, the SSL certificate can be installed to other Linux versions with similar commands as well. The commands can be issued from a terminal.
  • Page 269 OSMOND User Manual 6. Copy the cert and the key files to the OpenSSL library: sudo cp cert1.pem /etc/ssl/certs sudo cp privkey1.pem /etc/ssl/private 7. Set the rights: sudo chmod /etc/ssl/certs/cert1.pem sudo chown root:ssl-cert /etc/ssl/private/privkey1.pem sudo chmod /etc/ssl/private/privkey1.pem 8. Add the user to the SSL cert group in order to read the private keys:...

  • Page 270: Querying The Intermediate Certificate

    OSMOND User Manual 12.3. QUERYING THE INTERMEDIATE CERTIFICATE The two files mentioned before, can contain all keys (public, private) and certificates (root, intermediate, server). 1. The server – e.g., Apache2 server – can be tested with the following command: openssl...

  • Page 271: Merging The Intermediate And The Server Certificates

    OSMOND User Manual 6. The created certificate must be converted to PEM format: intermediate.crt openssl x509 -inform DER intermediate.crt -out intermediate.pem -text 7. The resulting file must be copy to the server. If the file is already on the intermediate.pem...

  • Page 272: Setting The Ws Protocol On Osmond

    OSMOND User Manual 13. SETTING THE WS PROTOCOL ON OSMOND The current version (1.8) of the Osmond firmware is capable of uploading the scanned data to a server via multiple protocols. In this section the settings of the WebSocket (WS) protocol will be explained.

  • Page 273: Installing And Setting The Ws Server On Windows 10

    OSMOND User Manual 13.2. INSTALLING AND SETTING THE WS SERVER ON WINDOWS 10 13.2.1. INSTALLING RUBY 1. Download and install Ruby 3 or newer version with Devkit (currently Ruby+Devkit 3.1.2-1 (x64) can be accessed): - Navigate to https://rubyinstaller.org/downloads/. - Select "Add Ruby executables to your PATH" and "Associate .rb and .rbw files with this Ruby installation"...
  • Page 274 OSMOND User Manual - Select "Ruby RI and HTML documentation" and "MSYS2 and MINGW development toolchain" by ticking the checkboxes. - After the installation is finished, run "ridk install" too by selecting the "Run 'ridk install' to set up MSYS2 and development toolchain." option.
  • Page 275 OSMOND User Manual - In the appearing terminal select "3 – MSYS2 and MINGW development toolchain" by typing 3 and then pressing the [Enter] key. - After it is executed, press [Enter]. 2. Restart the PC. 3. Open Command Prompt. Command Prompt can be accessed by entering "cmd" text to the search bar at Start menu and clicking on the appearing Command Prompt line.
  • Page 276 OSMOND User Manual 13.2.2. INSTALLING THE RUBY WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir C:\ws_share 2. Create a library where the WS server files are to be copied. For example, use the following...
  • Page 277 OSMOND User Manual 7. If a window pops up indicating that Firewall has blocked Ruby, click on the [Allow access] button on this window. Thereby Ruby interpreter can accept the incoming connections. 8. In order to stop the server, use the Ctrl + C keyboard shortcut or simply close the terminal.

  • Page 278: Installing Python

    OSMOND User Manual 13.2.3. INSTALLING PYTHON 1. Download and install Python 3 or newer version (currently Python 3.11.3 can be accessed): - Navigate to https://www.python.org/downloads/. - Select "Use admin privileges when installing py.exe" and "Add python.exe to PATH" by ticking the checkboxes.
  • Page 279 OSMOND User Manual 13.2.4. INSTALLING THE PYTHON WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir C:\ws_share 2. Create a library where the WS server files are to be copied. For example, use the following...
  • Page 280 OSMOND User Manual 7. If a window pops up indicating that Firewall has blocked Python, click on the [Allow access] button on this window. Thereby Python interpreter can accept the incoming connections. 8. In order to stop the server, use the Ctrl + C keyboard shortcut or simply close the terminal.

  • Page 281: Installing Java

    OSMOND User Manual 13.2.5. INSTALLING JAVA In the following section the installation of OpenJDK will be described. For running the WS server, any version of Java can be used. The testing on Windows has been performed with the version 18 of OpenJDK.
  • Page 282 OSMOND User Manual − Right click on it, then in the appearing quick menu select "Copy". − Then, navigate to the C:\Program Files\ library. − Right click on a neutral area, then select New / Folder menu item from the pop-up quick menu.
  • Page 283 OSMOND User Manual − After decompression, copy to clipboard the path of the Java directory: • Double click on the created directory (e.g., named jdk-18) to enter the holder. • Click on a neutral area of the address bar of the File Explorer (e.g., to the right of the path of the folder).
  • Page 284 OSMOND User Manual 7. In the pop-up window under System variables select the Path variable. Then, click on the [Edit…] button. 8. In the appearing window click on the [New] button. 9. Paste the path copied to clipboard into a new row. Complete the copied path with the \bin...
  • Page 285 OSMOND User Manual 16. Check if the installation is properly performed: − Open Command Prompt. Command Prompt can be accessed by entering "cmd" text to the search bar at Start menu and pressing [Enter]. − In the Command Prompt enter the following command: java -version −...
  • Page 286 OSMOND User Manual 13.2.6. INSTALLING THE JAVA WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir C:\ws_share 2. Create a library where the WS server files are to be copied. For example, use the following...
  • Page 287 OSMOND User Manual 7. If a window pops up indicating that Firewall has blocked Java, click on the [Allow access] button on this window. Thereby Java interpreter can accept the incoming connections. 8. In order to stop the WS server, use the Ctrl + C keyboard shortcut or type "exit" in the running terminal.

  • Page 288: Installing And Setting The Ws Server On Linux

    OSMOND User Manual 13.3. INSTALLING AND SETTING THE WS SERVER ON LINUX 13.3.1. INSTALLING RUBY Under Linux install Ruby from command line. The commands may depend on the distribution. The following commands apply to Ubuntu 22.04. 1. Update Ubuntu: sudo apt...
  • Page 289 OSMOND User Manual 13.3.2. INSTALLING RUBY WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir /home/tesztg/ws_share The user running the WS server, is the "tesztg" Therefore create the package directory in the home directory of this user.
  • Page 290 OSMOND User Manual 13.3.3. INSTALLING PYTHON Most Linux distributions, including Ubuntu 22.04, install one of the Python versions during its installation. In order to perform the following steps, open a terminal. 1. Before querying the version, it is recommended to update the operating system:...
  • Page 291 OSMOND User Manual 13.3.4. INSTALLING PYTHON WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir /home/tesztg/ws_share The user running the WS server, is the "tesztg" Therefore create the package directory in the home directory of this user.
  • Page 292 OSMOND User Manual 13.3.5. INSTALLING JAVA Most Linux distributions, including Ubuntu 22.04, install one of the Java versions during its installation. Ubuntu 22.04 currently contains the OpenJDK 11.0.17 by default. In order to perform the following steps, open a terminal.
  • Page 293 OSMOND User Manual 13.3.6. INSTALLING JAVA WS SERVER 1. Create a library which will receive the packages. For example, use the following command in the terminal: mkdir /home/tesztg/ws_share The user running the WS server, is the "tesztg" Therefore create the package directory in the home directory of this user.
  • Page 294 OSMOND User Manual 7. In order to stop the WS server, use the Ctrl + C keyboard shortcut or type "exit" in the running terminal. • The WS server may not shut down immediately. In this case the server throws an error message at the next startup: java.net.BindException: Address already in use...

  • Page 295: Setting On Osmond

    OSMOND User Manual 13.4. SETTING ON OSMOND The parameters of the WS protocol can be set on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 296 OSMOND User Manual 4. On the appearing menu set the following: - Host: IP address of the WS server, in this case: 192.168.1.2 - Port: Port of the WS server: 2080 Leave the other fields blank. 5. Check the correct settings are applied by clicking on the [TEST] button.
  • Page 297 OSMOND User Manual 7. Then, navigate to SCAN PROCESS / MAIN CONFIGURATION. In this menu item, under PACKAGE UPLOAD OPTIONS / Communication type select WS (WebSocket) protocol. 8. Then, click on the [SAVE] button. After performing these settings, the scanned documents are transferred to the upload server as a zip file.

  • Page 298: Annex

    OSMOND User Manual 13.5. ANNEX 13.5.1. WS_SERVER_RUBY.RB require 'websocket-eventmachine-server' require 'json' ws_port = (JSON.parse File.read "ws_server_ruby.json")["ws_port"].to_i upload_directory = File.expand_path (JSON.parse File.read "ws_server_ruby.json")["upload_directory"] puts "WS server started (Ruby)" puts "Upload directory: #{upload_directory}" EM.run file_name "" WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => ws_port) |ws| ws.onopen...
  • Page 299 OSMOND User Manual 13.5.3. WS_SERVER_PYTHON.PY #!/usr/bin/env python import asyncio import websockets import json import ws_server_ruby_json = json.loads(open("ws_server_python.json", "r").read()) ws_port = int(ws_server_ruby_json["ws_port"]) upload_directory = os.path.expanduser(ws_server_ruby_json["upload_directory"]) print("WS server started (Python)") print("Upload directory: ", upload_directory) async def echo(websocket): file_name = "" try: async for...
  • Page 300 OSMOND User Manual 13.5.5. WS_SERVER_JAVA.JAVA package org.example; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.net.InetSocketAddress; import java.net.UnknownHostException; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.util.Collections; import org.java_websocket.WebSocket; import org.java_websocket.drafts.Draft; import org.java_websocket.drafts.Draft_6455; import org.java_websocket.handshake.ClientHandshake; import org.java_websocket.server.WebSocketServer; import org.json.JSONObject;...
  • Page 301 OSMOND User Manual @Override public void onMessage(WebSocket conn, ByteBuffer message) { (file_name.length() > 0) { OutputStream f2 = FileOutputStream(upload_directory "/" file_name); f2.write(message.array()); f2.flush(); f2.close(); System.out.println("File was written into " file_name); catch (Exception ex) { System.out.println("Error: " ex.getMessage()); ex.printStackTrace(); System.exit(1); private static String expand_path(String basic_path) { (basic_path.startsWith("~"...
  • Page 302 OSMOND User Manual s.stop(10000); //System.exit(0); break; @Override public void onError(WebSocket conn, Exception ex) { ex.printStackTrace(); (conn != null) { @Override public void onStart() { System.out.println("Server started!"); setConnectionLostTimeout(0); setConnectionLostTimeout(100); 13.5.6. WS_SERVER_JAVA.JSON "ws_port": "2080", "upload_directory": "~/ws_share" 302/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 303: Sending The Settings

    OSMOND User Manual 13.5.7. THE STRUCTURE OF THE WS COMMUNICATION DATA CONTENT 1. SENDING THE SETTINGS In case of setting the "Config (j_on) file upload", the first upload sent at startup will be the configuration j_on file (it is not a JSON, however very similar). This is not a scanned data, but it is transferred in ZIP format.
  • Page 304 OSMOND User Manual 3. MESSAGES OF WHICH THE COMMUNICATION CONSISTS 1. Message TEXT message which can be of two types depending on the value of the "Send the version number of the loaded configuration?": • If it is enabled: "jsonrpc":"2.0", "method":"notify",...
  • Page 305 OSMOND User Manual 3. Message TEXT message which can be of two types depending on the value of the "Send the version number of the loaded configuration?": • If it is enabled: "jsonrpc":"2.0", "method":"notify", "params":{ "packageReady":"$remote_directory/$filename", "deviceName":"$deviceName", "serialNumber":"$serialNumber", "nwRelease":"$nwRelease", "configVersion":"$configVersion", "fileSent":"end_of_transmission"...
  • Page 306 OSMOND User Manual 5. EXAMPLES • When "Send the version number of the loaded configuration?" is disabled: 1. {"jsonrpc":"2.0","method":"notify","params":{"packageReady":"dir/OSMOND- N211786_2022-11-04T12.24.18Z_bcda358e.zip","deviceName":"OSMOND- N","serialNumber":"211786","nwRelease":"8-RC-2022-11-03"}} 2. binary-data. 3. {"jsonrpc":"2.0","method":"notify","params":{"packageReady":"dir/OSMOND- N211786_2022-11-04T12.24.18Z_bcda358e.zip","deviceName":"OSMOND- N","serialNumber":"211786","nwRelease":"8-RC-2022-11- 03","fileSent":"end_of_transmission"}} • When "Send the version number of the loaded configuration?" is enabled: 1.
  • Page 307 OSMOND User Manual 6.2. File names: • The structure of the read data file name: %READER_%YYYY-%mm-%ddT%HH.%MM.%SSZ_%RANDOMHEXANUMBER.zip OSMOND-N211786_2022-11-04T13.24.18Z_ad1131c0.zip • The structure of the configuration file name: config_%READER_%YYYY%mm%dd-%HH%MM%SS.zip config_OSMOND-N211786_20221104-123446.zip 307/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore...

  • Page 308: Setting The Ftp Protocol On Osmond

    OSMOND User Manual 14. SETTING THE FTP PROTOCOL ON OSMOND The current version (1.8) of the Osmond firmware is capable of uploading the scanned data to a server via multiple protocols. In this section the settings of the FTP protocol will be explained.

  • Page 309: Setting Ftp

    OSMOND User Manual 14.1.2. SETTING FTP 1. Create the library, for example: C:\ftp_share If the library is created with the user, with which the FTP is used – in this case "tesztg" – then there is no need to share it.
  • Page 310 OSMOND User Manual 6. In the appearing window specify the following parameters: - FTP site name: in this case ftp_probe - Physical path: in this case C:\ftp_share 7. Then, click on the [Next] button. 8. In the next window select "No SSL". Leave the rest of the settings as default: - IP address: "All Unassigned"...
  • Page 311 OSMOND User Manual 10. In the next window set the following values: - At Authentication select "Basic" - At Authorization / Allow access to select "Specified users". Under "Specified users" field, enter the username, in this case "tesztg" - At Authorization / Permissions select "Read" and "Write".
  • Page 312 OSMOND User Manual 14.1.3. SETTING THE FIREWALL It is recommended to check the Windows Firewall settings: 1. Navigate to Control Panel / System and Security / Windows Defender Firewall / Allow an app or feature through Windows Defender Firewall. 2. Enable "FTP server" under the appropriate network type by ticking the box.

  • Page 313: Installing And Setting The Ftp Server On Linux

    OSMOND User Manual 14.2. INSTALLING AND SETTING THE FTP SERVER ON LINUX 14.2.1. INSTALLING THE FTP SERVER Under Linux install FTP server from command line. The commands may depend on the distribution. The following commands apply to Ubuntu 22.04. 1. Update Ubuntu:...
  • Page 314 OSMOND User Manual 14.2.2. SETTING THE FTP 1. Open the file: /etc/vsftpd.conf sudo vim /etc/vsftpd.conf In the file: /etc/vsftpd.conf anonymous_enable=NO local_enable=YES write_enable=YES chroot_local_user=YES pasv_min_port=30000 pasv_max_port=31000 userlist_enable=YES userlist_file=/etc/vsftpd.user_list userlist_deny=NO allow_writeable_chroot=YES user_sub_token=$USER local_root=/home/$USER/ftp_share After setting, save the file and quit: In case of Vim text editor: Press the [Esc] key and use the :wq command.
  • Page 315 OSMOND User Manual 14.2.3. SETTING THE FIREWALL The ports used by FTP must be set in the firewall, then restart it, if the firewall is active. In general, the runs on Ubuntu. Its state can be queried with the command.

  • Page 316: Setting On Osmond

    OSMOND User Manual 14.3. SETTING ON OSMOND First, the parameters of the FTP protocol must be set on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 317 OSMOND User Manual 4. On the appearing menu set the following: - Host: IP address of the FTP server, in this case: 192.168.1.2 - Port: Port of the FTP server: 21 - Username: Name of the user, in this case: tesztg - Password: Password of the user, in this case: 123456 - Remote directory: Name of the folder accessible from the server’s root directory.
  • Page 318 OSMOND User Manual 7. Then, navigate to SCAN PROCESS / MAIN CONFIGURATION. In this menu item, under PACKAGE UPLOAD OPTIONS / Communication type select FTP (File Transfer Protocol) protocol. 8. Then, click on the [SAVE] button. After performing these settings, the scanned documents are transferred to the upload server as a zip file.

  • Page 319: Testing The Setup

    OSMOND User Manual 14.4. TESTING THE SETUP In case of error, the FTP server can be tested from command line with the following command: curl -T probe_file.txt ftp://tesztg:123456@192.168.1.2 where: is the name of the file which is to be uploaded. There is no format restriction, it probe_file.txt...

  • Page 320: Troubleshooting

    14.5.1. OSMOND If upload is not working, Osmond will collect the unsuccessful documents to the UNSUCCESSFUL queue until its limit is not reached. When UNSUCCESFUL limit is reached, the oldest element in queue is overwritten by the result of the latest scan. Documents in unsuccessful status can be checked in the APPLICATION / LIST QUEUE menu.
  • Page 321 OSMOND User Manual 14.5.2. LINUX If the FTP Daemon (vsftpd) is not running, its operation can be affected with the following commands: • Start the Daemon: sudo systemctl start vsftpd • Restart the Daemon: sudo systemctl restart vsftpd • Stop the Daemon:...

  • Page 322: Setting The Smb (Smb1) Protocol On Osmond

    OSMOND User Manual 15. SETTING THE SMB (SMB1) PROTOCOL ON OSMOND The current version (1.8) of the Osmond firmware uses the SMB1 protocol. By default, this protocol is disabled on the current Windows versions, but it is still available. In this section the settings of the SMB1 protocol will be explained.

  • Page 323: Setting Smb On Windows 10

    OSMOND User Manual 15.1. SETTING SMB ON WINDOWS 10 15.1.1. SHARING THE LIBRARY ON THE NETWORK 1. Create the library, for example: C:\smb_probashare 2. Right click on the library in the File Explorer, and from the appearing menu select "Properties".
  • Page 324 OSMOND User Manual 5. Enable "Share this folder" by ticking the box 6. Click on the [Permissions] button. 7. Then, click on the [Add…] button. 324/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...
  • Page 325 OSMOND User Manual 8. In the appearing window enter the name of the user on whose behalf the upload is performed. For example: tesztg 9. Click on the [Check Names] button to make sure the entered name is compatible. If the username cannot be found, then click on the [Locations…] button in order to select the location to search.
  • Page 326 OSMOND User Manual 11. Afterwards click the [Apply], then the [OK] buttons. 12. Click on the [OK] button again. 13. Then, click on the [Close] button. The shared library appears on the network and can be accessed through SMB2 or SMB3 protocols.

  • Page 327: Setting On Osmond

    OSMOND User Manual 15.2. SETTING ON OSMOND First, set the parameters of the SMB protocol on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 328 OSMOND User Manual 4. On the appearing menu set the following: - Host: IP address of the SMB server, in this case: 192.168.1.2 - Username: Name of the user, in this case: tesztg - Password: Password of the user, in this case: 123456 (This password is required for the tesztg user to sign in to Windows as well.)
  • Page 329 OSMOND User Manual 7. Then, navigate to SCAN PROCESS / MAIN CONFIGURATION. In this menu item, under PACKAGE UPLOAD OPTIONS / Communication type select SMB (Samba) protocol. 8. Then, click on the [SAVE] button. After performing these settings, the scanned documents are transferred to the upload server as a zip file.

  • Page 330: Testing The Setup

    OSMOND User Manual 15.3. TESTING THE SETUP In case of error, the SMB server can be tested from command line with the following command: curl --upload-file probe_file.txt -u tesztg:123456 smb://192.168.1.2/smb_probashare/ where: is the name of the file which is to be uploaded. There is no format restriction, it probe_file.txt...

  • Page 331: Troubleshooting

    OSMOND User Manual 15.4. TROUBLESHOOTING If upload is not working, Osmond will collect the unsuccessful documents to the UNSUCCESSFUL queue until its limit is not reached. When UNSUCCESFUL limit is reached, the oldest element in queue is overwritten by the result of the latest scan. Documents in unsuccessful status can be checked in the APPLICATION / LIST QUEUE menu.
  • Page 332 OSMOND User Manual If upload is not working, then the Windows Firewall or another network device may be blocking it. Setting the Windows 10 Firewall: 1. Navigate to Control Panel/System and Security/Windows Defender Firewall. 2. Click on [Advanced settings] located in the left section.

  • Page 333: Setting The Webdav Protocol On Osmond

    OSMOND User Manual 16. SETTING THE WEBDAV PROTOCOL ON OSMOND The current version (1.8) of the Osmond firmware is capable of uploading the scanned data to a server via multiple protocols. In this section the settings of the WebDav protocol will be explained.

  • Page 334: Installing And Setting The Webdav Server On Windows 10

    OSMOND User Manual 16.1. INSTALLING AND SETTING THE WEBDAV SERVER ON WINDOWS 10 16.1.1. INSTALLING THE WEBDAV SERVER 1. Open a PowerShell terminal with administrator rights: − Open Start menu. − Enter "powershell". − Select the appearing Windows PowerShell application and click on the "Run as Administrator"...
  • Page 335 OSMOND User Manual 3. Copy the following command to the terminal, and press [Enter]: $feats @("IIS-WebServerRole","IIS-WebServer","IIS- CommonHttpFeatures","IIS-HttpErrors","IIS-Security","IIS- RequestFiltering","IIS-WebServerManagementTools","IIS- DigestAuthentication","IIS-StaticContent","IIS-DefaultDocument","IIS- DirectoryBrowsing","IIS-WebDAV","IIS-BasicAuthentication","IIS- ManagementConsole");foreach ($feat $feats) {Enable- WindowsOptionalFeature -Online -FeatureName $feat};& "$env:windir\system32\inetsrv\InetMgr.exe"; − This command installs the Internet Information Services (IIS) modules which are required for the installation and setup of WebDav.
  • Page 336 OSMOND User Manual 6. Type "webdav_share" to the Alias field. 7. Enter the name of the shared folder (or browse it by clicking on the […] button) to the Physical path field: c:\webdav_share 8. Click on the [OK] button. 9. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option.
  • Page 337 OSMOND User Manual 12. In the appearing Add Site Binding window select "http" under the Type parameter. 13. Under IP address keep the default option: "All Unassigned". 14. Enter the value "1080" to the Port field. 15. Click on the [OK] button.
  • Page 338 OSMOND User Manual 17. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option. 18. Double click on the [SSL Settings] icon located in the middle part of the window.
  • Page 339 OSMOND User Manual 26. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option. 27. Double click on the [WebDAV Authoring Rules] icon located in the middle part of the window.
  • Page 340 OSMOND User Manual 34. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option. 35. Double click on the [Directory Browsing] icon located in the middle part of the window.
  • Page 341 OSMOND User Manual 16.1.3. SETTING THE FIREWALL It is recommended to check the Windows Firewall settings: 1. Navigate to Control Panel / System and Security / Windows Defender Firewall / Advanced settings. 2. Right click on [Inbound rules] located in the left section.
  • Page 342 OSMOND User Manual 6. At "Does this rule apply to TCP or UDP?" select TCP. 7. At "Does this rule apply to all local ports or specific local ports?" select "Specific local ports" and enter the value 1080 to the text field.

  • Page 343: Installing And Setting The Webdav Server On Linux

    OSMOND User Manual 16.2. INSTALLING AND SETTING THE WEBDAV SERVER ON LINUX 16.2.1. INSTALLING THE WEBDAV SERVER On Linux the WebDAV protocol is provided by the Apache2 server. Under Linux install and set up the Apache2 server from command line. The commands may depend on the distribution.
  • Page 344 OSMOND User Manual 16.2.3. SETTING THE APACHE WEBSERVER 1. Create the WebDav library: sudo mkdir /home/tesztg/webdav sudo chown -R www-data:www-data /home/tesztg/webdav 2. Then, create a library for the WebDav database: sudo mkdir /usr/local/apache/var/ sudo chown www-data:www-data /usr/local/apache/var 3. Modify the Apache configuration file. Any text editor can be used for the modification except for nano.
  • Page 345 OSMOND User Manual 5. Enable the WebDav modules: sudo a2enmod dav sudo a2enmod dav_fs 6. Set the global server name. If it has a name (e.g., webdav.example.com), enter it. In other case enter the localhost. After the line # type the following to the...

  • Page 346: Setting On Osmond

    OSMOND User Manual 16.3. SETTING ON OSMOND First, the parameters of the WebDav protocol must be set on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 347 OSMOND User Manual 4. On the appearing menu set the following: - Host: IP address of the WebDav server, in this case: 192.168.1.2 - Protocol: http:// - Port: Port of the WebDav server: 1080 - Access directory: This field must be blank.
  • Page 348 OSMOND User Manual 7. Then, navigate to SCAN PROCESS / MAIN CONFIGURATION. In this menu item, under PACKAGE UPLOAD OPTIONS / Communication type select WebDav (Web Distributed Authoring and Versioning) protocol. 8. Then, click on the [SAVE] button. After performing these settings, the scanned documents are transferred to the upload server as a zip file.

  • Page 349: Testing The Setup

    OSMOND User Manual 16.4. TESTING THE SETUP 16.4.1. WINDOWS Check the WebDav server is running or is accessible by using the File Explorer. 1. Enter the address of the WebDav server to the address bar of the File Explorer: \\192.168.1.2@1080\webdav_share 2.

  • Page 350: Troubleshooting

    16.5.1. OSMOND If upload is not working, Osmond will collect the unsuccessful documents to the UNSUCCESSFUL queue until its limit is not reached. When UNSUCCESFUL limit is reached, the oldest element in queue is overwritten by the result of the latest scan. Documents in unsuccessful status can be checked in the APPLICATION / LIST QUEUE menu.
  • Page 351 OSMOND User Manual 16.5.2. LINUX On Linux the WebDav protocol is provided by the Apache2. Its operation can be affected with the following commands: • Check the configuration of Apache2: apachectl configtest • Start the Apache2: sudo systemctl start apache2 •...

  • Page 352: Setting The Webdav Secure Protocol On Osmond

    OSMOND User Manual 17. SETTING THE WEBDAV SECURE PROTOCOL ON OSMOND The current version (1.8) of the Osmond firmware is capable of uploading the scanned data to a server via multiple protocols. In this section the settings of the WebDav secure protocol will be explained.

  • Page 353: Installing And Setting The Webdav Server On Windows 10

    OSMOND User Manual 17.1. INSTALLING AND SETTING THE WEBDAV SERVER ON WINDOWS 10 17.1.1. INSTALLING THE WEBDAV SERVER 1. Open a PowerShell terminal with administrator rights: − Open Start menu. − Enter "powershell". − Select the appearing Windows PowerShell application and click on the "Run as Administrator"...
  • Page 354 OSMOND User Manual 3. Copy the following command to the terminal, and press [Enter]: $feats @("IIS-WebServerRole","IIS-WebServer","IIS- CommonHttpFeatures","IIS-HttpErrors","IIS-Security","IIS- RequestFiltering","IIS-WebServerManagementTools","IIS- DigestAuthentication","IIS-StaticContent","IIS-DefaultDocument","IIS- DirectoryBrowsing","IIS-WebDAV","IIS-BasicAuthentication","IIS- ManagementConsole");foreach ($feat $feats) {Enable- WindowsOptionalFeature -Online -FeatureName $feat};& "$env:windir\system32\inetsrv\InetMgr.exe"; − This command installs the Internet Information Services (IIS) modules which are required for the installation and setup of WebDav.
  • Page 355 OSMOND User Manual 6. Type "webdav_secure_share" to the Alias field. 7. Enter the name of the shared folder (or browse it by clicking on the […] button) to the Physical path field: c:\webdav_secure_share 8. Click on the [OK] button. 9. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option.
  • Page 356 14. Enter the value "1443" to the Port field. 15. Under SSL certificate select your own SSL certificate. (Self-signed certificates are not appropriate because Osmond will not accept them.) 16. Click on the [OK] button. 17. In the Site Bindings window click on the [Close] button.
  • Page 357 OSMOND User Manual 18. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option. 19. Double click on the [SSL Settings] icon located in the middle part of the window.
  • Page 358 OSMOND User Manual 27. Under the Connections tree located on the left side of the IIS Manager window click on the [Default Web Site] option. 28. Double click on the [WebDAV Authoring Rules] icon located in the middle part of the window.
  • Page 359 OSMOND User Manual 17.1.3. SETTING THE FIREWALL It is recommended to check the Windows Firewall settings: 1. Navigate to Control Panel / System and Security / Windows Defender Firewall / Advanced settings. 2. Right click on [Inbound rules] located in the left section.
  • Page 360 OSMOND User Manual 6. At "Does this rule apply to TCP or UDP?" select TCP. 7. At "Does this rule apply to all local ports or specific local ports?" select "Specific local ports" and enter the value 1443 to the text field.

  • Page 361: Installing And Setting The Webdav Server On Linux

    OSMOND User Manual 17.2. INSTALLING AND SETTING THE WEBDAV SERVER ON LINUX 17.2.1. INSTALLING THE WEBDAV SERVER On Linux the WebDAV protocol is provided by the Apache2 server. Under Linux install and set up the Apache2 server from command line. The commands may depend on the distribution.
  • Page 362 OSMOND User Manual 17.2.3. SETTING THE APACHE WEBSERVER 1. The hostname must be set to the hostname located in the fully qualified domain name (FQDN). In the example the FQDN is "tesztg.example.hu", where the hostname is "tesztg". To set this, the...
  • Page 363 OSMOND User Manual 6. Create the WebDav configuration file. Any text editor can be used except for nano. sudo nano /etc/apache2/sites-available/webdav_secure.conf DavLockDB /usr/local/apache/var/DavLock <IfModule mod_ssl.c> <VirtualHost *:1443> ServerAdmin webmaster@localhost DocumentRoot /var/www/webdav_secure_share ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined Alias /webdav_secure_share /var/www/webdav_secure_share SSLEngine on SSLCertificateFile /etc/ssl/certs/cert1.crt...
  • Page 364 OSMOND User Manual 9. Enable the WebDav modules: sudo a2enmod dav sudo a2enmod dav_fs sudo a2enmod ssl sudo a2ensite default-ssl sudo a2enmod auth_digest 10. Set the global server name. If it has a name (e.g., webdav.example.com), enter it. In other case enter the localhost. After the...
  • Page 365 OSMOND User Manual 14. Add the tesztg user to WebDav: sudo htpasswd -c /usr/local/apache/var/users.password tesztg - The parameter is only required for adding the first user. When adding other users: sudo htpasswd /usr/local/apache/var/users.password tesztg 15. Enable the auth_digest module: sudo a2enmod auth_digest 16.

  • Page 366: Setting On Osmond

    OSMOND User Manual 17.3. SETTING ON OSMOND First, the parameters of the WebDav protocol must be set on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 367 OSMOND User Manual 4. On the appearing menu set the following: - Host: IP address of the WebDav server or the fully qualified domain name (FQDN), depending on which one the certificate was issued for. In this case the certificate is issued for the FQDN, therefore: tesztg.example.hu...
  • Page 368 OSMOND User Manual 6. If the test is passed, click on the [SAVE] button. 7. Then, navigate to SCAN PROCESS / MAIN CONFIGURATION. In this menu item, under PACKAGE UPLOAD OPTIONS / Communication type select WebDav (Web Distributed Authoring and Versioning) protocol.

  • Page 369: Testing The Setup

    OSMOND User Manual 17.4. TESTING THE SETUP 17.4.1. WINDOWS Check the WebDav server is running and is accessible by using the File Explorer. 1. Enter the address of the WebDav server (in this case: FQDN) to the address bar of the File Explorer: \\tesztg.example.com@SSL@1443\webdav_secure_share...

  • Page 370: Troubleshooting

    17.5.1. OSMOND If upload is not working, Osmond will collect the unsuccessful documents to the UNSUCCESSFUL queue until its limit is not reached. When UNSUCCESFUL limit is reached, the oldest element in queue is overwritten by the result of the latest scan. Documents in unsuccessful status can be checked in the APPLICATION / LIST QUEUE menu.
  • Page 371 OSMOND User Manual 17.5.2. CHECKING THE SERVER The server can be checked by using the following command. This command tries to upload a file to the server: curl 'main.txt' --user tesztg:123456 https://tesztg.example.com:1443/webdav_secure_share/ where: is the name of the file to be uploaded main.txt...
  • Page 372 OSMOND User Manual 17.5.5. LINUX On Linux the WebDav protocol is provided by the Apache2. Its operation can be affected with the following commands: • Check the configuration of Apache2: apachectl configtest • Start the Apache2: sudo systemctl start apache2 •...

  • Page 373: Setting The Configuration And Software Update On Osmond Device Through Network

    OSMOND DEVICE THROUGH NETWORK The Osmond firmware version 1.8 and above versions allow sending configuration updates (e.g., changing settings) and firmware updates from a remote update server to one or more Osmond N devices via network. The default update server is "update.adaptiverecognition.com". For more information on it, contact ADAPTIVE RECOGNITION support or sales team.

  • Page 374: Installing And Setting The Update Server On Windows 10

    OSMOND User Manual 18.2. INSTALLING AND SETTING THE UPDATE SERVER ON WINDOWS 10 18.2.1. INSTALLING PYTHON 1. Download and install Python 3 or newer version (currently Python 3.11.3 can be accessed): - Navigate to https://www.python.org/downloads/. - Select "Use admin privileges when installing py.exe" and "Add python.exe to PATH" by ticking the checkboxes.
  • Page 375 OSMOND User Manual 18.2.2. INSTALLING THE UPDATE SERVER 1. Create the library of the update server: - Navigate to Start menu / Windows System / File Explorer. - In the appearing window navigate to library, where the is the name...
  • Page 376 OSMOND User Manual - Right click on the file name and select the Edit menu item. In the absence of this, click on the Open with menu item and browse the Notepad application. - To this location copy the content of the configuration file located in the Annex / Configuration File (config_new1.conf)
  • Page 377 OSMOND User Manual 5. Copy config_new1.conf config_new1.conf.chk files library. C:\Users\user\update_server - The former config_new1.conf must be overwritten with the returned one. 6. Create or copy the 'get' file to the library (see Annex / Description of the update_server Configuration File (get file)
  • Page 378 OSMOND User Manual - To this location copy the following line and press the [Enter] key at the end of the line in order to start a new line: *|*|*|*|*|config_new1.conf - Then, click on File / Save in the Notepad application.
  • Page 379 OSMOND User Manual 7. Start the Python web server: - Open Start menu / Windows System / Command Prompt - Navigate to the update server in the Command Prompt: update_server - Start the Python web server: python -m http.server 3280...
  • Page 380 OSMOND User Manual 18.2.3. SETTING THE FIREWALL If the server cannot be accessed from another PC, check the Windows Firewall settings. 1. Navigate to Control Panel / System and Security / Windows Defender Firewall / Advanced settings. 2. Click on [Inbound rules] located in the left section.
  • Page 381 OSMOND User Manual 6. At "Does this rule apply to TCP or UDP?" select TCP. 7. At "Does this rule apply to all local ports or specific local ports?" select "Specific local ports" and enter the value 3280 to the text field. Then click on the [Next >] button.
  • Page 382 OSMOND User Manual 10. On the following window type "update_server" to the "Name:" text field. Then, click on the [Finish] button. 11. The new rule ("update_server") appears in the list. 12. Restart the PC. 382/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 383: Installing And Setting The Update Server On Linux

    OSMOND User Manual 18.3. INSTALLING AND SETTING THE UPDATE SERVER ON LINUX 18.3.1. INSTALLING PYTHON Most Linux distributions, including Ubuntu 22.04, install one of the Python versions during its installation. In order to perform the following steps, open a terminal.
  • Page 384 OSMOND User Manual 18.3.2. INSTALLING THE UPDATE SERVER Install the update server from command line: 1. Create the library of the update server: mkdir /home/user/update_server where is the name of the user user 2. Enter the library: update_server /home/user/update_server where...
  • Page 385 OSMOND User Manual 7. The content of the library can be seen in the following image: update_server 8. Start the Python web server: python3 -m http.server 3280 where: is the port through which the update server is listening 3280 9. The availability of the server can be tested by entering its address to the address bar of the browser: http://192.168.1.3:3280...

  • Page 386: Setting On Osmond

    OSMOND User Manual 18.4. SETTING ON OSMOND The parameters of the update server can be set on the web interface of the Osmond device. By default, the web interface is accessible on 192.0.2.3:3000, but it can be set to another address as well.
  • Page 387 OSMOND User Manual 4. On the appearing menu set the following: - Protocol: HTTP (Hypertext Transfer Protocol) - Host: IP address of the update server, in this case: 192.168.1.2 - Port: Port of the update server: 3280 - Remote directory: Name of the folder accessible from the server’s root directory: /get - Username: Name of the user.
  • Page 388 OSMOND User Manual 6. On the UPDATE SERVER CONFIGURATION window specify the following: - Server number: The number of the update servers, in this case: 1 - Download speed: The speed of the download, in this case: 1G - Update time: in this case: hourly Then, click on the [SAVE] button.

  • Page 389: Notes For The Update Server

    2. If you rename the configuration file, do not forget to rewrite its name in the 'get' file as well. 3. Multiple update servers can be set. In this case the Osmond device queries them in the specified order. If it finds a relevant update, Osmond applies it and does not continue the search.

  • Page 390: Annex

    OSMOND User Manual 18.7. ANNEX 18.7.1. CONFIGURATION FILE (CONFIG_NEW1.CONF) The configuration file contains those fields and their values that are to be set. Its format is similar to JSON, but it begins and ends with a note line (//). The first note is the name of the table, fields of which are included in the list, below the table name.
  • Page 391 OSMOND User Manual 18.7.2. SIGNING THE CONFIGURATION FILE 1. Perform the signing in a library, different than the update server (update_server). Therefore, create a library named as in the user account update_server_sign 2. Copy the following files to the library: update_server_sign −...
  • Page 392 OSMOND User Manual 18.7.3. DESCRIPTION OF THE CONFIGURATION FILE (GET FILE) The 'get' file describes which device gets which configuration file. This is a text file in which one line is divided into 5 sections. The sections are separated by pipe characters (|).

  • Page 393: Configuration Fields

    OSMOND User Manual 18.7.4. CONFIGURATION FIELDS //Properties "UpdateServerMain/update_time" : "17 */2 * * * " "UpdateServer/1/host" : "192.168.0.121" "UpdateServer/1/remote_directory" : "get" "UpdateServer/1/protocol" : "HTTPS" "UpdateServer/1/password" : "test" "ResultUpload/WSS/access_directory" : "test directory" "ResultUpload/WSS/host" : "test wss host" "ResultUpload/WSS/authority/RawData" : "-----BEGIN CERTIFICATE-----...
  • Page 394 OSMOND User Manual "ResultUpload/WSS/private_key/UploadName" : "testkeyfilename.key" "ResultUpload/WSS/reconnect_attempts" : "6" "ResultUpload/WSS/upload_frequency" : "6" "UpdateServer/1/username" : "testupdateserver_username" "LogUpload/ipAddress" : "test_loguploadaddress" "LogUpload/port" : "6666" "LogUpload/protocol" : "tcp" "LogUpload/isRealtimeUpload" : "1" "queue/check_interval" : "88" "queue/minimal_available_space" : "88" "queue/package_limit" : "8" "queue/corrupted_package_limit" : "16" "queue/queue_warning_interval" : "24"...

  • Page 395: Passport Reader Property List

    OSMOND User Manual 19. PASSPORT READER PROPERTY LIST The property list contains the short descriptions of the passport reader properties according to the following: Property Path and Name Every property has a path and a name. When referring to a property (e.g., in the Full Page Reader application) the path must be specified as well.
  • Page 396 OSMOND User Manual All properties located under the docimageprops and log tabs are described in the GX Reference Manual. Most of these advanced properties are not required to be adjusted in typical user applications. All properties located under document/mqc tab are described in the MRZ Quality Assurance Reference Manual.

  • Page 397: Detailed Property Descriptions

    OSMOND User Manual 19.1. DETAILED PROPERTY DESCRIPTIONS Value type/ Property Path and Name Default Value Description Accessibility Integer act_page The ordinal number of the last scanned page. String api_date The date required for the PRSoftware license. String Date after which the automatic saving is autosave/enddate discontinued.
  • Page 398 OSMOND User Manual Boolean In case of "autosave/filter" = 2, it enables or autosave/skip_text False disables the system to generate txt files. F / R / W NOTE: This property applies only to 1D and PDF417 barcodes. The barcode/contrast property controls the contrast compensation level.
  • Page 399 OSMOND User Manual The barcode reading process can be sped up by specifying this property. The order in which certain barcode types are read can be specified. The not needed types can be omitted. <recog_order value="51789a"/> String barcode/recog_order 1 – for all 1D codes F / R / W 5 –...
  • Page 400 OSMOND User Manual This property is specially developed for capturing dark documents (e.g., front cover of certain Boolean ctrl/detdark False passports). By setting this property to 1, the F / R / W motion detector of the device will detect dark documents as well.
  • Page 401 OSMOND User Manual NOTE: The number of the window is to be written in place of #, deviating from the regular, numbered from 1. Integer This property is applicable for multi-window ctrl/resolution_# min: 0 F / W devices (e.g., devices equipped with photo max: 100000 camera).
  • Page 402 OSMOND User Manual The debug/path property specifies the directory for saving debug info if some internal image processing exception occurs. The occurrence of such errors is shown by the creation of one or Path debug/path more debug files containing images that caused F / R / W the specific exception and/or error descriptions.
  • Page 403 OSMOND User Manual This property enables the recalculation of "document views" by the result of the OCR MOD _ DR _ YES functions. This option is necessary for e.g., min: recognition of upside-down documents. MOD_DR_NO Integer It is recommended to leave it turned on (1).
  • Page 404 OSMOND User Manual With the help of the logging option of the document processing module, performance logs can be created by setting the log/logprocess property to 'timing'. Example: <default> <pr> <document> <log> String <logprocess document/log/logprocess value="timing"/> F / R / W <file...
  • Page 405 OSMOND User Manual Integer Makes the saved fingerprint image more finger/cformat min: 0 contrasted. F / R / W max: 1 Enables hand swapping test. This test only gives Boolean finger/check_hand True signal when the four fingers of the scanned hand F / R / W are present.
  • Page 406 OSMOND User Manual Path, where the system is searching for the Path licenses in order to upload automatically upon license_path starting the device. Searches for them in the F / R / W rwdata_dir regardless of the property. Properties for logging.
  • Page 407 OSMOND User Manual Boolean If set to 1, only images are loaded in case of omit_task_loading False LoadDocument, without results. F / R / W Sets the autostart mode of the PC/SC upon the Boolean connection of the device. pcsc/autostart False The pcsccontrol.exe file must be run in order to...
  • Page 408 OSMOND User Manual The prrfid module log can be used for logging the communication and work flow between the card and the device. It is useful during the development or the testing process when communication tracing is necessary. It should not be used in production systems because it may contain personal data in this way violating security norms.
  • Page 409 OSMOND User Manual This property controls the priority of document signer certificates Cert.DS during the checking process: If 0, the checking process is executed with the file in the RFID chip first. Integer min: -1 rfid/pref_ext_ds If 1, the checking process is executed with the...
  • Page 410 OSMOND User Manual Integer testdoc_mode Internal property. F / R / W Integer twain/devno Ordinal number of the device to use. min: 0 max: 8 Boolean twain/docview False To scan cropped and rotated image. Possible values: 0 – It is enough to just move the document to...
  • Page 411 OSMOND User Manual This property is applicable only for PRM, CLR and PRMc devices equipped with UV tubes. Although, acceptable images can be captured with less warming time, the best image quality is achieved when the UV tubes are warmed up completely.
  • Page 412 OSMOND User Manual 19.1.1. PR 2.1 SDK PROPERTIES The following properties can only be used in the Pr 2.1 SDK. In the new SDK these properties are set automatically or via methods. Do not set these properties from the Pr 2.2 SDK.
  • Page 413 OSMOND User Manual There are two main event sources in the PR system: the directly called processes like the capture process, which can raise events to report their progress and the parallel running freerun mode tasks, which can raise events to report state changes like document detection or button testing.
  • Page 414 OSMOND User Manual Contains ID codes of the RFID files separated String by space. It is used when the file identification rfid/selected_files parameter of the RFID file reading method is F / R / W set to "Selected". Triggers an event. Not all the event can be triggered.

  • Page 415: Data Fields

    OSMOND User Manual 20. DATA FIELDS The Passport Reader system returns all OCR, RFID, barcode and basically all kinds of results as fields. For better understanding, this document classifies fields into four logical groups: General data fields: results of OCR, barcode-, and RFID reading processes...

  • Page 416: Other

    OSMOND User Manual 20.1.2. FORMATTED Formatted: value without checksums and filler characters. Authentication fields and Document type identification field values are available in formatted form. The values of the authentication fields are in thousandths. 20.1.3. STANDARDIZED Standardized: Using a standard, the field is converted to a format to ease further processing of data.

  • Page 417: Encrypted Saving

    From pr-2.1.11 version the user specific file can be set for encrypted saving. In such case the encrypted file cannot be decoded with the ADAPTIVE RECOGNITION key. If you want to save encrypted files which can only be decoded in ADAPTIVE RECOGNITION’s network, then, when saving the file in...

  • Page 418: Process Of The Encryption

    OSMOND User Manual 21.2. PROCESS OF THE ENCRYPTION There are multiple options to give the public key in the SDK. The certificate containing the key can be loaded from the memory as is used at the ecard handling (Certificates.Load() method). Then, the returned key ID number must be handed over to "rfid/encryption_key"...

  • Page 419: Process Of The Decryption

    OSMOND User Manual 21.3. PROCESS OF THE DECRYPTION For decryption, the prdecrypt command line program is given by ADAPTIVE RECOGNITION. The prdecrypt program is located in C:\Program Files\Adaptive Recognition\utils\prdecrypt\ or C:\Program Files (x86)\Adaptive Recognition\utils\prdecrypt\ folder. The file containing the private key must be handed over to the program. When starting the program...

  • Page 420: Encrypted Autosave

    OSMOND User Manual 21.4. ENCRYPTED AUTOSAVE This section provides a short description on how to save scanning results as encrypted files in the Full Page Reader and Authentication Checker applications. 21.4.1. ENCRYPTED AUTOSAVE IN FULL PAGE READER In order to save the scanned data as encrypted file in Full Page Reader, turn on "ENABLE EASY SAVE"...
  • Page 421 OSMOND User Manual 21.4.2. ENCRYPTED AUTOSAVE IN AUTHENTICATION CHECKER In order to save the scanned data as encrypted file in Authentication Checker, turn on "AUTO SAVE" at "OPTIONS" menu. Then, enter a desired filename with .ecz extension and the path where the file will be saved.

  • Page 422: Full Page Reader − Saving In Csv Format

    OSMOND User Manual 22. FULL PAGE READER − SAVING IN CSV FORMAT This chapter provides a short guide how to save scanning results in CSV format in Full Page Reader application. 22.1. SETTINGS In order to save the read data into a CSV file, you need to turn on "ENABLE EASY SAVE" and "AUTOSAVE"...

  • Page 423: Csv Structure

    OSMOND User Manual 22.2. CSV STRUCTURE With the above settings, the Full Page Reader will generate the set CSV file. If the file already exists, it will append each scanning result to it. In the headline of the CSV file, there are keywords which represents the field type of the particular column.

  • Page 424: Firmware Management

    OSMOND User Manual 23. FIRMWARE MANAGEMENT In order to get the most out of your Osmond and have the latest fixes and modifications, it is recommended to have the latest firmware applied on your reader. The main purpose of this section is to provide a short guide on the firmware update of Osmond devices (USB and network models).

  • Page 425: Firmware Installation With Updater Msi

    This functionality is available for Osmond USB (R, L models) and network (N model) devices as well. In this section the firmware installation and update of Osmond devices with MSI installer will be discussed. The firmware is available on the...
  • Page 426 If you do not have any of our USB driver package, please contact our technical support team for the download link. If you have all the required components, please connect your Osmond device to the PC and turn it on. 426/468 REQUESTINFO@ADAPTIVERECOGNITION.COM...
  • Page 427 OSMOND User Manual 23.1.2. THE UPDATE After device boots please check with "C:\ProgramFiles\Adaptive Recognition\utils\PRDTool\PRDTool.exe" utility tool whether the connection was established successfully. The PRDTool is installed alongside the Passport Reader software, and can be found in one of the following folders: •...
  • Page 428 OSMOND User Manual If the device has connected, please launch the "OsmondUpdater yy.mm.n.msi" in order to update the reader. After the updater application is installed on the PC, the update process is started automatically. If your device already has the latest firmware version, the installer will stop without installing the firmware, and create a log file under C:\ProgramData\gx\pr\fw\ folder.
  • Page 429 OSMOND User Manual During the update, the device will be restarted two times. After the process finishes, please check with the PRDTool whether you see an appropriate firmware version: 429/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...

  • Page 430: Status Icons

    OSMOND User Manual 23.1.3. STATUS ICONS While the update is in progress, you will see the following status icons on the OLED screen of the device. DISPLAY ICON STATUS NAME STATUS DESCRIPTION File transfer The firmware file is transferring In progress...

  • Page 431: Netapi (Nai Mode)

    The standalone version of the .NET interface can be operated without the installation of the PR system as well. This chapter provides information on how to set up NetAPI on Osmond N as well as describes the server and client setup.

  • Page 432: Setup On The Osmond N Device

    NETWORK / WEB SERVER menu. NetAPI operates via HTTPS communication only. Upload HTTPS certificate to Osmond device and check your browser if secure connection is established with the web interface. 3. Set the operating mode of the device to "NAI" mode in the MAINTENANCE / OPERATING MODE menu.

  • Page 433: Setup Server On Pc

    OSMOND User Manual 24.2. SETUP SERVER ON PC 1. Create a NetAPI user with the PRDTool program. The user needs admin or user role. Maximum 5 users can be logged in at the same time in order to use several connected devices. The user sessions can be managed with admin role.

  • Page 434: Setup Client

    OSMOND User Manual 24.3. SETUP CLIENT The NetAPI client is part of the Passport Reader software. In order to use it, set the following properties within the default/pr node in the gxsd.dat file manually, or by your client program: - ipdev/url – Server IP address (or domain name) and port number.

  • Page 435: Using Full Page Reader With Osmond N Through Netapi

    Users have the possibility to use the Full Page Reader application through NetAPI. In this section the necessary steps to acquire this function will be described. 1. Sign in to the web interface of the Osmond N device. 2. Create a user with "NAI user" role in the web interface in the ADMINISTRATION / USERS menu.
  • Page 436 OSMOND User Manual 4. Set the operating mode of the device to "NAI" mode in the MAINTENANCE / OPERATING MODE menu. 5. Afterwards, open PRDTool. 6. In PRDTool check the mode of the device. It must be in NAI mode.
  • Page 437 The URL value consists of the IP address and the port number. In case of Osmond N devices, the IP address is displayed in the PRDTool at the IP address section. The port number is the same as the value found at the web interface.
  • Page 438 OSMOND User Manual 11. Open Full Page Reader. 12. When the FPR application is opened, a login window pops up. 13. Enter the PASSWORD into this window. 438/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore...
  • Page 439 OSMOND User Manual 14. After a few seconds, the device is calibrated and ready to be used in NetAPI mode. 439/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore WWW.ADAPTIVERECOGNITION.COM...

  • Page 440: Network Web Application Api (Nwa Mode)

    25.1.2. CREATE USER WITH NWA (NETWORK WEB APPLICATION API) ROLE 1. On your Osmond device web interface, navigate to ADMINISTRATION / USERS menu and click [+NEW USER]. 2. Specify user name and password (in the following sample: niswebapi_user and niswebapi_password).

  • Page 441: Generating Certificates

    The following commands can be executed on Linux OS or Windows OS as well, if the openssl is downloaded. Accessing the Osmond N device via Network Web Application API requires client-side certificate. This certificate must be trusted by the Osmond N device and is verified upon establishing secure connection. Generating the necessary certificates: −...
  • Page 442 PC. For exporting the Osmond HTTPS certs, visit its login page and export the certificates via browser. The exact steps of export depend on the type and version of browser.
  • Page 443 = " osmondn211785.osmondn.arh.hu" api_server_port = 3000 In order to address your device like devicename.subdomain.domain.hu, it must be configured in your DNS. E.g., OSMOND-N212888.osmondn.mycompany.com. For running the python demo, the followings are necessary: - niswebapi_client.pem (niswebapi client certificate) - niswebapi_client.key (niswebapi client private key) - openapi_demo.py (demo program)

  • Page 444: Support For Other Languages

    OSMOND User Manual 25.2. SUPPORT FOR OTHER LANGUAGES Using the openapi-generator-cli program, the Network Web Application API client code can be generated for other languages as well. The list of supported languages can be retrieved using the openapi-generator-cli list command.

  • Page 445: Api Functions

    OSMOND User Manual 25.3. API FUNCTIONS 25.3.1. PR_CONTROL It controls device-related functions like document scanning and uploading. "method": "autoScanNextStep | approveUpload" "params": "approve: true false" 25.3.2. GET_PR_CONFIG Get main configuration parameters: "main-config/packageType" => ['zip', 'csv', 'pdf'], "main-config/scanMode" => ['Interactive','Automatic'], "main-config/communicationType" => ['no_store','local_database', 'FTP', 'SFTP', 'FTPS', 'WebDav','SMB', 'SMTP', 'WS', 'WSS'], "main-config/autoSend"...

  • Page 446: Keep Alive

    OSMOND User Manual 25.3.3. SET_PR_CONFIG Modify values returned by get_pr_config. (Object:) result => ['1', 'FAIL'] 25.3.4. PR_STATUS Query scanning status and various settings of the web interface. "CURRENT_STATUS" => [(string)'0'..'3'] (enum RunningStatus {Sleep, Autonomic, Interactive, Load };), "CURRENT_PAGE" => [(string)'0'..MAX_PAGE_NUM], "MAX_PAGE_NUM"...
  • Page 447 OSMOND User Manual 25.3.6. QUEUE SUMMARY Returns the number of items in queue. {"active": [int]}, {"deferred": [int]}, {"corrupted":[int]}, {"predirect":[int]}, {"predelete":[int]} ] 25.3.7. QUEUE DELETED DEFERRED CORRUPTED Delete all deferred and corrupted items from queue with a single command. The value "yes" deletes the content of the queue section.

  • Page 448: Prdtool

    PR software. • Linux Depending on your distribution, you can open command terminal and insert: PRDTool or use dashboard search bar: Linux Start menu > Applications > Adaptive Recognition Apps > PRDTool. 448/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...
  • Page 449 OSMOND User Manual Only one instance of the program is running. If the window is not opened on the desktop, then it can be found on the notification area. The program can only be closed through the pop-up menu of the notification icon.

  • Page 450: Osmond Operation Modes

    • NWA (Network Web Application – Network Web Application API) mode USB mode In USB mode, the device operates as any other ADAPTIVE RECOGNITION passport reader. It can be used through our regular SDK, and with the Full Page Reader...

  • Page 451: Switching Between Operation Modes

    26.2.1. SWITCHING BETWEEN OPERATION MODES After the Osmond device has appeared and selected in the PRDTool, the current operation mode is displayed. In order to switch to another, please select the desired mode from the drop-down list by clicking on it, and then click on the [Set mode] button. A feedback message indicates the result of the change.

  • Page 452: Firmware Update

    26.3.1. THE UPDATE FILE Osmond passport reader devices use ZIP archives as update files and to every ZIP file belongs a CHK file which is the hash signature of the update archive. The signature ensures that the update file is unmodified and undamaged.

  • Page 453: Additional Feautures

    OSMOND User Manual 26.4. ADDITIONAL FEAUTURES This menu is only available in USB mode. PRDTool utility is equipped with additional functionalities to customize power button usage and OLED display suspend parameters. Click on the cogwheel icon in the Settings column to open the additional features menu.
  • Page 454 OSMOND User Manual 26.4.1. POWER BUTTON FEATURES For the device power button, two preconfigured functionalities are available. Users may select one of them. 1. Assisted Shutdown with On-screen Instructions (Default Setting) Using the Assisted shutdown option, operators may switch the device off using its power button, following the method described in the diagram: 2.

  • Page 455: Screen Standby

    OSMOND User Manual 26.4.2. SCREEN STANDBY The brightness of the device built-in display can be reduced automatically, after a period of inactivity. Use the slide bar to specify that time period, then click [Apply] to save changes. Default setting: the OLED fades out after 1 hour of idle state.
  • Page 456 OSMOND User Manual 26.4.3. RESOLUTION The resolution of the scanned document images can be selected, the following options are available: • Low resolution: 300 DPI • Medium resolution: 500 DPI • High resolution: 700 DPI By default, this value is set to 700 DPI. If the user requirements need lower resolution in order to reduce the stored file size or due to time-critical applications, change the default value.

  • Page 457: Settings

    26.5.1. AUTO UPDATE SETTINGS Osmond N devices are capable of downloading and installing update files automatically. Such updates can be configured in this menu. Set frequency of checking for updates at Check for update, specify update server with port (Download URL), and provide username and password if remote server uses basic authentication.
  • Page 458 OSMOND User Manual 26.5.2. NETAPI SERVER SETTINGS In the NetAPI server settings menu set the following values: • Port: Port number of NetAPI • RFID Cert. folder: Path of the certificates used for passive authentication • External access: If it is enabled, NetAPI is not only available from localhost but from other network locations.

  • Page 459: Pcsc Control

    OSMOND User Manual 26.6. PCSC CONTROL The PCSC control is part of the PRDTool program. This is the command line version of the former PCSCCtrl.exe. The functions of the PCSC can be found at the bottom of the opened PRDTool window.
  • Page 460 OSMOND User Manual PCSC can be started automatically via the quick menu of PRDTool: right click on the PRDTool icon and click on PCSC ctrl autostart. 460/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic Adaptive Recognition Hungary Adaptive Recognition Singapore...

  • Page 461: Command Line Mode

    OSMOND User Manual 26.7. COMMAND LINE MODE The PRDTool can also be used in command line mode to query device information. By calling the „--help” switch, the correct use is displayed. The device list, the device version and the IP address information can be queried.

  • Page 462: Osmond System Recovery

    With the system recovery the original manufacturer settings are restored, therefore all saved and stored data is erased. To perform system recovery on the Osmond N device, do the following: 1. Turn the power touch button off and disconnect the connected cables (power supply, Ethernet and/or USB cables).
  • Page 463 9. Next, the screen begins to flash, until a check mark is displayed. 10. Afterwards, the factory settings are valid. In case of Osmond N, the device can only be reached via its default IP address. Before accessing the web interface of the device, wait about 1-2 minutes.

  • Page 464: Fcc

    OSMOND User Manual 28. FCC 28.1. FCC CAUTION – §15.21: "Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment." 28.2. FCC STATEMENT – §15.105(B): "This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules.

  • Page 465: Responsible Party Information - §2.909

    OSMOND User Manual 28.5. RESPONSIBLE PARTY INFORMATION – §2.909: The identification, by name, address, and telephone number, or internet contact information, of the responsible party (must be located within the United States). 465/468 REQUESTINFO@ADAPTIVERECOGNITION.COM Adaptive Recognition America Adaptive Recognition Nordic...

  • Page 466: Acronyms And Technical Terms Used In The Document

    OSMOND User Manual 29. ACRONYMS TECHNICAL TERMS USED DOCUMENT Application Programming Interface Aztec One of the readable two-dimensional (2D) barcode types. Basic Access Control: An RFID security mechanism. Barcode Recognition. Barcodes are line drawings designed to be recognized easily by computers.
  • Page 467 OSMOND User Manual Optically Variable Device: Security feature which shows different information, depending on the viewing and/or lighting conditions. Optically Variable Ink: Printing ink that contains microscopic pigments acting as interference filters, resulting in large color shifts (strong variations in color) depending on the angle of observation or lighting.

  • Page 468: Contact Information

    Web: adaptiverecognition.com/support/ Adaptive Recognition Hungary Technical Support System (ATSS) is designed to provide you the fastest and most proficient assistance, so you can quickly get back to business. Information regarding your hardware, latest software updates and manuals are easily accessible for...

Table of Contents