When PDF files are opened inside an Internet Explorer window, the #xml= syntax is not visible to the plug-in, so it cannot access the hit highlighting information. To work around this, the plug-in installs a browser helper object (BHO) in Internet Explorer.
For situations where the browser helper object is not used, such as applications that embed the WebBrowser control, the plug-in supports an alternative syntax, ?xml= instead of #xml=, that works without the browser helper object.
If your web site uses dtSearch Web, upgrade to dtSearch Web 7.67 or later to make the site compatible with the plug-in.
Your users who have Adobe Reader DC will need to download and install the plug-in, using this download link:
https://download.dtsearch.com/pdfhl/dtSearchPdfHighlighter.exe
(1) The lbview.exe viewer that comes with dtSearch 7.67 or later is needed to highlight hits in PDF files. If you have an older version, install dtSearch Publish, run the dtSearch CD Wizard and click "Change CD Settings", and check the box to "Update program files on the CD".
(2) When the CD starts, users who do not have the plug-in installed will see the page in /builtin/getplugin.html which has a prompt and link to download and install the plug-in.
(1) Server-based applications should support the IsPdfHighlighter verification protocol. To do this, your script that responds to PDF hit highlighting requests should respond to an IsPdfHighlighter request with a response that contains "YesPdfHighlighter". To make troubleshooting easier, you can embed this in a web page so you can see the response in a web browser. Example:
<html><head><title>Pdf Highlighter Confirmation</title></head><body><!-- YesPdfHighlighter --><P>This server supports PDF highlighting</P>
(2) Adobe Reader runs in a separate process from the web browser, so highlighting requests will not use the same web browser session that was used to search. As a result, session state and authentication done in the browser will not be available when the plug-in requests highlighting data from the server.
Desktop applications can highlight hits in PDF files by embedding a WebBrowser control and navigating to a URL that provides the location of the PDF file and the highlighting data.
(1) The URL your application uses has to use ?xml= instead of #xml=. This is necessary because the #xml= syntax does not work in an embedded WebBrowser control.
(2) Your application should generate file-based URLs to send highlighting data to the plug-in:
Call SearchResults.MakePdfWebHighlightFile as before to generate the highlight data.
Write the highlight data to a temp file.
Generate a URL with the location of the PDF file and the temp file with a unique name starting with "dtSearchPdfHits", like this:
c:\documents\example.pdf?xml=c:\temp\dtSearchPdfHits12345.xml
Call the WebBrowser's Navigate method with the URL to open the PDF file.
The name of the XML file with the highlight data must be in the format dtSearchPdfHits*.xml, because the dtSearch plug-in adds a whitelist entry to an Adobe Reader configuration file enabling access to files with this name pattern. If the name of the highlight file is not whitelisted, the plug-in may receive an "Access Denied" error when it tries to read the highlight data.
To help with troubleshooting, the dtspdfcfg.exe utility can enable a diagnostic logging mode in the plug-in. To run the dtspdfcfg.exe utility, click Start > All Programs > dtSearch PDF Search Highlighter > dtSearch PDF Search Highlighter Options.
Click the Diagnostics... button to access diagnostic options.
To create a diagnostic log, check the "Enable diagnostic logging" box. The plug-in will create a log file in the Windows TEMP folder, in a TEMP folder under the AppData\LocalLow folder, or in a "Low" folder under the Windows TEMP folder. Click "Zip logs for email" to collect all of the log files into a ZIP file.
You can also monitor the log in real time using the dbgview utility from the Microsoft Sysinternals web site. Because of Adobe Reader Protected Mode, you may need to run dbgview in low integrity mode to see the log. To do this, use the psexec utility (also available from the Microsoft Sysinternals web site) to launch dbgview.exe with the -l command-line switch, like this:
psexec -l dbgview.exe
For troubleshooting steps when highlighting does not work, please see:
Client-side troubleshooting: Troubleshooting steps
Server-side troubleshooting: Troubleshooting steps - Servers
Subject to the included license agreement, a user can download the plug-in from the dtSearch web site and install the plug-in on any number of computers within the user's organization. The plug-in may be used with any compatible product or web site -- not just dtSearch products or web sites that use the dtSearch Engine.
To comply with Adobe licensing requirements, the plug-in must be deployed using the dtSearchPdfHighlighter.msi installer and must be distributed only from the dtSearch download URL (https://download.dtsearch.com/pdfhl/dtSearchPdfHighlighter.exe).
Adobe Reader plug-ins can only be created using a digital signature issued by Adobe, which dtSearch Corp. must renew each year with permission from Adobe. Each time the license is renewed, the plug-in must be updated with a new digital signature, and renewal is subject to Adobe's discretion.
