How to update Document Reader SDK from a local ftp server

If your workstation with a Regula document reader connected to it has an active Internet connection, you can install database updates automatically when they are available. If it is not possible for some reason to provide an Internet connection for every PC with the document reader, you can set up automatic download and installation of the database updates from your local FTP server. Please perform the following steps:

  1. Download an update file from our server:

for SDK versions 4.XX and lower:

for SDK versions 5.XX and higher:

  1. Place this file in the following ftp server folder:

for SDK versions 4.XX and lower:

  • <root>/Updates/WorldDocs/

for SDK versions 5.XX and higher:

  • <root>/Updates/x86/FullAuth/ - for x86 installation;
  • <root>/Updates/x64/FullAuth/ - for x64 installation.


It is extremely important to maintain the exact hierarchy and naming of the directories. This structure is necessary for the proper organization and identification of update files depending on the system architecture (x86 or x64). Any deviations from this structure may lead to errors when downloading and installing updates.


As shown in this screenshot, the local directory containing the update files is mounted directly in the root directory of the FTP server. As a result, you should have the following structure:

Please note that the update files should have the following names:

for SDK versions 4.XX and lower:

  • data_x.y.z.n.dat

for SDK versions 5.XX and higher:

  • data_xxxxxx.dat

While updating the database Document Reader application will check this number against the current database version number and will download and install the update only if it is larger.

  1. Set up every workplace with a Regula document reader to automatically download the updates from your local ftp server. There are two ways to do so:

With .INI file. Place the following parameters to a configuration file RegulaReader.ini, which is located by default in a C:\ProgramData\Regula\Document Reader SDK folder:

[Custom FTP updates settings]
Host=<server hostname>
User=<user with file read and directory listing access>


If you make a fresh installation of Document Reader SDK, this RegulaReader.ini file will be copied to local user folders after the first run of the Document Reader application. Otherwise, you should make the same changes for all the users. Search for RegulaReader.ini files in C:\Users\username>\AppData\Local\Regula\Document Reader SDK folders and add mentioned above parameters.

With custom application. Initialize the following properties of a COM-server in your custom application for the document reading:

CustomUpdateServerHost  = <server hostname> 
CustomUpdateServerUsername  = <user with file read and directory listing access>
CustomUpdateServerPassword = <password>
DoCheckUpdates = TRUE
DoSilentDBUpdate = TRUE
Was this article helpful?
1 out of 1 found this helpful



Please sign in to leave a comment.

Articles in this section

See more