Class Index

Classes


Class Context

Class Summary
Constructor Attributes Constructor Name and Description
 
A singleton object that contains the object model that represents the current Composition, it's contents, and it's current state.
Field Summary
Field Attributes Field Name and Description
{Composition}  
The Composition object that represents the top of the Composition object model.
{AppAction}  
A AppAction object that represents the current AppAction according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current AppAction if the current AppAction repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current AppAction.
{Band}  
A Band object that represents the current Band according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Band if the current Band repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Band.
{BrowserAction}  
A BrowserAction object that represents the current BrowserAction according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current BrowserAction if the current BrowserAction repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current BrowserAction.
{Chain}  
A Chain object that represents the current Chain according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Chain if the current Chain repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Chain.
{Checkpoint}  
A Checkpoint object that represents the current Checkpoint according to the context in which the current script is executing.
{Clip}  
A Clip object that represents the current Clip according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Clip if the current Clip repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Clip.
{CloseWebSocket}  
A CloseWebSocket object that represents the current CloseWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current CloseWebSocket if the current CloseWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current CloseWebSocket.
{DatabaseAction}  
A DatabaseAction object that represents the current DatabaseAction according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current DatabaseAction if the current DatabaseAction repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current DatabaseAction.
{Delay}  
A Delay object that represents the current Delay according to the context in which the current script is executing.
{EventGroup}  
A EventGroup object that represents the current EventGroup according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current EventGroup if the current EventGroup repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current EventGroup.
{EventMessageWebSocket}  
A EventMessageWebSocket object that represents the current EventMessageWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current EventMessageWebSocket if the current EventMessageWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current EventMessageWebSocket.
{Group}  
A Group object that represents the current Group according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Group if the current Group repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Group.
{If}  
An If object that represents the current If according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current If if the current If repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current If.
{(varies)}  
The object that represents the current context in which the current Script is executing.
{Message}  
A Message object that represents the current Message according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Message if the current Message repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Message.
{OpenWebSocket}  
A OpenWebSocket object that represents the current OpenWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current OpenWebSocket if the current OpenWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current OpenWebSocket.
{Page}  
A Page object that represents the current Page according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Page if the current Page repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Page.
{Script}  
A Script object that represents the current Script according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Script if the current Script repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Script.
{SendMessageWebSocket}  
A SendMessageWebSocket object that represents the current SendMessageWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current SendMessageWebSocket if the current SendMessageWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current SendMessageWebSocket.
{Switch}  
A Switch object that represents the current Switch according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Switch if the current Switch repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Switch.
{Target}  
A Target object that represents the current Target according to the context in which the current script is executing.
{TargetEventCloseWebSocket}  
A TargetEventCloseWebSocket object that represents the current TargetEventCloseWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventCloseWebSocket if the current TargetEventCloseWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventCloseWebSocket.
{TargetEventErrorWebSocket}  
A TargetEventErrorWebSocket object that represents the current TargetEventErrorWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventErrorWebSocket if the current TargetEventErrorWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventErrorWebSocket.
{TargetEventHandlerWebSocket}  
A TargetEventHandlerWebSocket object that represents the current TargetEventHandlerWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventHandlerWebSocket if the current TargetEventHandlerWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventHandlerWebSocket.
{TargetEventIdleWebSocket}  
A TargetEventIdleWebSocket object that represents the current TargetEventIdleWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventIdleWebSocket if the current TargetEventIdleWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventIdleWebSocket.
{TargetEventMessageDefaultWebSocket}  
A TargetEventMessageDefaultWebSocket object that represents the current TargetEventMessageDefaultWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventMessageDefaultWebSocket if the current TargetEventMessageDefaultWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventMessageDefaultWebSocket.
{TargetEventMessageWebSocket}  
A TargetEventMessageWebSocket object that represents the current TargetEventMessageWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventMessageWebSocket if the current TargetEventMessageWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventMessageWebSocket.
{TargetEventOpenWebSocket}  
A TargetEventOpenWebSocket object that represents the current TargetEventOpenWebSocket according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current TargetEventOpenWebSocket if the current TargetEventOpenWebSocket repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current TargetEventOpenWebSocket.
{Track}  
A Track object that represents the current Track according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Track if the current Track repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Track.
{Transaction}  
A Transaction object that represents the current Transaction according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Transaction if the current Transaction repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Transaction.
{UIAutomationScript}  
A UIAutomationScript object that represents the current UI Automation Script according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current UI Automation Script if the current UI Automation Script repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current UI Automation Script.
{Wait}  
A Wait object that represents the current Wait according to the context in which the current script is executing.
{integer}  
An integer value that represents the "repeat index" of the current Wait if the current Wait repeats, according to the context in which the current script is executing.
{integer}  
An integer value that represents the "play ordinal number" of the current Wait.
{String}  
The name of the location (from the Server List) on which the Composition is playing.
{Result}  
The ValidateDestinationResult object that represents the Result being produced for the currently playing Composition.
{String}  
The External Address of the server (from the Server List) on which the Composition is playing.
{String}  
The External Host of the server (from the Server List) on which the Composition is playing.
{String}  
The Host Name of the server (from the Server List) on which the Composition is playing.
{String}  
The Internal Address of the server (from the Server List) on which the Composition is playing.
{String}  
The IP of the server (from the Server List) on which the Composition is playing.
{String}  
The name of the server (from the Server List) on which the Composition is playing.
{String}  
The type of the server (from the Server List) on which the Composition is playing ("General" or "Load").
{String}  
The user ID of the user that started the current Composition playing.
{(varies)}  
If the current Script was called to perform validation for Message or Browser Action response, this property contains the value to be validated.
Method Summary
Method Attributes Method Name and Description
 
