Theses commands are used to fetch, preview, or or generate a thumbnail for a document. You can use them from the Java FetchClient. These commands are suppted by the .NET Fetcher class using the built-in properties only.
About Thumbnails
Search Server actions to generate thumbnails
To generate thumbnails, the Search Server:
• Calls the connector fetcher to retrieve the original document from the data source.
• Calculates the thumbnails (it generally uses the convert to do that).
• Sends the document and the calculated thumbnails.
Behavior and tips
• The thumbnail always has the same proportion. If your document does not have the same proportion, a margin will be added to the picture to fill missing gaps.
• The thumbnail is scaled to its MINIMUM value. Let us say you have witdh=90 and height=1200, the width value is the one guiding the downscale.
• Be careful, if your BASEPORT+10 is accessible, anyone can generate thumbnails and if your cache is not properly configured, someone malicious could spam thumbnail generations with huge resolution values.
• The value of the source parameter does not necessarily have to be the same as the connector used to index the document. Remind that the source parameter is required to specify a fetcher to the thumbnails process. For example, you can use a JDBC connector to index your documents, and also create a "dummy" Files connector to generate thumbnails as the JDBC connector does not have a fetcher. This workaround is useful only if you have your own search front end, not if you are using a Mashup UI application.
Global Parameters
Parameter
Description
source:string
The source connector name.
uri:string
The URI of the document to fetch. The root used in the configuration of the source connector (file system connector) is important.
For example, if the root in the connector is /data/user1/workspace/customers/cv and you have a document named myexample.doc, you must encode the uri parameter as follows: uri=%2F%252Fdata%252Fuser1%252Fworkspace%252Fcustomers%252Fcv%2Fmyexample.doc
Otherwise you get a bad file url root exception.
security:string
Security token for the fetch request
enforce_security:boolean
Specifies whether security tokens must be enforced
all_parts:boolean
Requests all parts of the document
part:string
Selects the part of the document to retrieve
Fetch Parameters
It is available at http://SEARCH_API_HOST:SEARCH_API_PORT/fetch
Parameter
Description
override_filename:boolean
Forces the file name in the Content-Disposition header
filename:string
New file name to use
override_contenttype:boolean
Forces the MIME Content-type in the Content-Disposition header
contentType
New MIME Content-type to use
Preview Parameters
It is available at: http://SEARCH_API_HOST:SEARCH_API_PORT/preview?uri=uri_document&source=connector_name&q=%23all
Parameter
Description
q:string
User query string
l
User query language
start_page:integer
Page of the document to preview
pages:integer
Number of pages of the document to render
rewrite_base:boolean
Base HTTP path for links rewriting. You should set this to the base URL under which you are proxying the preview request.
Thumbnail Parameters
It is available at http://SEARCH_API_HOST:SEARCH_API_PORT/thumbnail
Parameter
Description
width:integer
The width in pixels of the image generated. If not set, the default value in the searchApi.xml is used.
height:integer
The height in pixels of the image generated. If not set, the default value in the searchApi.xml is used.
start_page:integer
Use this parameter to specify the page of the document to thumbnail. For example, a value of 1 is for page 1.