View

Accesses the content of a document in a repository, formats it as HTML, then returns the HTML for display.

You must set one of Reference and ViewUpload to specify the file that you want to view. If you use ViewUpload, you must send the View action as a POST request. If you send the Viewaction to a Distributed Action Handler (DAH) set up to distribute View requests by reference, DAH uses the Reference parameter for distribution, even if you upload a file with ViewUpload.

Example

http://12.3.4.56:9080/action=View&NoACI=True&Reference=http://news.bbc.co.uk/summary.pdf

This action requests the document summary.pdf from IDOL View Component. IDOL View Component resolves the reference to a URL, downloads the content, reformats it as HTML, and returns the HTML page.

Required Parameters

You must set one of the following parameters.

Parameter Description
Reference The reference of the document to convert.
ViewUpload The multipart/form-data upload of the file that you want to view.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
Boolean Whether to use phrases and query text for highlighting.
ConversionTimeoutSeconds The maximum number of seconds for a HTML conversion.
Cookie A cookie to forward.
DeleteOriginal Whether to delete the original document after converting it.
DownloadURLTimeout The number of seconds to wait when downloading a URL.
EmbedImages Whether to embed images in HTML output.
EndTag The tag to use to mark the end of a highlighted term. If you set MultiHighlight to True, you must set the StartTag and EndTag for each link term.
Highlight The mode to use for highlighting.
HighlightTagTerm Adds an attribute to the StartTag to indicate the term that is highlighted.
IgnoreCache Whether to convert the document again, even if it exists in the cache.
LanguageType The language type of the Links parameter.
Links Terms to highlight.
MultiHighlight Highlight multiple link terms with different HTML tags. If you set MultiHighlight to True, you must set the StartTag and EndTag for each link term.
NoACI Whether to format the results for display in a Web browser.
OEMEncryption Whether to OEM encrypt results.
OriginalBaseURL Whether to rewrite hyperlinks in the output document as IDOL actions.
OutputType How to process the document content during conversion.
Page The page of the document to display.
SecurityInfo The security information for the user that sends the request.
StartTag The tag to use to mark the beginning of a highlighted term. If you set MultiHighlight to True, you must set the StartTag and EndTag for each link term.
StripScript Removes script tags and their contents from documents.
URLPrefix The prefix to apply to links to subdocuments.
UseReferencePrefix Whether to use the configured ReferencePrefix.
ViewTemplate The template to use when converting the document content to HTML.

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.