abortScript(errorText)
Immediately aborts play of the current Script, and considers the Script to have failed with the given error text.
{Java object}  
Creates and returns a Java object that implements the Java ScriptEnvironment interface, to be passed to Java code called from this Script.
{String[]}  
readFromURL(url, format, useCache, connectionTimeout, readTimeout)
This function has been replaced by the "readFromURL" function on the SystemUtilities object, and is maintained here only for backwards compatibility.
Class Detail
Context()
A singleton object that contains the object model that represents the current Composition, it's contents, and it's current state.

Accessible through the $context constant.

Field Detail
{Composition} composition
The Composition object that represents the top of the Composition object model.

{AppAction} currentAppAction
A AppAction object that represents the current AppAction according to the context in which the current script is executing. Null if there is no current AppAction.

{integer} currentAppActionIndex
An integer value that represents the "repeat index" of the current AppAction if the current AppAction repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current AppAction or the current AppAction does not repeat or has a repeat count of one.


{integer} currentAppActionPlayNumber
An integer value that represents the "play ordinal number" of the current AppAction. Starting with the number 0, each play of the AppAction is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current AppAction.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Band} currentBand
A Band object that represents the current Band according to the context in which the current script is executing. Null if there is no current "Band".

{integer} currentBandIndex
An integer value that represents the "repeat index" of the current Band if the current Band repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Band or the current Band does not repeat or has a repeat count of one.


{integer} currentBandPlayNumber
An integer value that represents the "play ordinal number" of the current Band. Starting with the number 0, each play of the Band is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Band.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{BrowserAction} currentBrowserAction
A BrowserAction object that represents the current BrowserAction according to the context in which the current script is executing. Null if there is no current BrowserAction.

{integer} currentBrowserActionIndex
An integer value that represents the "repeat index" of the current BrowserAction if the current BrowserAction repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current BrowserAction or the current BrowserAction does not repeat or has a repeat count of one.


{integer} currentBrowserActionPlayNumber
An integer value that represents the "play ordinal number" of the current BrowserAction. Starting with the number 0, each play of the BrowserAction is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current BrowserAction.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Chain} currentChain
A Chain object that represents the current Chain according to the context in which the current script is executing. Null if there is no current Chain.

{integer} currentChainIndex
An integer value that represents the "repeat index" of the current Chain if the current Chain repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Chain or the current Chain does not repeat or has a repeat count of one.


{integer} currentChainPlayNumber
An integer value that represents the "play ordinal number" of the current Chain. Starting with the number 0, each play of the Chain is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Chain.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Checkpoint} currentCheckpoint
A Checkpoint object that represents the current Checkpoint according to the context in which the current script is executing. Null if there is no current Checkpoint.

