GetLink

Retrieves a subdocument of a document that has been displayed with the View action, formats it as HTML, then returns the HTML for display.

Example

http://12.3.4.56:9080/action=GetLink&NoACI=True&LinkSpec=somedata

This action requests a subdocument from IDOL View Component. IDOL View Component resolves the LinkSpec and returns the subdocument.

Required Parameters

The following action parameters are required.

Parameter	Description
LinkSpec	The link specification that references the subdocument 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.
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.
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 use OEM encryption for results.
OutputType	How to process the document content during conversion.
Page	The page of the document to display.
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.
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.

Comments

If you set MultiHighlight to True, you must set the StartTag and EndTag for each link term.