Click & Script API Notes

This section lists general notes about the Web functions.

Regular expressions

You can specify a regular expression for most object descriptions, by preceding the text with "/RE" before the equals sign. For example:

web_text_link("Manage Assets", 
        DESCRIPTION, 
        "Text/RE=(Manage Assets)|(Configure Assets)", 
        ACTION,
        "UserAction=Click",
        LAST);

See the Function Reference for more details.

Back to top

Ordinals

The Ordinal attribute is a one-based index to distinguish between multiple occurrences of objects with identical descriptions. In the following example, the two recorded web_text_link functions have identical arguments, except for the ordinal. The ordinal value of 2, indicates the second occurrence.

web_text_link("Manage Assets", 
        DESCRIPTION, 
        "Text=Manage Assets", 
        "FrameName=main", 
        ACTION,
        "UserAction=Click",
        LAST);
web_text_link("Manage Assets_2", 
        DESCRIPTION, 
        "Text=Manage Assets", 
        "Ordinal=2", 
        "FrameName=main", 
        ACTION,
        "UserAction=Click",
        LAST);

Back to top

Empty strings

There is a difference between not specifying an argument and specifying it as an empty string. When you do not specify an argument, VuGen uses the default value or ignores it. When you list an argument, but assign it an empty string as a value, VuGen attempts to find a match with an empty string or no string at all. For example, omitting the id argument instructs VuGen to ignore the id property of the HTML element. Specifying "ID=" searches for HTML elements with no id property or with an empty ID.

web_text_link("Manage Assets_2", 
        DESCRIPTION, 
        "Text=Manage Assets", 
        "Id=", 
        "FrameName=main", 
        ACTION,
        "UserAction=Click",
        LAST);

Back to top