Open topic with navigation

# Highlight

Allows you to highlight link terms in the text that you submit.

Set Text to the text that you want to highlight. You can also submit an IDX or XML document. In this case, you must set TextParse to `True`.

Set Links to the terms that you want to highlight in the specified Text. You can provide a list of stemmed terms, or you can specify a query string. If you specify a query string, you must also set Boolean to `True`.

## Example

    http://12.3.4.56:9000/action=Highlight&Text=Gene analysis discovered methods to determine the exact sequence of nucleotides that compose a specific gene&Links=nucleotid+gene+analysis

This action uses port `9000` to send the specified text to HPE IDOL Server, which is located on a machine with the IP address `12.3.4.56`. HPE IDOL Server then returns a version of the submitted text, highlighting all terms that stem from the links `nucleotid`, `gene`, and `analysis`.

XML output:

    Gene <font color="red">analysis</font> discovered methods to determine the exact sequence of <font color="red">nucleotides</font> that compose a specific <font color="red">gene</font>

The XML output also an `<autn:highlighted>` tag to indicate whether any of the text was highlighted.

## Parameters

Parameter | Description | Required
--- | --- | ---
Boolean | The format of the terms in Links. |
DetectLanguageType | Whether to detect the language type of the text. |
EndTag | The end HTML tag to apply to highlighted terms. |
FieldText | Add a field restriction to results. |
FieldRestriction | Restricts a query to specified fields. | See Comments
HardFieldRestriction | Whether to use only the fields that you list in the FieldRestriction parameter for matching. | See Comments
Highlight | Whether to highlight link terms or sentences in the results. |
HighlightTagTerm | Adds an attribute to the StartTag to indicate the term that is highlighted. |
IgnoreSpecials | Treat special characters as normal characters in query syntax. | See Comments
LanguageType | The language type of the terms. |
Links | The terms to highlight in the Text. | Yes
MatchAllTerms | Return only results that match all terms in a query. | See Comments
OutputEncoding | The encoding to convert the results to. |
StartTag | The opening HTML tag to apply to highlighted terms. |
Stemming | Disable stemming so that only documents that contain exact matches of query terms can return as results. | See Comments
Synchronous | Whether to run the action synchronously or asynchronously. |
Text | The text to highlight. | Yes
TextParse | The format of the Text. |
XMLFormat | Interprets the text as XML or 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

To use the following parameters, you must also set Boolean to `True`:

- FieldRestriction

- HardFieldRestriction

- IgnoreSpecials

- MatchAllTerms

- Stemming

You must also set Boolean to `True` if you use the case-sensitive term operator (`~Term`).

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close Send Documentation Feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm