Application Perspective script properties

This help topic describes the properties that are available for Application 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 by clicking Settings in the Script Viewer pane at top-left. Property details can be accessed (and edited) by clicking a property in the Script Properties Editor at bottom-left of the KITE window for a recorded script.

Script

These properties pertain to the script as a whole.

Name

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.

Script environment

These properties are technical details about the script and are not user editable. However, you can select Change ID to replace the current id number assigned to the script. If you select this option, a new internal id will be automatically generated and assigned to the script, and all past measurement data will be lost.

Settings

Playback settings enable you to specify how you want your recorded script actions played back by Keynote agents (or KITE itself). These options affect the script only during playback (through the Keynote agents or the KITE Play/Verify command).

Download options affect page response time even though the agents do not act on any scripts, applets, etc. downloaded. If you choose to change the default options, your script is played back with those browser options turned off. Consider whether your typical user would have any of these options disabled on their browser.

You can use Playback Settings to help determine those elements of your Web site that affect page Response Time. For example, the same script played back with Download Images disabled will have a faster page Response Time than if it were played back with Download Images enabled, assuming images are a part of the target Web site.

Browser

Specify which browser you want the Keynote agents to simulate. This setting determines the value for the user-agent header sent with each HTTP request by the Keynote agents.

Secure protocol

Select a secure protocol for communicating with the website over SSL.

Supported values are:

  • SSL 2.0
  • SSL 3.0
  • TLS 1.0
  • TLS 1.1
  • TLS 1.2
  • TLS (All versions)

TLS (All versions) means that ApP will use any TLS version supported by the web server (but if the TLS version changes during the initial handshake, it will not renegotiate it as ApP does not support renegotiation). This is the default value, and will be used for the older scripts that do not have this option set.

Internet timeout

You can specify an Internet Timeout other than the 45-second default. This is in the event you have a script that includes a lengthy transaction (such as a search of a large database). If you know you have such a transaction in your script, set the Timeout option to an appropriate number of seconds so the transaction does not accidentally time out and cause a failed page when it plays back.

The Timeout value takes effect only for playback/verification.

Transaction timeout

Overall timeout for the transaction.

Enable cookies

Select whether Cookies will be enabled for the script.

Download base page only

When selected, this option causes only base page items to be downloaded. This includes HTML code as well as frame and iframe code. If the script navigates specifically to an image or similar object, that object will be downloaded. When Download Base Page Only is selected, Applets, Images, JavaScript will not be downloaded or executed, and CSS will not be downloaded or parsed.

Download applets

Download Applets encountered when the script is run.

Download images

Download Images encountered when the script is run.

Download JavaScripts

Download JavaScripts encountered when the script is run.

Execute JavaScripts

Execute JavaScripts encountered when the script is run.

Parse CSS

Parse CSS encountered when the script is run.

Digital certificates

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

See Working with Digital Certificates for more information.

User-configurable default script settings

In the Playback Settings dialog, you have the option to save the current settings as the default settings for new scripts. All new scripts begin with the default settings, and they can then be altered individually if needed.

Cookies

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

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.

Virtual profiles

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.

Headers

You can specify additional HTTP headers to be used by the script by clicking the Headers bar in the properties pane, then clicking Add Header. This will display the HTTP Headers dialog box. Enter a Name and Value, and click OK. The Name/Value pair will be displayed under the Headers bar on the properties pane.  Headers can also be added to individual actions in the script by right-clicking a navigation or click step in an action and choosing Add HTTP Headers. (See this help topic.)

Content exclusion

You can exclude elements that should not be downloaded in the script by clicking the Content Exclusion bar in the properties pane. You do this by specifying patterns to match against the URL of each page element. Enter the URL pattern, then click OK. The URL pattern is then displayed under the Content Exclusion bar on the properties pane.

For example, you could use the regular expression

.*rootdomain\.com.*

to exclude all content from .rootdomain.com.

Information about regular expression syntax can be found here.

Important

Content 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.

  • If the 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).

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

Action properties

An action is a script element that contains one or more steps, and with concludes with a step that performs a navigation.

Each Action has three 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 text that must be present on the page for the navigation to be valid, or text that may not be present on the page.

  • If the 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).

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