{Clip} currentClip
A Clip object that represents the current Clip according to the context in which the current script is executing. Null if there is no current Clip.

{integer} currentClipIndex
An integer value that represents the "repeat index" of the current Clip if the current Clip repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Clip or the current Clip does not repeat or has a repeat count of one.


{integer} currentClipPlayNumber
An integer value that represents the "play ordinal number" of the current Clip. Starting with the number 0, each play of the Clip is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Clip.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{CloseWebSocket} currentCloseWebSocket
A CloseWebSocket object that represents the current CloseWebSocket according to the context in which the current script is executing. Null if there is no current CloseWebSocket.
Since:
Build 7198

{integer} currentCloseWebSocketIndex
An integer value that represents the "repeat index" of the current CloseWebSocket if the current CloseWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current CloseWebSocket or the current CloseWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentCloseWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current CloseWebSocket. Starting with the number 0, each play of the CloseWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current CloseWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{DatabaseAction} currentDatabaseAction
A DatabaseAction object that represents the current DatabaseAction according to the context in which the current script is executing. Null if there is no current DatabaseAction.
Since:
Build 6512.36

{integer} currentDatabaseActionIndex
An integer value that represents the "repeat index" of the current DatabaseAction if the current DatabaseAction repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current DatabaseAction or the current DatabaseAction does not repeat or has a repeat count of one.

Since:
Build 6512.36

{integer} currentDatabaseActionPlayNumber
An integer value that represents the "play ordinal number" of the current DatabaseAction. Starting with the number 0, each play of the DatabaseAction is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current DatabaseAction.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 6512.36

{Delay} currentDelay
A Delay object that represents the current Delay according to the context in which the current script is executing. Null if there is no current "Delay".

{EventGroup} currentEventGroup
A EventGroup object that represents the current EventGroup according to the context in which the current script is executing. Null if there is no current EventGroup.
Since:
Build 7198

{integer} currentEventGroupIndex
An integer value that represents the "repeat index" of the current EventGroup if the current EventGroup repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current EventGroup or the current EventGroup does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentEventGroupPlayNumber
An integer value that represents the "play ordinal number" of the current EventGroup. Starting with the number 0, each play of the EventGroup is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current EventGroup.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{EventMessageWebSocket} currentEventMessageWebSocket
A EventMessageWebSocket object that represents the current EventMessageWebSocket according to the context in which the current script is executing. Null if there is no current EventMessageWebSocket.
Since:
Build 7198

{integer} currentEventMessageWebSocketIndex
An integer value that represents the "repeat index" of the current EventMessageWebSocket if the current EventMessageWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current EventMessageWebSocket or the current EventMessageWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentEventMessageWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current EventMessageWebSocket. Starting with the number 0, each play of the EventMessageWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current EventMessageWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{Group} currentGroup
A Group object that represents the current Group according to the context in which the current script is executing. Null if there is no current Group.

{integer} currentGroupIndex
An integer value that represents the "repeat index" of the current Group if the current Group repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Group or the current Group does not repeat or has a repeat count of one.


{integer} currentGroupPlayNumber
An integer value that represents the "play ordinal number" of the current Group. Starting with the number 0, each play of the Group is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Group.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{If} currentIf
An If object that represents the current If according to the context in which the current script is executing. Null if there is no current If.

{integer} currentIfIndex
An integer value that represents the "repeat index" of the current If if the current If repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current If or the current If does not repeat or has a repeat count of one.


{integer} currentIfPlayNumber
An integer value that represents the "play ordinal number" of the current If. Starting with the number 0, each play of the If is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current If.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{(varies)} currentItem
The object that represents the current context in which the current Script is executing. For Script objects in Clips, Chains, Groups or Pages, this will always be the Script object itself. When scripting is used in an "In Situ Substitution Expression" (ISSE), this will be the object containing the ISSE (such as the Message).

{Message} currentMessage
A Message object that represents the current Message according to the context in which the current script is executing. Null if there is no current Message.

