Sections and articles

Configuring the Regula Passport Scanner in Shelter CLOUD

Introduction

Before starting to follow the instructions, you must connect the Regula scanner to your computer using the USB cable included in the package.

Configuring the Regula and Document Reader drivers

1. For Regula to work, we will need special software from the scanner manufacturer. To install it, you need to download Regula Downloads Manager.

2. Launching the downloaded file "Regula Downloads manager.exe ". 

3. In the window that opens, select the latest version of the "Document Reader SDK" and click "Download".



4. At the end of the download process, go to the directory with the downloaded files. The path to the directory is specified in the "Regula Downloads Manager" window in the " parameterThe download path is ". Select the "Regula Document Reader SDK (x64).exe" file and run it.



5. The installation process is shown in the screenshots:

- Click "Next".



- Accept the license agreement and click "Next".



- Accept the terms of the privacy policy and click "Next".



- Select the installation type "Default" and click "Next".

   



- Select the connection type "Local" and click "Install".



- We are waiting for the end of the installation process.



- At the end of the installation process, click "Finish".


6. Launching the "Document Reader" application.



7. In the application window that opens, "Document Reader";, click on the "Connect" button and wait for the scanner to connect. The process may take some time.



8. After connecting to the scanner, go to "File" - "Options".  




9. Optionally, you can change the program's interface language to Russian. This is done on the "General" tab. The interface language used in the article is "English".



10. It is recommended to set the settings identical to those shown in the screenshots:



   Check the box "Auto connect". We save the settings using the "Ok" button.


11. It is recommended to check the operation of the scanner on a real document. To do this, attach the second and third pages of the passport to it, and in the application "Document Reader" click on the "Process" button. A guide on how to use the scanner can be found here.


Installing the Regula HMS module

1. For the Regula scanner to work in Shelter CLOUD, we will need an application that will establish a connection between them, as well as a token. The application and the token can be requested from Shelter Technical support. To do this, just send an email support@shelter.ru .

2. The archive received from technical support must be unpacked on the computer where the Regula scanner is installed.



3. In the "hmsRegula.exe.config" file, enter the token issued by technical support. An example is shown in the screenshots:

- Open the file using the notepad application.



- Replace the "value" value in the "hotelToken" parameter with the token issued by technical support, and save the file.



4. Run the "hmsRegula file.exe". Upon successful launch, an icon will appear in the tray.



5. It is recommended to add an application "hmsRegula.exe " in startup, so that integration can be used when starting the computer.

Scanning and transferring data to Shelter CLOUD

1. Launch Shelter CLOUD and log in to the program.

2. We open the booking to which we want to add the scanned data. 

Important: The scan function works in saved bookings. If you open a new booking form and click on "Scan" - the program returns the error "Unknown command".

  


3. We put the passport on the scanner: first with one side, then with the other, so that the green indicator lights up on the scanner.

4. After that, in the booking, select the menu "Actions" item "Scan".

5. A guest with scanned passport data will be added to the booking. Information on the screenshots.

- We are scanning.



- A guest with scanned data has been added to the booking.



- Check the passport data.



6. Save the changes to the reservation by clicking on the " buttonSave".


Common errors

1. The most common situation is when passport data is recognized incorrectly. For example, the passport series and number or the guest's last name are incorrectly transmitted. In such a situation, it is necessary to scan the document through the Document Reader application. The process of such scanning is described in paragraph 11, section "Configuring the Regula and Document Reader drivers". After the scan is completed, we check the passport data displayed in the Document Reader application. There are 2 possible scenarios here:

1) The scanned document data is not displayed correctly or is not recognized in the Document Reader application. In this case, you should contact Technical support for the Regula scanner.

2) The scanned document data is correctly displayed and recognized in the Document Reader application. In this case, we perform the data scanning procedure in Shelter CLOUD once again and verify the data. If the data in the CLOUD is incorrect and the data in the Document Reader application is correct, contact Shelter technical support.

Данное руководство описывает процесс подключения сканера паспортов Regula, установки необходимого программного обеспечения и его интеграции с системой Shelter CLOUD для автоматического заполнения данных гостей.

Перед началом работы: Убедитесь, что сканер Regula подключен к компьютеру с помощью USB-кабеля из комплекта поставки.

Настройка драйверов и программного обеспечения Regula

Для работы сканера необходимо установить специальное ПО от производителя.

Шаг 1: Загрузка и установка Document Reader SDK

  1. Скачайте программу Regula Downloads Manager с официального сайта.

  2. Запустите скачанный файл Regula Downloads manager.exe.

  3. В открывшемся окне выберите последнюю версию Document Reader SDK и нажмите кнопку Загрузить.

  4. После завершения загрузки перейдите в папку с загруженными файлами (путь указан в строке Путь для загрузки).

  5. Запустите файл Regula Document Reader SDK (x64).exe для начала установки.

Шаг 2: Процесс установки Document Reader SDK

