ViewRenditionFormat
Specifies what to return in response to a view action request.
The default value of this parameter is HTML
. The connector returns the HTML source of the web page at the time of the view action request. This requires no additional configuration.
If you prefer, you can configure the connector to return an image, thumbnail image, or PDF rendition of the web page. This can result in a better preview because rendering HTML returned from the view action might not work well if a page requires external resources such as stylesheets and scripts.
To return an image, thumbnail image, or PDF, set this parameter to one of the following values:
Image
Thumbnail
PDF
When generating images or thumbnails, you can choose the image format to use by setting RenditionImageFormat.
The image, thumbnail, or PDF file returned by the view action will, by default, show the page at the time the view action runs. If you prefer, you can configure the connector to save renditions when it synchronizes the web pages. This has the advantage that the returned preview shows the state of the page at the time it was ingested. The view action is also likely to be faster, because the rendition is already stored on disk.
To configure the view action to return an image, thumbnail, or PDF file that was generated during the last synchronize cycle, you must:
- Set this parameter to
Image
,Thumbnail
, orPDF
. - Configure the connector to save a rendition for each page, by setting CreateImageRendition, CreateThumbnailRendition, or CreatePdfRendition to
TRUE
. - Set RenditionsFilePath so the renditions are saved to a folder that the connector can access.
Type: | String |
Default: | HTML |
Required: | No |
Configuration Section: | TaskName or FetchTasks |
Example: | ViewRenditionFormat=Image
|
See Also: |