{integer} currentMessageIndex
An integer value that represents the "repeat index" of the current Message if the current Message repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Message or the current Message does not repeat or has a repeat count of one.


{integer} currentMessagePlayNumber
An integer value that represents the "play ordinal number" of the current Message. Starting with the number 0, each play of the Message is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Message.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{OpenWebSocket} currentOpenWebSocket
A OpenWebSocket object that represents the current OpenWebSocket according to the context in which the current script is executing. Null if there is no current DatabaseAction.
Since:
Build 7198

{integer} currentOpenWebSocketIndex
An integer value that represents the "repeat index" of the current OpenWebSocket if the current OpenWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current OpenWebSocket or the current OpenWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentOpenWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current OpenWebSocket. Starting with the number 0, each play of the OpenWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current OpenWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{Page} currentPage
A Page object that represents the current Page according to the context in which the current script is executing. Null if there is no current Page.

{integer} currentPageIndex
An integer value that represents the "repeat index" of the current Page if the current Page repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Page or the current Page does not repeat or has a repeat count of one.


{integer} currentPagePlayNumber
An integer value that represents the "play ordinal number" of the current Page. Starting with the number 0, each play of the Page is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Page.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Script} currentScript
A Script object that represents the current Script according to the context in which the current script is executing. Null if there is no current Script.

{integer} currentScriptIndex
An integer value that represents the "repeat index" of the current Script if the current Script repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Script or the current Script does not repeat or has a repeat count of one.


{integer} currentScriptPlayNumber
An integer value that represents the "play ordinal number" of the current Script. Starting with the number 0, each play of the Script is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Script.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{SendMessageWebSocket} currentSendMessageWebSocket
A SendMessageWebSocket object that represents the current SendMessageWebSocket according to the context in which the current script is executing. Null if there is no current DatabaseAction.
Since:
Build 7198

{integer} currentSendMessageWebSocketIndex
An integer value that represents the "repeat index" of the current SendMessageWebSocket if the current SendMessageWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current SendMessageWebSocket or the current SendMessageWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentSendMessageWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current SendMessageWebSocket. Starting with the number 0, each play of the SendMessageWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current SendMessageWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{Switch} currentSwitch
A Switch object that represents the current Switch according to the context in which the current script is executing. Null if there is no current Switch.

{integer} currentSwitchIndex
An integer value that represents the "repeat index" of the current Switch if the current Switch repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Switch or the current Switch does not repeat or has a repeat count of one.


{integer} currentSwitchPlayNumber
An integer value that represents the "play ordinal number" of the current Switch. Starting with the number 0, each play of the Switch is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Switch.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Target} currentTarget
A Target object that represents the current Target according to the context in which the current script is executing. Null if there is no current Target.

{TargetEventCloseWebSocket} currentTargetEventCloseWebSocket
A TargetEventCloseWebSocket object that represents the current TargetEventCloseWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventCloseWebSocket.
Since:
Build 7198

{integer} currentTargetEventCloseWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventCloseWebSocket if the current TargetEventCloseWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventCloseWebSocket or the current TargetEventCloseWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventCloseWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventCloseWebSocket. Starting with the number 0, each play of the TargetEventCloseWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventCloseWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventErrorWebSocket} currentTargetEventErrorWebSocket
A TargetEventErrorWebSocket object that represents the current TargetEventErrorWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventErrorWebSocket.
Since:
Build 7198

{integer} currentTargetEventErrorWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventErrorWebSocket if the current TargetEventErrorWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventErrorWebSocket or the current TargetEventErrorWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventErrorWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventErrorWebSocket. Starting with the number 0, each play of the TargetEventErrorWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventErrorWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventHandlerWebSocket} currentTargetEventHandlerWebSocket
A TargetEventHandlerWebSocket object that represents the current TargetEventHandlerWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventHandlerWebSocket.
Since:
Build 7198

{integer} currentTargetEventHandlerWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventHandlerWebSocket if the current TargetEventHandlerWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventHandlerWebSocket or the current TargetEventHandlerWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventHandlerWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventHandlerWebSocket. Starting with the number 0, each play of the TargetEventHandlerWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventHandlerWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventIdleWebSocket} currentTargetEventIdleWebSocket
A TargetEventIdleWebSocket object that represents the current TargetEventIdleWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventIdleWebSocket.
Since:
Build 7198

