You are here: Overviews > Installing the dtSearch Engine
Close
dtSearch Text Retrieval Engine Programmer's Reference
Installing the dtSearch Engine

How to install the dtSearch Engine with your application.

To install the dtSearch Engine with your application on end-users' machines, install the following files into the same directory as the executable file that will be using the Engine. Please see the table at the end of this article for links to additional specific instructions for Java and .NET applications. 

 

Data files  

File
Purpose
default.abc
Custom alphabet file (optional)
thesaur.xml
Custom user thesaurus (optional)
stemming.dat
Stemming rules (optional -- needed if you want to use stemming)
noise.dat
Noise word list (optional -- needed if you want to create indexes that ignore noise words)
WordNet data files
WordNet thesaurus for synonym searching (optional)
CMAP files
Encoding information that helps the PDF file parser to extract text from Chinese, Japanese, or Korean PDF files that lack internal Unicode encoding data.
Configuration file specifying the location of the WordNet, CMAP, and ICU data files (optional)
Configuration file specifying the ICU libraries to load

 

For information on how dtSearch locates the data files, please see The HomeDir, PrivateDir, and TempFileDir option settings

The recommended way to deploy the data files is to (1) deploy the entire contents of the "data" folder as distributed with the dtSearch Engine, (2) deploy a homedir.xml file like the one included with dtSearch that specifies the location of the data folder, and (3) if ICU integration is enabled, deploy an icuconfig.xml file like the one included with dtSearch that specifies the location of the ICU components, and that references the ICU data files in the "data" folder. 

If ICU integration is not enabled, the icuconfig.xml file and the "unicode" folder in the dtSearch data folder must be omitted. 

If the WordNet thesaurus is not needed, the wordnet subfolder of the data folder can be omitted. 

 

Windows executable files - 32-bit  

