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  

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. 

If ICU integration is not enabled, the icuconfig.xml file 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 x86  

Windows executable files - 64-bit x64 

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

UWP executable files - 32-bit

UWP executable files - 64-bit 

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

Linux executable files - 64-bit

Linux executable files - 32-bit

macOS executable files - 64-bit

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 ARM versions of the dtSearch Engine: dtengine_arm64.dll and dtengine_arm64ec.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 x86 and x64 dtSearchEngine.dll files. The UWP, macOS, and Windows ARM 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 (32-bit only). 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 32-bit dtSearch Engine (dten600.dll) has no dependencies beyond the components that come with Windows. 

Starting with version 7.96, the 64-bit dtSearch Engine (dtengine64.dll) requires the Microsoft Universal CRT for Windows, which is included with Windows 10 and automatically added by Windows update in some older versions of Windows. For more information see: Universal CRT Deployment. 

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.

Overviews