{integer} currentTargetEventIdleWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventIdleWebSocket if the current TargetEventIdleWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventIdleWebSocket or the current TargetEventIdleWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventIdleWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventIdleWebSocket. Starting with the number 0, each play of the TargetEventIdleWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventIdleWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventMessageDefaultWebSocket} currentTargetEventMessageDefaultWebSocket
A TargetEventMessageDefaultWebSocket object that represents the current TargetEventMessageDefaultWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventMessageDefaultWebSocket.
Since:
Build 7198

{integer} currentTargetEventMessageDefaultWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventMessageDefaultWebSocket if the current TargetEventMessageDefaultWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventMessageDefaultWebSocket or the current TargetEventMessageDefaultWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventMessageDefaultWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventMessageDefaultWebSocket. Starting with the number 0, each play of the TargetEventMessageDefaultWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventMessageDefaultWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventMessageWebSocket} currentTargetEventMessageWebSocket
A TargetEventMessageWebSocket object that represents the current TargetEventMessageWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventMessageWebSocket.
Since:
Build 7198

{integer} currentTargetEventMessageWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventMessageWebSocket if the current TargetEventMessageWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventMessageWebSocket or the current TargetEventMessageWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventMessageWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventMessageWebSocket. Starting with the number 0, each play of the TargetEventMessageWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventMessageWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{TargetEventOpenWebSocket} currentTargetEventOpenWebSocket
A TargetEventOpenWebSocket object that represents the current TargetEventOpenWebSocket according to the context in which the current script is executing. Null if there is no current TargetEventOpenWebSocket.
Since:
Build 7198

{integer} currentTargetEventOpenWebSocketIndex
An integer value that represents the "repeat index" of the current TargetEventOpenWebSocket if the current TargetEventOpenWebSocket repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current TargetEventOpenWebSocket or the current TargetEventOpenWebSocket does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentTargetEventOpenWebSocketPlayNumber
An integer value that represents the "play ordinal number" of the current TargetEventOpenWebSocket. Starting with the number 0, each play of the TargetEventOpenWebSocket is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current TargetEventOpenWebSocket.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{Track} currentTrack
A Track object that represents the current Track according to the context in which the current script is executing. Null if there is no current "Track".

{integer} currentTrackIndex
An integer value that represents the "repeat index" of the current Track if the current Track repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Track or the current Track does not repeat or has a repeat count of one.


{integer} currentTrackPlayNumber
An integer value that represents the "play ordinal number" of the current Track. Starting with the number 0, each play of the Track is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Track.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{Transaction} currentTransaction
A Transaction object that represents the current Transaction according to the context in which the current script is executing. Null if there is no current Transaction.

{integer} currentTransactionIndex
An integer value that represents the "repeat index" of the current Transaction if the current Transaction repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Transaction or the current Transaction does not repeat or has a repeat count of one.


{integer} currentTransactionPlayNumber
An integer value that represents the "play ordinal number" of the current Transaction. Starting with the number 0, each play of the Transaction is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Transaction.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.


{UIAutomationScript} currentUIAutomationScript
A UIAutomationScript object that represents the current UI Automation Script according to the context in which the current script is executing. Null if there is no current UI Automation Script.
Since:
Build 6834

{integer} currentUIAutomationScriptIndex
An integer value that represents the "repeat index" of the current UI Automation Script if the current UI Automation Script repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current UI Automation Script or the current UI Automation Script does not repeat or has a repeat count of one.

Since:
Build 6834

{integer} currentUIAutomationScriptPlayNumber
An integer value that represents the "play ordinal number" of the current UI Automation Script. Starting with the number 0, each play of the UI Automation Script is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current UI Automation Script.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 6834

{Wait} currentWait
A Wait object that represents the current Wait according to the context in which the current script is executing. Null if there is no current Wait.
Since:
Build 7198

{integer} currentWaitIndex
An integer value that represents the "repeat index" of the current Wait if the current Wait repeats, according to the context in which the current script is executing.

