Retrieves a subdocument of a document that has been displayed with the View action, formats it as HTML, then returns the HTML for display.
http://12.3.4.56:4000/action=GetLink&NoACI=True&LinkSpec=somedata
This action uses port 4000
to request a subdocument from IDOL Server, which is situated on a machine with the IP address 12.3.4.56
. IDOL Server resolves the LinkSpec
and returns the subdocument.
Parameter | Description | Required |
---|---|---|
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. | See Comments |
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. | |
LinkSpec | The link specification that references the subdocument to view. | Yes |
MultiHighlight | Highlight multiple link terms with different HTML tags. | See Comments |
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 document. | See Comments |
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. |
Output | Writes output to a file. |
ResponseFormat | The format of the action output. |
If you set MultiHighlight to True
, you must set the StartTag and EndTag for each link term.
|