WebVerifyHtmlBoundEx Function

Action

Parses the HTML response data and verifies the specified string within the boundaries. If the verification condition is not met, an error is raised. The severity of this error can be specified. The result of the verification can be retrieved by an optional out-parameter. A subsequent low-level web function will not return a value until the request has finished. A cache hit is not performed unless the WEB_FLAG_DONT_FORCE_LOAD option is set. The verification is done even if this option is set and the verified request or a certain part of a page is a cache hit.

When verifying/parsing an HTML page that consists of multiple frames, you can specify which frame document to verify/parse by specifying the sFrame parameter. By default, all HTML documents of the HTML page are scanned. This applies to HTML pages that are retrieved through a page-level command like WebPageUrl or WebPageLink.

It is important to know that all parsing and verification functions must be specified before the Web API call for which the response data should be parsed/verified. You can specify multiple parse/verification functions before a Web API call. The order of the parse/verification functions is not relevant (Exception: WebParseDataBound and WebVerifyDataBound using the flag WEB_FLAG_SYNCHRON).

This verification feature can be enabled/disabled globally (Profile Settings > Web > Verification > HTML > HTML verification).

Note: This function can be added automatically to your script using the visual verification functionality of TrueLog Explorer.

Include file

WebAPI.bdh

Syntax

WebVerifyHtmlBoundEx( in  sLeftBoundary   : string,
                      in  nLeftOccurrence : number,
                      in  sRightBoundary  : string,
                      in  sVerify         : string,
                      in  nOptions        : number optional,
                      in  sFrame          : string optional,
                      in  nSeverity       : number optional := SEVERITY_ERROR,
                      out bSuccess        : boolean optional );

Return value

none

Parameter	Description
sLeftBoundary	Left boundary of the HTML content to compare.
nLeftOccurrence	The sLeftBoundary has to be found nLeftOccurrence times, before the verification process starts and the right boundary is searched (optional). The default value is one. Provide WEB_OCCURENCE_LAST to specify the last occurrence.
sRightBoundary	Right boundary of the HTML content to compare.
sVerify	String to compare with the parsed HTML content.
nOptions	(optional) WEB_FLAG_CASE_SENSITIVE If this flag is set the string compare operation is case sensitive. WEB_FLAG_IGNORE_WHITE_SPACE If this flag is set all white spaces are ignored. WEB_FLAG_DONT_FORCE_LOAD Specify this option to enable caching for subsequent request. Note that this may lead to unpredictable behaviour, because the verification may only cover certain parts (which are loaded) of a page. WEB_FLAG_RULE Specify this flag to perform the verification on every subsequent web function. Verification functions with this flag are usually located in the TInit transaction. Call WebCancelAllRules() to disable all verification rules. Important: The option WEB_FLAG_RULE should only be used in the `INIT` transaction or in combination with the WebCancelAllRules function.
sFrame	Frame that gets searched for the content (optional). If this parameter is omitted the whole page is scanned.
nSeverity	Optional: Severity of the error that is raised if the verification fails. Can be one of the following values: SEVERITY_SUCCESS: Success; no error (numerical value: 0) SEVERITY_INFORMATIONAL: Informational; no error (numerical value: 1) SEVERITY_WARNING: Warning; no error (numerical value: 2) SEVERITY_ERROR: (Default) Error; simulation continues (numerical value: 3) SEVERITY_TRANS_EXIT: Error; the active transaction is aborted (numerical value: 4) SEVERITY_PROCESS_EXIT: Error; the simulation is aborted (numerical value: 5)
bSuccess	If a variable is provided, it will receive the result of the verification (optional).

Example

dcltrans
  transaction TMain
  var
    bResult: boolean;
  begin
    WebVerifyHtmlBoundEx("Begin", 2, "X.X", "End ");
    WebPageUrl("http://mycompany.com/");
    WebVerifyHtmlBoundEx("Begin", 2, "X.X", "End ", 0, NULL,
SEVERITY_WARNING);
    WebVerifyHtmlBound("Shop", "City", "ing", WEB_FLAG_CASE_SENSITIVE);
    WebUrl("http://mycompany.com/Shop/default.htm");
    WebVerifyHtmlBound("Name:", "Age", "Smith",
WEB_FLAG_IGNORE_WHITE_SPACE, "Name", SEVERITY_ERROR, bResult);
    WebPageUrl("http://mycompany.com/frame/framea.html");
    if not bResult then      Print("Verification failed");    end;  end TMain;