The first repeat starts at index zero. The value is -1 if there is no current Wait or the current Wait does not repeat or has a repeat count of one.

Since:
Build 7198

{integer} currentWaitPlayNumber
An integer value that represents the "play ordinal number" of the current Wait. Starting with the number 0, each play of the Wait is assigned a unique number. The numbers are contiguous (no gaps). The value is -1 if there is no current Wait.

Play number sequences are maintained within the item's parent only. For example, if a parent item repeats, then the child items inside each repeat of the parent will have their own play number sequence starting at 0.

An item will only have a non-zero play number if it repeats. The play number is equivalent to the repeat index, except that the play number is 0 for items that don't repeat or have a repeat count of one, whereas the repeat index would be -1 in those cases.

Since:
Build 7198

{String} locationName
The name of the location (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the name of the location of the particular server that this Script is playing on.

{Result} result
The ValidateDestinationResult object that represents the Result being produced for the currently playing Composition.

{String} serverExternalAddress
The External Address of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the External Address of the particular server that this Script is playing on (when available).

{String} serverExternalHost
The External Host of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the External Host of the particular server that this Script is playing on (when available).

{String} serverHostName
The Host Name of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the Host Name of the particular server that this Script is playing on.

{String} serverInternalAddress
The Internal Address of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the Internal Address of the particular server that this Script is playing on (when available).

{String} serverIP
The IP of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the IP of the particular server that this Script is playing on.

{String} serverName
The name of the server (from the Server List) on which the Composition is playing. If the Composition is playing on multiple Maestro servers, this will be the name of the particular server that this Script is playing on.

{String} serverType
The type of the server (from the Server List) on which the Composition is playing ("General" or "Load"). If the Composition is playing on multiple servers, this will be the type of the server on which the current Script is playing.

Note that this is not necessarily the same as the "Load mode" setting in the Composition Editor. It is possible to play a Composition that is in "Load mode" on a General server, and it is also possible to play a Composition that is not in "Load mode" on a Load server. Those two things are not the same.

Since:
Build 5030

{String} userName
The user ID of the user that started the current Composition playing.

{(varies)} validationValue
If the current Script was called to perform validation for Message or Browser Action response, this property contains the value to be validated.

If the Script was called to perform overall validation, this will be the entire response, otherwise it will be the specific portion of the response that is to be validated.

Note that the Script also has access to the response through the methods of the Message or Browser Action object.

If the current Script was not called to perform validation, this value will be null.

Method Detail
abortScript(errorText)
Immediately aborts play of the current Script, and considers the Script to have failed with the given error text.
Parameters:
{String} errorText Optional, Default: "Script aborted."

Optional error text. If no error text is provided, the text "Script aborted." is used.


{Java object} createJavaEnvironment()
Creates and returns a Java object that implements the Java ScriptEnvironment interface, to be passed to Java code called from this Script.

The returned object is not usable directly by the JavaScript in the calling Script. It can only be passed as a parameter to Java code being called by this Script. The object provides an environment that allows the Java code to interact directly with various aspects of the current Composition environment, such as writing to the Result and reading and setting Custom, System, and Global Properties.

The returned object is only suitable for use by Java code called from the current Script. It should not be attempted to share the returned object with other Scripts. Each Script that calls Java code that needs to interact with the Composition should call this method to create an environment suitable for Java code called from that particular Script.

Since:
Build 7038
Returns:
{Java object} Java object that implements the Java ScriptEnvironment interface.

{String[]} readFromURL(url, format, useCache, connectionTimeout, readTimeout)
This function has been replaced by the "readFromURL" function on the SystemUtilities object, and is maintained here only for backwards compatibility.
The function on the SystemUtilities object should be used instead of this function.
Parameters:
{String} url
{String} format Optional, Default: "CSV"
{boolean} useCache Optional, Default: true
{integer} connectionTimeout Optional, Default: 600000
{integer} readTimeout Optional, Default: 600000
Deprecated:
This function has been replaced by the "readFromURL" function on the SystemUtilities object.
Returns:
{String[]}
See:
SystemUtilities#readFromURL

SOASTA CloudTest Script Documentation (build 8744.736). Copyright 2006-2011. All rights reserved.