Automated installation/uninstallation of Document Reader SDK

Composition of the installation package

The Document Reader SDK software installation package is supplied as a file Regula Document Reader SDK (x64).exe, which contains the following files to be installed in sequence:

1. Regula Document Reader SDK (x64).msi – software for working with Regula document readers, version for 64-bit Windows.
2. Regula Reader Documents Database (x64).msi – a database of document templates used by the software to detect, recognize, analyze, and verify documents. Without this database, the reader will only be able to recognize the machine-readable zone (MRZ) of documents. Version for 64-bit Windows.
3. Regula Reader Drivers (x64).msi – drivers for all Regula reader models for 64-bit Windows.
4. Regula Reader Drivers (Arm64).msi – drivers for all Regula reader models for Windows version for devices based on ARM processors.

For user convenience, the files can be supplied separately, which allows selective installation of components, for example, installation of the SDK without the template database.

To install the components in automatic mode (without displaying dialog boxes) with default parameters, run the following commands in the order shown:

msiexec /i  "Regula Reader Drivers (x64).msi" /qn
msiexec /i  "Regula Reader Documents Database (x64).msi" /qn
msiexec /i  "Regula Document Reader SDK (x64).msi" /qn

To remove the installed components, run the following commands:

msiexec /x  "Regula Document Reader SDK (x64).msi" /qn
msiexec /x  "Regula Reader Documents Database (x64).msi" /qn
msiexec /x  "Regula Reader Drivers (x64).msi" /qn

Command line parameters for Regula Document Reader SDK (x64).msi

The installation file Regula Document Reader SDK (x64).msi includes the following set of files (components):

1. DocumentReaderSDK – applications, modules for optical recognition and analysis of documents.
2. RFIDReaderSDK – modules and libraries for reading RFID chips.
3. DB – libraries for optical recognition and analysis of documents.
4. Samples – source codes and examples for developers.
5. Documentation – documentation for the software.
6. Licensing – license verification service.
7. ThirdParty – third-party components.

For each of these components, you can specify an installation folder other than the default folder. In addition, the installation file has three options:

1. Automatically send anonymous error reports when working with Regula document readers.
2. Create application shortcuts on the Windows desktop.
3. Create a menu item and application shortcuts in the Start menu.

Command line format for automated installation:

An example of a command line that ensures the installation of two components in a user-specified folder, with sending of error reports, but without creating shortcuts:

msiexec /i "Regula Document Reader SDK (x64).msi" /qn ADDLOCAL=ALL REMOVE=Samples DOCUMENT_READER_SDK_64="C:\Regula\SDK" RFID_READER_SDK_64="C:\Regula\RFID" SENDSTATISTICS=1 CREATESHORTCUT=0 CREATESTART=0

Command line for .EXE file

The same parameters for automated installation of the Document Reader SDK can also be passed to the EXE file, by specifying them after the /v parameter. You should also use the /s parameter to disable the dialog boxes of the EXE file itself. The above example of automated installation when using an EXE file will look as follows:

"Regula Document Reader SDK (x64).exe" /s /v"/qn ADDLOCAL=ALL REMOVE=Samples DOCUMENT_READER_SDK_64=\"C:\Regula\SDK\" RFID_READER_SDK_64=\"C:\Regula\RFID\" SENDSTATISTICS=1 CREATESHORTCUT=0 CREATESTART=0"

Please note that the command line passed in the /v parameter is enclosed in double quotes. If it contains the same double quotes (as in the example, where the paths to the folders are enclosed in quotes), you should add the '\' symbol before each quote to escape it.