Следуйте инструкциям мастера установки:

  1. Нажмите Next.

  2. Примите условия лицензионного соглашения и нажмите Next.

  3. Примите условия политики конфиденциальности и нажмите Next.

  4. Выберите тип установки Default и нажмите Next.

  5. Выберите тип подключения Local и нажмите Install.

  6. Дождитесь окончания копирования файлов.

  7. По завершении установки нажмите Finish.

Шаг 3: Первоначальная настройка Document Reader

  1. Запустите приложение Document Reader через ярлык на рабочем столе или в меню «Пуск».

  2. В открывшемся окне нажмите кнопку Connect и дождитесь подключения к сканеру. Это может занять несколько минут.

  3. После успешного подключения перейдите в меню File → Options.

  4. Рекомендуемые настройки:

    • На вкладке General:

      • Allow options changing;

      • Show tray icon;

      • (Опционально) Если необходимо, смените язык интерфейса на русский. В данной инструкции используется английский интерфейс.

    • На вкладке View:

      • Show wait dialog when hidden;

      • Show RFID reading progress;

      • Show menu & toolbars;

      • Show details;

      • Show status bar;

      • Show warnings as errors;

      • Defaul details page: MRZ

      • Font size: 8;

      • Use skin for UI.

    • На вкладке Results:

      • Clear list on start and connect;

      • Save images;

      • Save only incorrect scans;

      • Save separate photos;

      • Graphic format: .jpg;

      • Compression ratio: 2;

      • Results folder: C:\RD\;

      • Recent results folder: C:\RD\

    • На вкладке Device:

      • Quick MRZ processing;

      • Multipage processing;

      • Glare compensation;

      • Video mode: 5MP;

      • Video chip frequency divider: 1;

      • Receive images;

      • Document locating;

      • Document type recognition;

      • MRZ;

      • Graphic fields;

      • Visual zone OCR;

      • Важно! Установите галочку Auto connect для автоматического подключения к сканеру при запуске.

  5. Сохраните изменения, нажав Ok.

Шаг 4: Проверка работы сканера

Рекомендуется протестировать сканер на реальном документе:

  1. Приложите ко сканеру вторую и третью страницы паспорта.

  2. В программе Document Reader нажмите кнопку Process.

  3. Убедитесь, что данные распознаются корректно.

Примечание: Полное руководство пользователя по работе со сканером доступно на сайте Regula.

Установка модуля интеграции Regula HMS

Это приложение обеспечивает связь между сканером Regula и Shelter CLOUD.

Шаг 1: Получение программного обеспечения и токена

Запросите у технической поддержки Shelter (support@shelter.ru) архив с приложением hmsRegula и уникальный токен для вашей системы.

Шаг 2: Установка и настройка

  1. Распакуйте полученный архив на компьютере, к которому подключен сканер Regula.

  2. Откройте файл hmsRegula.exe.config в текстовом редакторе (например, Блокноте).

  3. Найдите параметр hotelToken и замените значение value на выданный технической поддержкой токен.

  4. Сохраните файл.

Шаг 3: Запуск и настройка автозагрузки

  1. Запустите файл hmsRegula.exe.

  2. При успешном запуске в системном трее (области уведомлений) появится значок приложения.

  3. Рекомендуется добавить hmsRegula.exe в автозагрузку, чтобы использовать интеграцию при каждом включении компьютера.

Процедура сканирования и передачи данных в Shelter CLOUD

Шаг 1: Подготовка в Shelter CLOUD

  1. Запустите Shelter CLOUD и авторизуйтесь в системе.

  2. Откройте сохраненное бронирование, в которое необходимо добавить данные гостя.

    Важно: Функция сканирования работает только в уже созданных и сохраненных бронированиях. При попытке сканирования в новой (несохраненной) форме бронирования возникнет ошибка «Неизвестная команда».

Шаг 2: Сканирование документа

  1. Поместите паспорт на сканер: сначала одну сторону, затем другую. Дождитесь, пока загорится зеленый индикатор.

  2. В карточке бронирования выберите меню Действия и пункт Сканировать.

Шаг 3: Проверка и сохранение

  1. В бронирование автоматически добавится гость с заполненными паспортными данными.

  2. Внимательно проверьте корректность внесенных данных (ФИО, серия и номер паспорта и т.д.).

  3. Сохраните бронирование, нажав кнопку Сохранить.

Устранение неисправностей

Проблема: Данные паспорта распознаются некорректно (например, ошибки в серии, номере или ФИО).

Решение:

  1. Проведите пробное сканирование через приложение Document Reader (как описано в Шаге 4 Части 1).

  2. Проанализируйте результат:

    • Вариант А: Данные в Document Reader отображаются с ошибками. В этом случае проблема связана с работой сканера или его ПО. Обратитесь в техническую поддержку Regula.

    • Вариант Б: Данные в Document Reader распознаны корректно, но в Shelter CLOUD передаются с ошибками. Повторите процедуру сканирования через Shelter CLOUD. Если ошибка сохраняется, обратитесь в техническую поддержку Shelter.

Table of contents