Play Options
| Parameter | Description |
username=USERNAME |
CloudTest user name |
password=PASSWORD |
CloudTest password |
url=URL |
CloudTest URL to connect |
httpproxyhost=SERVER |
HTTP proxy server name (optional) |
httpproxyport=PORT |
HTTP proxy port (optional) |
name=NAME |
The name of the object to play. |
type=TYPE |
The type of object to play. Valid types are
composition
or
playlist
. If the 'type' option is omitted, then
composition
is assumed. |
wait=[yes|no] |
Specify whether to wait for the object to finish playing. If the 'wait' option is omitted, then 'no' is assumed. |
format=FORMAT |
The display format to use (i.e. 'text', 'xml', or 'junitxml'). If the 'format' option is omitted, then 'text' is assumed. When the format is junitxml, users can also use the validation parameter to specify a transaction name, a transaction metric to use, and to set a threshold value to validate. |
file=FILE |
The file to write the output to (optional). If the 'file' option is omitted, then the output will be written to the command line (standard out). |
seeddatakey[NAME]=password |
Specify a password for the given encrypted seed data file. |
systemproperty="PROPERTY PATH=VALUE" |
Specify a system property's path and its value (optional). |
customproperty="PROPERTY PATH=VALUE" |
Specify a custom property's path and its value (optional). |
failonerror=[yes|no] |
This parameter will fail the test on error in Continuous Integration (CI) environments. When this parameter is set to yes, if the composition playback fails on a validation or any clip-related error, then Jenkins or Bamboo will also fail the job and note the scommand return code as an error. |
validation=/transactionname/transactionmetric/transactionthreshold |
This parameter will validate the specified transaction by name, using one of the supported metrics (supported metrics are listed below) and a value in milliseconds. |
loadonserver=SERVERNAME |
Name of the server where the composition will be loaded (optional).[Requires CloudTest build 8744.49 or later.] |
resultsdatabase=RSDBNAME |
Name of the Results Database that will collect the results (optional). [Requires CloudTest build 8744.49 or later.] |
resultname=RESULTNAME |
Name of the result to create. |
errorretrycount=ERRORRETRYCOUNT |
If an error is ecountered when playing a composition, then this is the amount of retries that will be attempted until it passes or hits that count. |
For example, to play the composition named "/Load Tests/Comp 1":
scommand cmd=play name="/Load Tests/Comp 1" username=bob \
password=secret url=
http://
<CloudTest URL>/concerto
For example, to play the playlist named "/Load Tests/Complete Set of Tests":
scommand cmd=play type=playlist name="/Load Tests/Complete Set of Tests" \
username=bob password=secret url=
http://
<CloudTest URL>/concerto
For example, to play the composition named "/Load Tests/Comp 1" while specifying passwords for two encrypted seed data objects:
scommand cmd=play name="/Load Tests/Comp 1" username=bob password=secret url=
http://
<CloudTest URL>/concerto \
seeddatakey[/Data/List1]=password1 seeddatakey[/Data/List2]=password2
For example, to play the composition named "/Load Tests/Comp 1" while specifying the target "Load Test on Mobile" to use for the composition:
scommand cmd=play name="/Load Tests/Comp 1" username=bob \
password=secret url=
http://
<CloudTest URL>/concerto
systemproperty="Band 1/Track 1/Clip 1/Load Test on Mobile/DeviceAgent=iPad"
For example, to set a transaction threshold on a transaction named
t1
in order to validate a given metric (i.e. AverageResponseTime) using a value specified in milliseconds:
scommand url=<CloudTest URL>/concerto/ username=soasta password=secret cmd=play wait format=junitxml name=/Demo/comp1 validation=t1/AverageResponseTime/100 \
password=secret url=
http://
<CloudTest URL>/concerto