File
Purpose
dten600.dll
dtSearch Engine (32-bit)
dtSearchNetStdApi.dll
.NET Standard API (required for applications using the .NET Standard API)
dtSearchNetApi4.dll
.NET API for for .NET 4.0 and later (required only for C#, VB.NET, or other VS.NET applications)
dtSearch.Spider4.dll
.NET Spider API for .NET 4.0. Required only for .NET applications that index web sites using the dtSearch.Spider classes.
dtsjava.dll
Java JNI API (required only for Java applications)
dtSearchEngine.jar
Java class interface (required only for Java applications)
viewers\dtv_ifilter.dll
External file parser to enable use of IFilters
viewers\dtv_rar.dll
External file parser to enable parsing of RAR archives
viewers\dtv_pdfcrypto.dll
External file parser to enable parsing of encrypted PDF files (see export notice below)
dts_svr.exe
Localhost-only HTTP server (use to highlight hits in
local PDF files, and to provide browser-based access to
lbvprot.dll
CD content in dtSearch Publish) Component to implement PDF hit highlighting without using HTTP.
icudt63.dll, icuin63.dll, icuuc63.dll, icuconfig.xml
ICU components (required for ICU Integration). See ICU Deployment for more information.

 

Windows executable files - 64-bit 

64-bit components are installed in the dtSearch Developer\bin64 folder.

File Purpose
dtengine64.dll dtSearch Engine (64-bit)
dtSearchNetStdApi.dll .NET Standard API (required for applications using the .NET Standard API)
dtSearchNetApi4.dll .NET API for .NET 4.0 and later (required only for C#, VB.NET, or other VS.NET applications)
dtSearch.Spider4.dll .NET Spider API for .NET 4.0. Required only for .NET applications that index web sites using the dtSearch.Spider classes.
dtsjava.dll Java JNI API for dtengine64.dll (required only for Java applications)
viewers\dtv_rar64.dll External file parser to enable parsing of RAR archives (64-bit)
viewers\dtv_pdfcrypto64.dll External file parser to enable parsing of encrypted PDF files (see export notice below)
icudt63.dll, ICU components (required for ICU Integration). icuin63.dll, See ICU Deployment for more information. icuuc63.dll, icuconfig.xml

 

UWP executable files - 32-bit

File
Purpose
dtSearchEngine_Uwp_Win32.dll
dtSearch Engine (32-bit) function-call interface
dtSearchUwpApi.dll
C# and VB API wrapper for dtSearchEngine_Uwp_Win32.dll

 

UWP executable files - 64-bit 

64-bit components are installed in the dtSearch Developer\bin64 folder.

File
Purpose
dtSearchEngine_Uwp_x64.dll
dtSearch Engine (64-bit) function-call interface
dtSearchUwpApi.dll
C# and VB API wrapper for dtSearchEngine_Uwp_x64.dll

 

Linux executable files - 64-bit

File
Purpose
libdtsearch64.so
dtSearch Engine (64-bit) function-call interface
libdtsjava.so
JNI interface for Java applications (symbolic link to libdtsearch64.so)
dtSearchEngine.jar
Java class interface (required only for Java applications)
libicuuc.so.63.1, libiucdata.so.63.1, libicui18n.so.63.1, icuconfig.xml
ICU components (required for ICU Integration). See ICU Deployment for more information.
viewers\dtv_rar.so
External file parser to enable parsing of RAR archives.
viewers\dtv_pdfcrypto64.so
External file parser to enable parsing of encrypted PDF files (see export notice below)

 

Linux executable files - 32-bit

File
Purpose
libdtsearch.so
dtSearch Engine (32-bit) function-call interface
libdtsjava.so
JNI interface for Java applications (symbolic link to libdtsearch.so)
dtSearchEngine.jar
Java class interface (required only for Java applications)
viewers\dtv_rar.so
External file parser to enable parsing of RAR archives.
viewers\dtv_pdfcrypto64.so
External file parser to enable parsing of encrypted PDF files (see export notice below)

 

macOS executable files - 64-bit

File Purpose
libdtsearch64.dylib dtSearch Engine 64-bit) function-call interface
libdtsjava.dylib JNI interface for Java applications (symbolic link to libdtsearch64.so)
libicuuc.63.1.dylib, ICU components (required for ICU Integration). libiucdata.63.1.dylib, See ICU Deployment for more information. libicui18n.63.1.dylib, icuconfig.xml
dtSearchEngine.jar Java class interface (required only for Java applications)

 

Licensing and Redistributables 

A license to distribute applications incorporating the dtSearch Engine also permits distribution of the other binary and data components listed above, to the same extent and subject to the same requirements applicable to the dtSearch Engine. Binary components not listed, such as dtindexer.exe, dtsearch.exe, or dtWebSetup.exe, may not be distributed with an application licensed to use the dtSearch Engine, unless the license expressly provides otherwise. 

External File Parsers 

External file parsers such as dtv_rar.dll and dtv_ifilter.dll should be installed in a folder named "viewers" under the folder where the dtSearch Engine is located (the "Home" directory). 

For more information on the Home directory and external file parsers, see Home and Private Directories

dtv_odbc.dll is not needed with dtSearch versions 7.54 and later. See Database files (*.mdb, *.dbf, *.csv)

Export Notice and Encryption 

PDF files can have two kinds of passwords: 

(1) A password that prevents any access to the file unless the user enters a password before opening it in Adobe Reader. dtSearch cannot index files with this type of encryption at all. 

(2) A password that prevents certain operations (printing, editing, etc.) only. This type of PDF file can be opened in Adobe Reader with no need to enter a password, but you may not be able to print the PDF file or copy text to the clipboard from the PDF file. 

To tell what kind of encryption is used in a PDF file, open the PDF file in Adobe Reader, click File > Document Properties, and click the Security tab. 

The following dtSearch Engine components include support for encryption beyond 40-bit RC4:

  • The crypto-enabled PDF file parsers for Windows and Linux: dtv_pdfcrypto.dll and dtv_pdfcrypto64.dll (Windows) and dtv_pdfcrypto.so and dtv_pdfcrypto64.so (Linux);
  • The UWP versions of the dtSearch Engine: dtSearchEngine_Uwp_Win32.dll, dtSearchEngine_Uwp_x64.dll.
  • The Mac version of the dtSearch Engine: libdtsearch64.dylib
  • In the .NET Standard SDK, all dtSearchEngine native library files except the Linux libdtSearchEngine.so files and the Windows dtSearchEngine.dll files. The UWP and macOS native libraries all include support for encryption beyond 40-bit RC4.

These components include support for decrypting PDF files with the following types of encryption: AES (256-bit, 128-bit), RC4 (128-bit, 40-bit). If these components are not installed, only 40-bit RC4 will be supported. In either case, only PDF files that can be opened without a password, and for which text extraction is permitted by the flags embedded in the file, can be indexed. 

dtSearch Corp. has received a classification ruling from the US Department of Commerce, Bureau of Industry and Security, that our export of dtSearch components is classified under ECCN 5D992 ( "mass market"): "This mass market encryption item is described in Section 742.15(b)(1) of the Export Administration Regulations (EAR). Authorization under Section 742.15(b)(1) of the EAR requires an annual self-classification report in accordance with Section 742.15(c) of the EAR." Because this classification is based on the marketing and purpose of the product, it would not necessarily cover other products that embed the dtSearch Engine. Therefore, we recommend that developers exporting these components consult legal counsel to determine the export classification of these components as applied to their products. All dtSearch license agreements require compliance with U.S. export laws and regulations. 

 

PDF Highlighting Plug-in 

If your application highlights search hits in Adobe Reader, a plug-in for Adobe Reader is needed to make hit highlighting work on machines with Adobe Reader X installed. For information on this plug-in and a link to download the current version of the plug-in, please see https://www.dtsearch.com/pdfhl

Windows Versions 

dtSearch Engine versions 7.73 and later are compatible with Windows Server 2016, Windows Server 2012, Windows Server 2008, Windows Server 2003, Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista, and Windows XP Service Pack 3. The dtSearch Engine will not work in Windows 2000, Windows 98, or Windows 95 due to lack of current Visual Studio support for these platforms. Both 32-bit and 64-bit versions of Windows are supported, and the engine comes in 32-bit (x86) and 64-bit versions. 

The dtSearch Engine (dten600.dll or dtengine64.dll) has no dependencies beyond the components that come with Windows. 

Virtual and Cloud Servers 

dtSearch can be used in Azure or Amazon instances, or any other virtualized server environment, as long as it contains a Windows x86 or x64 operating system and a file system. 

dtSearch indexes must be stored in a file system, in folders visible to Windows. Any number of indexes can be stored in a single file system (in separate folders or subfolders). 

WordNet Installation 

The WordNet concept network (which the dtSearch Engine uses for synonym searching) includes the following files: adj.dat, adv.dat, noun.dat, verb.dat, dtwdnet.ix. The total size of these files is about 20 Mb. The WordNet database is optional. If it is not present, dtSearch will not use it to expand synonyms in search requests. 

dtSearch looks for the WordNet database in a subdirectory named WordNet of the "Home" directory

CMAP Files Installation 

Adobe CMAP files provide encoding information that helps the PDF file parser to extract text from Chinese, Japanese, or Korean PDF files that lack internal Unicode encoding data. The copyright notice in these files grants permission from Adobe to redistribute the files without modification. 

dtSearch looks for the CMAP data files in a subdirectory named cmap of the "Home" directory.

Copyright (c) 1995-2019 dtSearch Corp. All rights reserved.