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 that was generated when the page was last synchronized. This ensures that the preview returned by the view action matches the data in your IDOL index. It can also 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
  • PDF
  • Thumbnail

To use one of these values, you must configure the connector to save a rendition for each page, by setting CreateImageRendition, CreateThumbnailRendition, or CreatePdfRendition to TRUE. You must set RenditionsFilePath so the renditions are saved to a folder that the connector can access. If you are generating images or thumbnails, you can choose the image format to use by setting RenditionImageFormat.

Type: String
Default: HTML
Required: No
Configuration Section: TaskName or FetchTasks
Example: ViewRenditionFormat=Image
CreateImageRendition=TRUE
RenditionsFilePath=\\server\web_renditions\
RenditionImageFormat=PNG
See Also:

CreateImageRendition

CreatePdfRendition

CreateThumbnailRendition

RenditionsFilePath

RenditionImageFormat