Automated installation/uninstallation of Document Reader SDK

When installing, updating or uninstalling software for Regula Document Readers it is possible to specify command line parameters for fully unattended (silent) work with no window pop-ups or user input. Using the command line you can select what components to install or to uninstall, and what options should be used during installation.

Installation package components

Document Reader SDK software is released as one executable file Regula Document Reader SDK.exe which contains four installation files:

1. Regula Document Reader SDK.msi – software components for Regula Document Readers.
2. Regula Reader Documents Database.msi – document templates database which is used by the software for security document detection, recognition, analysis and authenticity verification. Without this database the software can read only MRZ part of a document.
3. Regula Reader Drivers (x64).msi – 64-bit Windows device drivers for Regula readers.
4. Regula Reader Drivers (x86).msi – 32-bit Windows device drivers for Regula readers.

For your convenience, you can download Document Reader SDK installation files in form of .msi packages in Regula downloads manager:

To install separate components in automated mode with default options please use the following command lines:

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

To uninstall components please use the following command lines:

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

Command line parameters for Regula Document Reader SDK.msi

Regula Document Reader SDK.msi installation file contains the following components (features):

1. DocumentReaderSDK – applications, modules and libraries for optical recognition and processing for security documents.
2. RFIDReaderSDK –modules and libraries for RFID chip reading.
3. Samples – user manuals, instructions, source codes and examples for users and developers.

It is possible to specify installation folder other than default for each of the components.

Also the installation file has three options that could be specified by command line:

1. Automatically send anonymous error reports when working with Regula readers.
2. Create shortcuts on Windows Desktop.
3. Create sub-menu and shortcut in Windows Start Menu.

To run automated unattended installation of Regula Document Reader SDK.msi you can use the following command line parameters:

• /qn – “silent” mode with no windows or user input;
• ADDLOCAL=feature1,feature2,feature3 – list of components to be installed (note that component names are case sensitive!);
• REMOVE= feature1,feature2,feature3 – list of components to be uninstalled;
• DOCUMENT_READER_SDK="drive:\path" – folder for x86 version of DocumentReaderSDK component installation;
• DOCUMENT_READER_SDK_64="drive:\path" – folder for x64 version of DocumentReaderSDK component installation;
• RFID_READER_SDK="drive:\path" – folder for x86 version of RFIDReaderSDK component installation ;
• RFID_READER_SDK_64="drive:\path" – folder for x64 version of RFIDReaderSDK component installation;
• SAMPLES="drive:\path" – folder for Samples component installation;
• SENDSTATISTICS=1 or 0 – option to send automated error reports;
• CREATESHORTCUT=1 or 0 – option to create desktop shortcuts;
• CREATESTART=1 or 0 – option to create Start Menu shortcuts;
• SCARDSERV=1 or 0 - option to disable Certificate Propagation Service;
• STARTUP=1 or 0 - add the Document Reader application to startup;
• RQS=1 or 0 - option to install Regula Quick Support;
• UPDATEFIRMWARE=1 or 0 - option to update RFID firmware during the installation process.
• FACE_SERVICE=1 or 0 - option to set the use of Face service running on the Internet(1) or Face service installed locally(0).

Here is an example of a command line for installing two of three components to folders specified by the user, with error reporting but without shortcuts:

msiexec /i "Regula Document Reader SDK.msi" /qn ADDLOCAL=ALL REMOVE=Samples DOCUMENT_READER_SDK="C:\Regula\SDK" RFID_READER_SDK="C:\Regula\RFID" SENDSTATISTICS=1 CREATESHORTCUT=0 CREATESTART=0

Command line for .EXE file

You can use the same command line for .EXE installation package, specifying it after /v option. Also you should use /s option to turn off windows and prompts from .EXE installation file.

Previous example when used with .EXE installation file will transform to the following command line:

"Regula Document Reader SDK.exe" /s /v"/qn ADDLOCAL=ALL REMOVE=Samples DOCUMENT_READER_SDK=\"C:\Regula\SDK\" RFID_READER_SDK=\"C:\Regula\RFID\" SENDSTATISTICS=1 CREATESHORTCUT=0 CREATESTART=0"

Please note that command line for .MSI installation file passed through /v option should be wrapped in double quotes. Any double quotes in command line should be escaped by backslash symbol \.