52
Analysis Data” setting is enabled on the Preview ontent Source (see section ‘Configuring the gatherer
service’). The progress bar increments as the highlighted pages are processed. Note that it does not
reflect if the highlighted pages have been loaded by the browser, but only if they are available on the
server.
DocumentPreviewSuggestedPagesPageNumbersPercentageElement
Shows the progress of DocumentPreviewSuggestedPagesPageNumbersProgressBarElement as a text
message with the percentage normalized between 0 and 100. This Item Element can be added without
adding the DocumentPreviewSuggestedPagesPageNumbersProgressBarElement element.
DocumentPreviewDocumentInfoPageCountTitlePrefixElement
Shows a text prefix for displaying the progress of loading pages to the user. This Item Element is
typically shown just before the DocumentPreviewDocumentInfoLoadedPageCountElement element.
This text is localized in the resource files but can also be customized through the UI.
DocumentPreviewDocumentInfoLoadedPageCountElement
Shows how many pages that have been send to the browser as a text message. This Item Element is
typically shown just before the DocumentPreviewDocumentInfoPageCountTitleMiddleElement element.
DocumentPreviewDocumentInfoPageCountTitleMiddleElement
Shows a text separator for displaying the progress of loading pages to the user. This Item Element is
typically shown just before the DocumentPreviewDocumentInfoPageCountElement element. This text is
localized in the resource files but can also be customized through the UI.
DocumentPreviewDocumentInfoPageCountElement
Shows the total number of pages in the document or webpage. If the “Include Text Analysis Data”
setting is enabled on the Preview ontent Source (see section ‘Configuring the gatherer service’), the
number is displayed immediately. The number is then updated when the realtime processing is
completed if the document has changed since it was pre crawled. This Item Element is typically shown
just before the DocumentPreviewDocumentInfoPageCountTitlePostfixElement element.
DocumentPreviewDocumentInfoPageCountTitlePostfixElement
Shows a text postfix for displaying the progress of loading pages to the user. This text is localized in the
resource files but can also be customized through the UI.
InDocumentSearchElement
This Item Element is not shown visually but acts as a container for the other InDocumentSearch Item
Elements. When turning the ‘In Document Search’ feature On or Off in the UI, this Item Element is
displayed or hidden accordingly.
InDocumentSearchTextBoxElement
Shows a text box in which to type text to search for in the document or web page. This text will then be
highlighted in the pages (replacing any current highlighting) and the suggested pages will also be
updated accordingly. Pressing the Enter key will trigger the ‘In Document Search’ processing.
InDocumentSearchButtonElement
Shows an image working as a button for triggering the ‘In Document Search’ processing of the text
specified in InDocumentSearchTextBoxElement.
InDocumentSearchButtonCancelElement
Shows an image working as a button for canceling the ‘In Document Search’ processing. It also reverts
back to the original pages with the original highlighting and suggested pages.
53
DocumentPreviewElement
Shows a panel for displaying all pages in a document or webpage. First time this Item Element is
opened, it starts the processing flow which will then populate this Item Element with
DocumentPagePreviewTemplates, one for each page in the document.
DocumentPreviewTriggerIconElement
Shows an icon representing if the DocumentPreviewElement is opened or closed. Clicking this icon then
opens or closes the DocumentPreviewElement accordingly. If the DocumentPreviewElement has not yet
been opened it starts the processing flow.
DocumentPreviewTriggerTextElement
Shows a link button with text representing if the DocumentPreviewElement is opened or closed.
Clicking this link button then opens or closes the DocumentPreviewElement accordingly. If the
DocumentPreviewElement has not yet been opened it starts the processing flow.
Example of a simple Preview Template
The following template shows and example of the minimum required formatting to make preview fully
operational and using all elements in the live cycle preview. All elements are optional and can be rearranged to
your liking, but functionality is lost if they are excluded from the template.
<span id="FirstPagePreviewTemplate" style="display:none;">
<div class="PagePreviewElement" />
<div class="PagePreviewPageCountElement" />
</span>
<span id="DocumentPagePreviewTemplate" style="display:none;">
<div class="PagePreviewElement" />
</span>
<span id="DocumentPreviewTemplate" style="display:none;">
<div>
<div class="DocumentPreviewClickToProcessElement" />
</div>
<span class="DocumentPreviewDocumentInfoLoadingElement" style="display:none;">
<div class="DocumentPreviewDocumentInfoPageCountLoadingTitleElement" />
<div class="DocumentPreviewSmallLoadingIconElement" />
</span>
<span class="DocumentPreviewSuggestedPagesLoadingElement" style="display:none;">
<div class="DocumentPreviewSuggestedPagesIconElement" />
<div class="DocumentPreviewSuggestedPagesPageNumbersTitleElement" />
<div class="DocumentPreviewSuggestedPagesPageNumbersElement" />
<div class="DocumentPreviewSmallLoadingIconElement" />
</span>
<span class="DocumentPreviewSuggestedPagesElement" style="display:none;">
<div class="DocumentPreviewSuggestedPagesIconElement" />
<div class="DocumentPreviewSuggestedPagesPageNumbersTitleElement" />
<div class="DocumentPreviewSuggestedPagesPageNumbersElement" />
</span>
<span class="DocumentPreviewSuggestedPagesElement" style="display:none;">
<div class="DocumentPreviewSuggestedPagesPageNumbersProgressBarElement" />
<div class="DocumentPreviewSuggestedPagesPageNumbersPercentageElement" />
</span>
<span class="DocumentPreviewDocumentInfoElement" style=" display:none;">
<div class="DocumentPreviewDocumentInfoPageCountTitlePrefixElement" />
<div class="DocumentPreviewDocumentInfoLoadedPageCountElement" />
<div class="DocumentPreviewDocumentInfoPageCountTitleMiddleElement" />
43
<div class="DocumentPreviewDocumentInfoPageCountElement" />
<div class="DocumentPreviewDocumentInfoPageCountTitlePostfixElement" />
</span>
<span class="InDocumentSearchElement" style="display:none;">
<input class="InDocumentSearchTextBoxElement" type="text" style="display:none;" />
<img class="InDocumentSearchButtonElement" style="display:none;" />
<img class="InDocumentSearchButtonCancelElement" style="display:none;" />
</span>
<div class="DocumentPreviewElement" />
</span>
<span id="DocumentPreviewTriggerTemplate" style="display:none;">
<div class="DocumentPreviewTriggerIconElement" />
<div class="DocumentPreviewTriggerTextElement" />
</span>
How to configure Preview for specific infrastructures
Ontolica Preview is designed to be just as versatile as real life infrastructures of SharePoint farms are. It can be
optimized to use the abilities or scale with the limitations of your hardware as well as adjust to your available
bandwidth, disk space, number of documents/websites etc. etc.
Configuring Ontolica Preview to meet your exact requirements includes changing both the behavior of the
Preview services as well as the Front-end settings.
Trimming Ontolica Preview settings to available memory on servers
Ontolica Preview uses memory caching a number of different places to optimize performance. Preview images
are cached in the IIS processes to optimize performance and reduce database access. The Preview Gatherer
also uses caching by downloading documents to a queue to avoid having the document converter waiting for a
document to be downloaded before it can be processed.
Farms with limited memory (4 Gigabytes or less per front-end server)
Depending on how Preview is used by your users consider the following changes.
Turning of memory caching for full document previews.
This can significantly improve access times to you web applications, but it causes more database access
when accessing same full document preview repeatedly and repeated previews of the same
documents load slower. This change requires that you have installed the Preview database.
Turning of memory caching for In Document search.
This can significantly improve access times to you web applications, but it causes more database access
when accessing same full document preview repeatedly and repeated previews of the same
documents load slower. This change requires that you have installed the Preview database.
Reducing Download queue size on the Gatherer service search.
If you have many large documents, then reducing the Download queue size to the same number as you
have the Parallel conversion processes, causes the Gatherer service to use less memory but it can slow
down the Gatherer service if it often waits for documents to download. This only affects memory
consumption on the server where the Gatherer service is running.
18
Turning off In Document search.
If users are often using this function, turning it off can significantly improve access times to you web
applications as searching inside the documents is both CPU and Memory intensive.
Confirming Successful Deployment and Configuration
Once you have deployed a Preview column to a document library or a Preview web part to a search or
Aggregate center, and completed the pre-indexing of the first-page thumbnail, you can confirm a successful
deployment by checking the following sections.
First page previews
A thumbnail with a preview of the first page is displayed in the first column of the document library or
Aggregate center or next to search results in a search center. This is only the case when the content sources,
where the document library is located, have been successfully crawled by the Ontolica Gatherer Service and
processed by the Ontolica Conversion Service.
Full Document Previews
When you click the first page preview in a document library, or the “Show document preview” button in
search/Aggregate centers, the full document preview strip opens just underneath that row. If the document
has many pages then a horizontal scroll bar will appear just below the preview images so that you can scroll to
see all pages or to locate a particular page.
4
On the right top of preview images, the number of total pages will also be displayed. The strip and preview
images disappear if user clicks the preview icon again. Putting the mouse over a page in the full document
preview strip will display a zoomed version of a preview image.
If you click the zoomed version of the preview image then the full preview version of the page will be opened.
Documents you may be interested
Documents you may be interested