Virtual Agent Query URL format

The Virtual Agent Query URL can be either the Ajax location for the AI Query and the BMC Knowledge Management knowledge base query, or the link for the URL Query Link query type.

The URL contains the following parts:

• Main URL: The base URL for all uses. It is the first part of the URL statement, minus any tags and data described in this section.
• [QUERYTERMS]: The location of the actual query. This tag gets replaced with the query that is issued. It is required for all query types.
• [LINKLABEL] [/]: Valid only for the URL Query Link query type. The text between these tags is used as the text for the link. If these tags are missing, the actual URL for the link is used as the text for the link.
• [SEPARATOR] [/]: Valid only for URL Query Link query type. Different sites might require different separators between search terms. For example, some might require a space and others a plus sign (+). If this tag is specified, the spaces in the query terms are replaced with the value between these tags. If this tag is not specified, by default the spaces are converted to %20 in the query link.
• [BASEURL] and [BASEPATHEND]: Valid only for the BMC Knowledge Management query. When Ajax is used to retrieve knowledge base solutions, the format is an actual file path on the server and not an HTTP path to the document itself. The paths to the document converge and the final part of the path is common (whether it is the physical file path or the HTTP path).
  • [BASEURL] specifies the HTTP path up to the common point. The beginning of the physical path is replaced with this value.

  • [BASEPATHEND] provides the last part of the physical server path. This value is found in the physical path and any values before this value are replaced with the value specified in [BASEURL].

    Note

    The order of the tags and data is important. After the regular URL value for the Ajax call, the tag for [BASEURL] is required, then the value for the base URL, followed by the [BASEPATHEND] tag. The data completes the entire string.

Example 1 URL for Microsoft Office Online query

http://office.microsoft.com/en-us/results.aspx?qu=[QUERY][LINKLABEL]Office Online[/]

Example 2 URL for BMC Knowledge Management query

http://[SERVER]:8080/eschat/ardata?fa=rkmsearch&itemalias=results&terms=[QUERY]&lk=[QPARAM lk]