| |
The following table lists all available response message variables that can be used to enhance the organization of the default response message templates, or to create new templates from scratch. For more information about how to implement variables in a template (HTML), see Building a Custom Search Solution.
HINT: The repeating variables $$BeginLoop and $$EndLoop should not be used in a response message and will be ignored if used.
Table 8. Response Message Variables
| Variable Name | Description of Use |
|---|---|
$$ResponseNumber |
A numeric version of the response required of the user. |
$$ResponseMessage |
A text version of the response required of the user. Generally quite terse. Can often be used as a title. |
$$ResponseDescription |
A longer version of the message. This may include additional details or "see also" type information. |
$$URL |
Inserts the URL to use when the parent button is clicked. This must appear within the brackets of a button's conditional text section.The URL logic is generated by the server. |
$$Yes[text] |
If the Yes button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$No[text] |
If the No button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$OK[text] |
If the OK button is specified by Server logic, parses and inserts the conditional text into the response page.Currently used by PrintServlet when a print job exceeds the maximum print job size. |
$$Cancel[text] |
If the Cancel button is specified by Server logic, parses and inserts the conditional text into the response page.Currently used by PrintServlet when a print job exceeds the print job size warning limit. |
$$Continue[text] |
If the Continue button is specified by Server logic, parses and inserts the conditional text into the response page.Currently used by PrintServlet when a print job exceeds the print job size warning limit. |
$$Ignore[text] |
If the Ignore button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$Retry[text] |
If the Retry button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$Prev[text] |
If the Previous button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$Help[text] |
If the Next button is specified by Server logic, parses and inserts the conditional text into the response page. |
$$TemplateName |
See the description of this variable in Table 4. |
$$TemplateLocale |
See the description of this variable in Table 4. |
$$TemplateTheme |
See the description of this variable in Table 4. |
$$IncludeFile |
See the description of this variable in Table 4. |
$$Countervariablenumber, incrementnumber |
See the description of this variable in Table 4. |
$$ResultEncoding |
See the description of this variable in Table 4. |
$$QueryTemplateTheme |
See the description of this variable in Table 4. |
| |