Class SystemProperties
Constructor Attributes | Constructor Name and Description |
---|---|
A singleton object that provides an easy short-cut for accessing the System Properties in the
Composition without having to traverse the object model.
|
Method Attributes | Method Name and Description |
---|---|
set(pathType, propertyPath, newValue)
Sets a new value into the specified System Property.
|
|
{String} |
value(pathType, propertyPath)
Returns the value of the specified System Property.
|
Accessible through the $sysprop constant.
List of available System Properties by item type:
Item type | System Property | Settable | Content type | Description |
---|---|---|---|---|
Composition | StartTimeMillis | No | Integer number, zero or above | Composition start time, expressed as the difference, in milliseconds, between the start time and midnight, January 1, 1970 UTC |
ServerNumber | No | Integer number, zero or above | The number of the current server for a multi-server Composition. Ranges from zero to n-1, where n is the number of servers. Always zero when the Composition runs all on one server. | |
Band | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Track | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
VUNumber | No | Integer number, zero or above | A number assigned to each virtual user guaranteed to be unique across all servers used by the Composition. These numbers are not necessarily contiguous. | |
VUPercentile | No | Floating point number | A floating point number between 0.0 and 100.0 that is the relative position of this virtual user within the virtual users (other repeats of the same Track) on the same server. Essentially the virtual users are kept in a list, and this is the "percentile" of the current Track within that list -- the percentage of virtual users before it in the list.
For example, if there were currently 4 instances of the current Track, one instance would get VUPercentile=0.0, one would get 25.0, one would get 50.0, and one would get 75.0. The intended purpose of this property is to allow the division of virtual users into categories or "buckets". For example, to have one third of the virtual users behave one way and the other two thirds behave another way, logic within a Clip can check whether this value is less than or equal to 33.333 or greater than 33.333. This number can change at any time as virtual users come and go for any reason, as Track instances start, stop, ramp up or down, or renew. If a Clip needs to check this value multiple times, it is recommended to cache the value somewhere, such as in a Clip or Track Custom Property, at the start of the Clip, if the Clip needs to behave as if it is in the same particular "bucket" for the Clip instance's duration. If this property value is retrieved for a Track or Track instance that is not actually playing, 0.0 is returned. |
|
VUCountThisServer | No | Integer number, zero or above | The current number of Virtual Users (instances) of this Track that are active on the current server. Does not include the counts from any other server if a multi-server Composition. | |
Clip | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Message | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WSA-MessageID | Yes | Text | For WSA messages, an IRI that uniquely identifies this message in time and space. If this value is not explicitly set, the system will create a unique ID for the message. | |
WSA-To | Yes | Text | For WSA (Web Services Addressing) messages, an IRI for the destination. If this value is not explicitly set, the system will create a value for the message. | |
Browser Action | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Param1 | Yes | Text | The value of the first Browser Action parameter | |
Param2 | Yes | Text | The value of the second Browser Action parameter | |
Param3 | Yes | Text | The value of the third Browser Action parameter | |
Param4 | Yes | Text | The value of the fourth Browser Action parameter | |
App Action | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Param1 | Yes | Text | The value of the first App Action parameter | |
Param2 | Yes | Text | The value of the second App Action parameter | |
Param3 | Yes | Text | The value of the third App Action parameter | |
Param4 | Yes | Text | The value of the fourth App Action parameter | |
Database Action | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
SQLText | Yes | Text | The SQL statement to execute | |
WebSocket Send | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Message | Yes | Text | The message text to send | |
WebSocket Event Handler | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Open Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Close Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Error Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Idle Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Message Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Default Event | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Message | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Open | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
WebSocket Close | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Message | Yes | Text | The optional text to send with the Web Socket close operation. | |
Event Group | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Wait | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Script | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
SourceCode | Yes | JavaScript text | The JavaScript source code for this Script | |
Launch Composition | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
CompositionName | Yes | Repository item name | The Repository name of the Composition to play. | |
CompositionPath | Yes | Repository path with slashes | The Repository path of the Composition to play. | |
WaitForCompletion | Yes | Boolean | If true, wait for Composition play to complete before proceeding. | |
VerifySuccessfulPlay | Yes | Boolean | If true, verify that the Composition play ended in state "Completed". Meaningful only if the "WaitForCompletion" property is true. | |
AllowPartialLoad | Yes | Boolean | True indicates that Composition play should proceed even if not all of the servers it needs could be found. | |
ResultName | Yes | Repository item name | Optional name for the Result produced by the Composition that is played. If null, a default name will be constructed for the Result using the current date and time. | |
ResultDescription | Yes | Text | Optional description text for the Result produced by the Composition that is played. If null, there will be no description text. | |
PlaceType | Yes | One of a set of specific text values | Indicates which particular type(s) and/or location(s) of Maestro server to play on. Must be one of the following values: "any", "any-general-server", "any-load-server", "dist-tracks-load", "location", "separate-load-server" or "server". | |
Place | Yes | Name of a server and/or location | If play is restricted to a particular server or location, this is the name of the server or location. In the case of server, it must be in the form "location name/server name". | |
FinalState | No | Text | Will contain the final state of the play, if the "WaitForCompletion" property is true. If that property is false, or Composition play has not yet completed, will be null. Possible values are: "Completed", "Stopped", "Failed", and "Aborted". | |
Delay | Type | Yes | Text | Either "Constant" to indicate that this Delay has a fixed duration, or "Random" to indicate that this Delay's duration is chosen at random on each play. |
Duration | Yes | Integer number of milliseconds | If type is "Constant", the duration for this Delay, in milliseconds. Not used if type is "Random". | |
Minimum | Yes | Integer number of milliseconds | If type is "Random", the minimum of the range from which durations are to be randomly chosen, in milliseconds. Not used if type is "Constant". | |
Maximum | Yes | Integer number of milliseconds | If type is "Random", the maximum of the range from which durations are to be randomly chosen, in milliseconds. Not used if type is "Constant". | |
Chain | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Group | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Transaction | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
If | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Switch | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Page | ForEachValue | No | Various | If the item is repeating due to a "for-each" repeat, contains the for-each value associated with this instance of the item. This will be a value in the array used for the for-each. If this item is not repeating due to a "for-each" repeat, the value of this property is null. |
Target (HTTP (including SOAP)) | Cookies | Yes | Array of cookie structs | List of all Cookies (for the entire Clip -- all HTTP Targets combined). Each entry in the array is a struct with "name", "domain", "path", "value", "expirationDate", and "secure" members. |
URL | Yes | Text | Full URL | |
HostName | Yes | Text | Host name | |
ServicePath | Yes | Text | Service path | |
Port | Yes | Integer number, 0-65535 | HTTP port number | |
UseSSL | Yes | Boolean | Whether to use SSL (HTTPS) | |
UserName | Yes | Text | HTTP Basic Authentication User name | |
Password | Yes | Password text | HTTP Basic Authentication User password | |
AuthenticationScheme | Yes | Text | HTTP Authentication Scheme | |
ProxyServer | Yes | Text | HTTP proxy server | |
ProxyPort | Yes | Integer number, 0-65535 | HTTP proxy port number | |
ProxyUserName | Yes | Text | HTTP proxy user name | |
ProxyPassword | Yes | Password text | HTTP proxy password | |
ProxyBypassList | Yes | Text | HTTP proxy bypass list | |
MaximumConnectionsPerHost | Yes | Integer number, greater than zero | Maximum number of connections that will be created for any particular host URI | |
MaximumTotalConnections | Yes | Integer number, greater than zero | Maximum number of active connections for this Target | |
ConnectionTimeout | Yes | Integer number of milliseconds | Connection timeout, in milliseconds, zero means no timeout | |
SocketReadTimeout | Yes | Integer number of milliseconds | Socket read timeout, in milliseconds, zero means no timeout | |
ConnectionRefresh | Yes | Integer number of seconds | Maximum lifetime of a connection for reuse, in seconds. If -1, no lifetime refresh is enforced. | |
ConnectionIdleRefresh | Yes | Integer number of seconds | Maximum idle time for connection for reuse, in seconds. If -1, no idle refresh is enforced. | |
SSLv2ClientHelloEnabled | Yes | Boolean | Indicates whether the SSL 2.0 "client hello" message will be used to establish SSL 3.0 connections. | |
SSLv3Enabled | Yes | Boolean | Indicates whether SSL 3.0 will be allowed when establishing SSL connections. | |
TLSv1Enabled | Yes | Boolean | Indicates whether TLS 1.0 will be allowed when establishing SSL connections. | |
TLSv1_1Enabled | Yes | Boolean | Indicates whether TLS 1.1 will be allowed when establishing SSL connections. | |
TLSv1_2Enabled | Yes | Boolean | Indicates whether TLS 1.2 will be allowed when establishing SSL connections. | |
UsePrivateDNSLookups | Yes | Boolean | Determines whether DNS lookups will be performed at the Target level (for this Target), rather than at a global level. | |
DNSServer | Yes | Text | The DNS server to use when resolving host names. If none is specified, then a public root nameserver will be used. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSMaxTTL | Yes | Integer number of milliseconds | The maximum amount of time that any DNS result will be cached. This can reduce the amount of time that a result would normally be cached, if it is less than the TTL specified in an actual DNS result. If 0, then result caching will be disabled completely. If -1, then results will be cached up to the amount of time specified in the DNS result, with no maximum. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSMinTTL | Yes | Integer number of milliseconds | The minimum amount of time that any DNS result will be cached. This can increase the amount of time that a result would normally be cached, if it is more than the TTL specified in an actual DNS result. If 0, then result caching will be disabled completely. If -1, then results will be cached up to the amount of time specified in the DNS result, with no minimum. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSServerRecursion | Yes | Boolean | Indicates whether the Recursion Desired flag will be set on outgoing DNS requests. | |
HttpHostOverride | Yes | Text | Override value to be placed into "Host" header in HTTP messages. | |
HttpBinaryConversion | Yes | Integer number, zero or above | Indicates whether requests and/or responses are encoded in a particular binary format. Can be 1 for Tarsin, 2 for WCF, 3 for AMF, or 0 for none. | |
HttpBinaryConversionClass | Yes | Text | The Java class name to use for custom binary conversions. Must be included in a Custom Module associated with the Target, and must implement the Transport Layer plug-in interface. | |
UseOAuth | Yes | Boolean | Specifies whether target uses OAuth authentication. | |
oauth_consumer_key | Yes | Text | Consumer key for OAuth authentication. | |
oauth_consumer_secret | Yes | Text | Consumer secret for OAuth authentication. | |
oauth_token_secret | Yes | Text | Current token value for OAuth authentication. | |
oauth_signature_method | Yes | Text | Signature method for OAuth authentication. | |
oauth_signature | Yes | Text | Current oauth signature. | |
oauth_timestamp | Yes | Integer number, zero or above | Current oauth timestamp. | |
oauth_nonce | Yes | Text | Current oauth nonce. | |
oauth_callback | Yes | Text | HTTP address for OAuth authentication callback | |
oauth_callback_confirmed | Yes | Boolean | Current value for OAuth authentication callback confirmation. | |
oauth_verifier | Yes | Text | Current value for OAuth authentication callback verifier. | |
oauth_version | Yes | Text | Current value for OAuth authentication callback version. | |
oauth_token | Yes | Text | Current value for OAuth authentication callback token. | |
Target (WebUI / Ajax) | StartingURL | Yes | Text | Starting URL |
BrowserType | Yes | Text | Browser type | |
WaitTimeout | Yes | Integer number of milliseconds | Wait timeout for a single wait condition in milliseconds | |
AllowNativeXPath | Yes | Boolean | Whether to use the browser's native XPath for evaluating locators | |
MouseSpeed | Yes | Integer number, greater than zero | The number of pixels to move the mouse in drag and drop or move events | |
WaitInterval | Yes | Integer number of milliseconds | The interval on which to check for the wait condition | |
ActionTimeout | Yes | Integer number of milliseconds | Action timeout in milliseconds | |
FirefoxProfile | Yes | Text | Name of the Firefox profile to be used (if Firefox). | |
PlaybackAPI | Yes | Text | Playback API. | |
IPAddress | Yes | Text | IP Address. | |
DeviceCloud | Yes | Text | Device Cloud | |
HUDEnabled | Yes | Boolean | Determines whether the Heads Up Display is enabled for the mobile target. | |
Conductor | Yes | Text | Conductor Name | |
DeviceAgent | Yes | Text | Device Agent | |
Target (Native / Mobile App) | WaitTimeout | Yes | Integer number of milliseconds | Wait timeout for a single wait condition in milliseconds |
WaitInterval | Yes | Integer number of milliseconds | The interval on which to check for the wait condition | |
ActionTimeout | Yes | Integer number of milliseconds | Action timeout in milliseconds | |
DeviceCloud | Yes | Text | Device Cloud | |
MobileApp | Yes | Text | Mobile App | |
DeviceType | Yes | Text | Device Type | |
LaunchURL | Yes | Text | URL that will be used to launch the app. | |
TerminateAppOnFinish | Yes | Boolean | Determines whether the app will be terminated when the Clip completes. | |
HUDEnabled | Yes | Boolean | Determines whether the Heads Up Display is enabled for the mobile target. | |
LoggingEnabled | Yes | Boolean | Determines whether logging is enabled for the mobile target. | |
DeviceAgent | Yes | Text | Device Agent | |
Target (Database) | DatabaseURL | Yes | Text | The JDBC database URL for connecting to the database |
DatabaseUsername | Yes | Text | The database user name | |
DatabasePassword | Yes | Password text | The database password | |
DatabaseUsingSSL | Yes | Boolean | True if SSL should be used to connect to the database | |
DatabaseAutoCommit | Yes | Boolean | True if in auto-commit mode | |
DatabaseConnectionTimeout | Yes | Integer number of seconds | Database connection timeout, in seconds, minimum 1, maximum 65535 (default: 15) | |
DatabaseExecutionTimeout | Yes | Integer number of seconds | SQL statement execution timeout, in seconds, minimum 1, maximum 65535 (default: 60) | |
Target (WebSocket) | URL | Yes | Text | Full URL |
HostName | Yes | Text | Host name | |
ServicePath | Yes | Text | Service path | |
Port | Yes | Integer number, 0-65535 | HTTP port number | |
UseSSL | Yes | Boolean | Whether to use SSL (HTTPS) | |
ProxyServer | Yes | Text | HTTP proxy server | |
ProxyPort | Yes | Integer number, 0-65535 | HTTP proxy port number | |
ProxyUserName | Yes | Text | HTTP proxy user name | |
ProxyPassword | Yes | Password text | HTTP proxy password | |
ProxyBypassList | Yes | Text | HTTP proxy bypass list | |
ConnectionTimeout | Yes | Integer number of milliseconds | Connection timeout, in milliseconds, zero means no timeout | |
SocketReadTimeout | Yes | Integer number of milliseconds | Socket read timeout, in milliseconds, zero means no timeout | |
SSLv2ClientHelloEnabled | Yes | Boolean | Indicates whether the SSL 2.0 "client hello" message will be used to establish SSL 3.0 connections. | |
SSLv3Enabled | Yes | Boolean | Indicates whether SSL 3.0 will be allowed when establishing SSL connections. | |
TLSv1Enabled | Yes | Boolean | Indicates whether TLS 1.0 will be allowed when establishing SSL connections. | |
TLSv1_1Enabled | Yes | Boolean | Indicates whether TLS 1.1 will be allowed when establishing SSL connections. | |
TLSv1_2Enabled | Yes | Boolean | Indicates whether TLS 1.2 will be allowed when establishing SSL connections. | |
UsePrivateDNSLookups | Yes | Boolean | Determines whether DNS lookups will be performed at the Target level (for this Target), rather than at a global level. | |
DNSServer | Yes | Text | The DNS server to use when resolving host names. If none is specified, then a public root nameserver will be used. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSMaxTTL | Yes | Integer number of milliseconds | The maximum amount of time that any DNS result will be cached. This can reduce the amount of time that a result would normally be cached, if it is less than the TTL specified in an actual DNS result. If 0, then result caching will be disabled completely. If -1, then results will be cached up to the amount of time specified in the DNS result, with no maximum. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSMinTTL | Yes | Integer number of milliseconds | The minimum amount of time that any DNS result will be cached. This can increase the amount of time that a result would normally be cached, if it is more than the TTL specified in an actual DNS result. If 0, then result caching will be disabled completely. If -1, then results will be cached up to the amount of time specified in the DNS result, with no minimum. This setting is ignored unless "UsePrivateDNSLookups" is set to true. | |
DNSServerRecursion | Yes | Boolean | Indicates whether the Recursion Desired flag will be set on outgoing DNS requests. | |
WebSocketIdleInterval | Yes | Integer number of seconds | The amount of time that a WebSocket connection is idle that will trigger a WebSocket idle event | |
WebSocketsPeriodicPingEnabled | Yes | Boolean | Indicates whether a "ping" frame will be sent to the Target server on a regular basis. | |
WebSocketsPeriodicPingInterval | Yes | Integer number of seconds | The frequency, in minutes, at which to send a "ping" frame to the Target server | |
WebSocketsPeriodicPingBuffer | Yes | Text | The text to include in periodic "ping" frames, if they are enabled. |
- Parameters:
- {String} pathType
Specifies the "starting point" of the path, relative to the current context in which the current Script is running. It can be any of the following values (case is not significant):
- "Composition"
The path is relative to the Composition as a whole. (Therefore, the path must start with the name of a Band.)
- "Band"
The path is relative to the current Band in which the Script is executing.
- "Track"
The path is relative to the current Track in which the Script is executing.
- "MessageClip" or "Clip" (either one is accepted)
The path is relative to the current Clip in which the Script is executing. If the Script is nested within multiple Clips, the path is relative to the lowest-level containing Clip (the Clip "nearest to" the Script in terms of the parentage hierarchy).
- "Chain"
The path is relative to the current Chain in which the Script is executing. If the Script is nested within multiple Chains, the path is relative to the lowest-level containing Chain (the Chain "nearest to" the Script in terms of the parentage hierarchy).
- "Group"
The path is relative to the current Group in which the Script is executing. If the Script is nested within multiple Groups, the path is relative to the lowest-level containing Group (the Group "nearest to" the Script in terms of the parentage hierarchy).
- "Transaction"
The path is relative to the current Transaction in which the Script is executing. If the Script is nested within multiple Transactions, the path is relative to the lowest-level containing Transaction (the Transaction "nearest to" the Script in terms of the parentage hierarchy).
- "If"
The path is relative to the current If in which the Script is executing. If the Script is nested within multiple Ifs, the path is relative to the lowest-level containing If (the If "nearest to" the Script in terms of the parentage hierarchy).
- "Switch"
The path is relative to the current Switch in which the Script is executing. If the Script is nested within multiple Switch, the path is relative to the lowest-level containing Switch (the Switch "nearest to" the Script in terms of the parentage hierarchy).
- "Page"
The path is relative to the current Page in which the Script is executing.
- "Message"
The path is relative to the current Message in which the Script is executing.
- "Browser Action"
The path is relative to the current Browser Action in which the Script is executing.
- "Destination"
The path is relative to the current Message or Browser Action in which the Script is executing. Once the item is found, the result is to be the item's Target.
- "Composition"
- {String} propertyPath
Contains a property path as specified for "In Situ Substitution Specifications" (see the separate documentation on ISSEs).
- {anything} newValue
The new value for the property. It can be null. (The "undefined" value is treated as null.)
- Parameters:
- {String} pathType
Specifies the "starting point" of the path, relative to the current context in which the current Script is running. It can be any of the following values (case is not significant):
- "Composition"
The path is relative to the Composition as a whole. (Therefore, the path must start with the name of a Band.)
- "Band"
The path is relative to the current Band in which the Script is executing.
- "Track"
The path is relative to the current Track in which the Script is executing.
- "MessageClip" or "Clip" (either one is accepted)
The path is relative to the current Clip in which the Script is executing. If the Script is nested within multiple Clips, the path is relative to the lowest-level containing Clip (the Clip "nearest to" the Script in terms of the parentage hierarchy).
- "Chain"
The path is relative to the current Chain in which the Script is executing. If the Script is nested within multiple Chains, the path is relative to the lowest-level containing Chain (the Chain "nearest to" the Script in terms of the parentage hierarchy).
- "Group"
The path is relative to the current Group in which the Script is executing. If the Script is nested within multiple Groups, the path is relative to the lowest-level containing Group (the Group "nearest to" the Script in terms of the parentage hierarchy).
- "Transaction"
The path is relative to the current Transaction in which the Script is executing. If the Script is nested within multiple Transactions, the path is relative to the lowest-level containing Transaction (the Transaction "nearest to" the Script in terms of the parentage hierarchy).
- "If"
The path is relative to the current If in which the Script is executing. If the Script is nested within multiple Ifs, the path is relative to the lowest-level containing If (the If "nearest to" the Script in terms of the parentage hierarchy).
- "Switch"
The path is relative to the current Switch in which the Script is executing. If the Script is nested within multiple Switch, the path is relative to the lowest-level containing Switch (the Switch "nearest to" the Script in terms of the parentage hierarchy).
- "Page"
The path is relative to the current Page in which the Script is executing.
- "Message"
The path is relative to the current Message in which the Script is executing.
- "Browser Action"
The path is relative to the current App Action in which the Script is executing.
- "App Action"
The path is relative to the current Browser Action in which the Script is executing.
- "Destination"
The path is relative to the current Message or Browser Action in which the Script is executing. Once the item is found, the result is to be the item's Target.
- "Composition"
- {String} propertyPath
Contains a property path as specified for "In Situ Substitution Specifications" (see the separate documentation on ISSEs).
- Returns:
- {String}
The value of the specified System Property. Can be null.