TxP script element properties

This help topic describes the properties that are available for Transaction Perspective scripts. Many of these properties are captured automatically when a script is recorded, and many of them can be modified or added after the initial script recording.

The properties of a recorded script are displayed in the Script Viewer. Property details can be accessed (and edited) by clicking a property in the Script Viewer and using the Script Properties Editor.

Script

These properties pertain to the script as a whole.

Name

Supply a name for the script.

Description

You have the option to enter a custom script description in this field. Also, you may want to specify which pages are included, or whether the script is for a buying scenario or search scenario.

Cookies (Add button)

The Cookies section of the Script Properties Editor enables you to view, edit, or add cookies that simulate a returning visitor. To add a cookie, click Add. The Cookies section opens to enable you to add the Name, Domain, Path, and Value parameters, and to select whether the cookie is secure.

Cookies

Cookies

Multiple cookies can be added by clicking the Add button again after entering information for a cookie.

Files (Add button)

When a script contains a file-input element (for example, when you upload a picture to a Web page), you can associate a custom file input with the script.

Once a custom file is associated with a script, it is used whenever the playback engine encounters a file input in the script. The File option enables a script to simulate a more realistic file upload. Also, some Web sites will accept only certain types of files as input, so a custom file is needed.

Note

The maximum custom file size is 500KB. We also recommend that you add only small files (less than 50KB) to the script. Inserting large files significantly increases the file size of the script and will result in some performance degradation when saving or provisioning a script.

Certificates (Add button)

You can use the Digital Certificate option in KITE to associate a digital certificate with a script (multiple certificates can be associated with each script). You can do this by selecting from the list of available certificates stored on your system.

See Working with Digital Certificates for more information.

Virtual profiles (Edit profile button)

The Virtual Profiles feature enables you to create a set of alternative data fields that can be provisioned to different Keynote agents. The data fields can be used by any parametrized KITE setting.

See Working with Virtual Profiles for more information.

ActiveX (Add)

You can add an ActiveX component to a script. Click Add to open the ActiveX Control dialog, where you can enter ActiveX component details.

ActiveX control dialog

ActiveX control dialog

  • A CLSID is a globally unique identifier that identifies a COM class object.
  • ProgIDs present a human-readable version of the class identifier (CLSID) used to identify COM/ActiveX objects.

Hosts

This option lets you remap URLs to specific IP addresses. KITE and Keynote measurement agents will use the specified IP address whenever the associated URL is called for.

Domain exclusion

This option lets you exclude content from specific domains from your scripts. You can specify a specific domain to exclude, or use a regular expression to specify the domain (after checking the Regular expression checkbox).

For example, you could use this regular expression:

.*rootdomain\.com.*

to exclude all content from .rootdomain.com.

Important

 Domain exclusion applies to content elements embedded on the Web page only, and cannot be used to prevent a navigation to a URL that is specified in a step in a script action. To prevent a navigation to a URL that is specified in a script step, you must delete that step.

Whitelisted domains for web privacy

This feature enables users of Keynotes Web Privacy solutions to specify domains using a regular expression that will be regarded as trusted and therefore not included in privacy tracking.

Script settings

  • Ignore Errors Within Frames - If enabled, errors that are triggered by frame contents are ignored.
  • Enable Alternative HTTP Encoding Handling - If selected, wininet will be used for decoding encoded contents (such as gzip) by Keynote agents. Disabled by default.
  • Report error if no network activity - If selected, an error will be reported for pages (actions) that do not include network activity.
  • Auto-close windows dialogs - Default is no (unchecked). If yes is selected, all Windows dialogs (such as JavaScript alert windows) will be closed during playback.
  • JavaScript errors are fatal - If selected, JavaScript errors encountered on a page will be treated as fatal errors.
  • Send Keynote User Agent Mark - Default is “yes”. If “yes” is selected, all requests sent by KITE will be marked with a user agent string KTXN and a code that indicates the Keynote agent ID, time the request was made, etc. Example: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; KTXN B410824613U297781 )

  • Send Custom User Agent Mark - Default is unselected. If selected, all requests sent by KITE will be marked with a custom user agent string, as specified in the Mark field. If Timestamp is selected, a timestamp will be included as well as the custom mark.
  • IE Browser Mode - Choose the browser mode to be used when this script is run on Keynote measurement agents. This does not affect the script playback in KITE on the local computer, which is determined by the KITE option setting.

Action

An action is a script element with one or more steps and concludes with a step that performs a navigation to a new page.

You can change the name of the Action by selecting the name and typing in a new name, or right-clicking the Action and selecting Rename. The new Action name will be used as the page alias for the script page that corresponds to the Action.

Each Action has four parameters that may be edited:

Description

Custom description for action. You can enter a description for the action. By default, the description is the title of the HTML page the Action navigates to.

Validation

Rules for validating the results of action. You can add required text (text that must be present on the page for the navigation to be valid), or error text (text that may not be present on the page).

  • If required text is missing, an error will be reported (99100 - Required text not found).
  • If error text is present, an error will be reported (99101 - Error text found).

{:#anchor_timeout}

Timeout

Page timeout. Optionally, set a value for the time out of the transaction page.

On the Script level there is an overall timeout for the whole transaction that by default is a minimum of 60 seconds, plus 12 seconds for each page over five in the transaction. Additionally, you can set specific timeouts for any page in the transaction by specifying a timeout on that page’s associated Action.

Completion

There are four types of completion event indicating that an action is completed and the script can move to the next action:

  • Browser
  • DOM
  • HTTP Messages
  • Timer

Browser and DOM may both be applied to an action. HTTP Messages and Timer may not be combined with each other or the other types.

See Completion Events for more information.

Add ignored navigation errors

You can add a list of one or more navigation errors that will be ignored during script playback.

To do so, select an Action, right click, and select Add Ignored Navigation Errors.

Right-click Add Ignored Navigation Errors and select Add Error, or add URL and Errors.

Add ignored nav. errors

Add ignored nav. errors

Remap errors

Remap Errors is used to map an error code to another code. It will set Start and End error code to a new value. For example:.

“-99100” (Missing Keyword) can be remapped to “0” (successful datapoint).

KITE will still report “-99100 Missing Keyword” error on local playback, but good datapoints will be reported when the measurement is deployed to Keynote agents and viewed in MyKeynote.

To exclude 99002 errors from your alarms, follow these steps:

  • Remap the Page Condition Changed (-99002) error to error codes that are available for exclusion in the Alarms tab, or to ‘0’ for reporting it as a successful data point.

For remapping the -99002 error, follow these steps:

  1. Open the script in KITE.
  2. Click Script Properties Editor options and expand the Remap errors tab.
  3. Enter Start and End range of error codes to be remapped to New error code. For example, to remap -99002 errors to -99001 errors: Enter Start and End Value as -99002 and New value as -99001.
  4. Save the script.