Story Boarder Reference -...

Story Boarder Reference

© InfoVista Sweden AB, 2000-2017. All rights reserved. Page 1 of 539 21 July 2017

TEMS™ Monitor Master v10.4.4

Story Boarder

Reference

Document: MM-0036-Q

Created by: EWJP

Status: Released



Copyright © InfoVista Sweden AB, 2000-2017. All rights reserved. Unauthorized copying, distribution and use of the

document or its content is strictly prohibited. All registered trademarks, quotes, products or service names are

acknowledged.

Note: In this guide the term "Monitor Master" refers to the InfoVista product "TEMS Monitor Master".

InfoVista Sweden AB

Laboratorgränd 3, 931 62

Skelleftea, Sweden

TEMS Monitor Master is part of the TEMS Portfolio, from InfoVista.

www.infovista.com

Version Overview

Version Date Author Modification

1.0 21/07/2017 EWJP Initial release

Information in this document is subject to change without notice. For the latest version, please visit

https://customerportal.tems.infovista.com

Document Management

File name: story_boarder_reference.pdf

Pages: 539

Released on: 21/07/2017

Approved by: GJ

http://www.infovista.com/

https://customerportal.tems.infovista.com/



Table of Contents CHAPTER 1 - INTRODUCTION .................................................................................................................................. 16

USING THIS GUIDE .......................................................................................................................................................... 16

OTHER GUIDES ............................................................................................................................................................... 17

CHAPTER 2 - USING SCENES AND RESOURCES .................................................................................................. 18

MAIN TECHNIQUES ......................................................................................................................................................... 18

DEFAULT ROUTES ........................................................................................................................................................... 18

RESOURCE FILES ............................................................................................................................................................. 18

SIDEBAR GROUPS ............................................................................................................................................................ 19

CHAPTER 3 - STANDARD SCENES ........................................................................................................................... 20

Start scene........................................................................................................................................................... 21

Comment scene ................................................................................................................................................... 26

End scene ............................................................................................................................................................ 27

CHAPTER 4 - RESOURCES .......................................................................................................................................... 28

SCRIPTING RESOURCES .................................................................................................................................................... 28

Script resource .................................................................................................................................................... 29

Engineer resource ............................................................................................................................................... 31

TEST RESOURCES ............................................................................................................................................................ 32

Prop resource ..................................................................................................................................................... 33

Props resource .................................................................................................................................................... 34

PropStore resource ............................................................................................................................................. 35

File resource ........................................................................................................................................................ 36

Parameter resource ............................................................................................................................................ 37

TERMINALS RESOURCES .................................................................................................................................................. 37

SmartModem resource ...................................................................................................................................... 38

LAN resource ....................................................................................................................................................... 41

Modem resource ................................................................................................................................................. 42

CDMA Hardware resource ............................................................................................................................... 43

CONNECTIONS RESOURCES.............................................................................................................................................. 43

Operator resource .............................................................................................................................................. 44

Device resource .................................................................................................................................................. 48

Devices resource ................................................................................................................................................. 52

User resource ..................................................................................................................................................... 53

Connection resource ........................................................................................................................................... 56

Multi Connection resource ................................................................................................................................. 57

Connection Context resource.............................................................................................................................. 58

HTTP Client resource ......................................................................................................................................... 59

CDMA MMS Client resource ............................................................................................................................. 60



BROWSER RESOURCES ..................................................................................................................................................... 60

Internet Explorer resource ................................................................................................................................. 61

ArgoBrowser resource ....................................................................................................................................... 63

WebBrowser resource ........................................................................................................................................ 64

AUDIO RESOURCES .......................................................................................................................................................... 65

Smart VoiceSession resource .............................................................................................................................. 67

IAPI VoiceSession resource ................................................................................................................................ 68

VoiceSession resource......................................................................................................................................... 69

Audio Bridge resource ........................................................................................................................................ 70

VIDEO RESOURCES .......................................................................................................................................................... 70

VideoPlayer resource .......................................................................................................................................... 71

Video Engineer resource ..................................................................................................................................... 73

VideoMOSEngine resource ................................................................................................................................. 74

CONTENT RESOURCES ..................................................................................................................................................... 74

Content resource ................................................................................................................................................. 75

PCAP RESOURCES ........................................................................................................................................................... 75

PCAP Engineer resource .................................................................................................................................... 76

PCAP Examiner resource ................................................................................................................................... 77

PCAP Manager resource .................................................................................................................................... 78

POWER CONTROL RESOURCES ......................................................................................................................................... 80

External Hardware:BetterBox Device Control resource .................................................................................... 81

External Hardware:iBoot Device Control resource ........................................................................................... 82

External Hardware:APC Device Control resource ............................................................................................ 83

External Hardware:DevCon Device Control resource ....................................................................................... 84

External Hardware:ActeSys Device Control resource ....................................................................................... 85

ADVANCED SIM MANAGEMENT RESOURCES .................................................................................................................. 85

ActeSys Remote SIM Server resource ............................................................................................................... 86

SIM resource ......................................................................................................................................................... 87

SIM List resource ................................................................................................................................................. 88

SIM Server resource.............................................................................................................................................. 90

XML FILE RESOURCES .................................................................................................................................................... 90

XML File resource .............................................................................................................................................. 91

VOIP RESOURCES ............................................................................................................................................................ 91

VoIP Client resource ............................................................................................................................................ 92

VoIP VoiceSession resource ............................................................................................................................... 93

VoIP PCAP resource .......................................................................................................................................... 94

CHAPTER 5 - SCRIPTING SCENES ............................................................................................................................ 95

Script scene ......................................................................................................................................................... 96

Loop scene ........................................................................................................................................................ 104



Wait scene ......................................................................................................................................................... 105

Delete File scene............................................................................................................................................... 106

SYNCH POINT SCENES ................................................................................................................................................... 106

Synch Point scene ......................................................................................................................................... 107

Verifying Synch Point scene ......................................................................................................................... 109

Neutral Synch Point scene ............................................................................................................................ 110

RETRIEVE VALUES SCENES ........................................................................................................................................... 110

Match Values scene .......................................................................................................................................... 111

Get PropStore Value scene ............................................................................................................................... 112

Find Value in Props scene ................................................................................................................................ 113

Match PropStore Value scene ........................................................................................................................... 114

Get Props Value scene ...................................................................................................................................... 115

SET VALUES SCENES ..................................................................................................................................................... 115

Set Prop Value scene ........................................................................................................................................ 116

Set Props List scene .......................................................................................................................................... 117

Set PropStore Items scene................................................................................................................................. 118

Encode Base64 Data scene ............................................................................................................................... 120

Decode Base64 Data scene............................................................................................................................... 121

Convert ArgoList to Props scene ....................................................................................................................... 122

XML RESOURCE FILE SCENES ...................................................................................................................................... 122

Set Prop from XML resource scene .................................................................................................................. 123

Set Prop from SiteConfig scene ........................................................................................................................ 124

Set Props from XML resource scene ................................................................................................................. 125

Set PropStore from XML resource scene .......................................................................................................... 126

CHAPTER 6 - TEST SCENES ..................................................................................................................................... 128

CHECKS SCENES ............................................................................................................................................................ 128

Check Device Capabilities scene ....................................................................................................................... 129

Check Environment scene .................................................................................................................................. 130

Check Props scene ............................................................................................................................................ 132

Check User scene .............................................................................................................................................. 133

Check Operator Service scene .......................................................................................................................... 134

PROPERTIES SCENES ...................................................................................................................................................... 134

Get MSISDN for Party scene ............................................................................................................................... 135

Get Test Property scene ................................................................................................................................... 137

PARAMETERS SCENES .................................................................................................................................................... 137

Operator Load from Params scene................................................................................................................... 138

Device Load from Params scene ...................................................................................................................... 139

DEPRECATED SCENES .................................................................................................................................................... 139

Branch if Test Running scene ......................................................................................................................... 140



Configure Branch Test scene .......................................................................................................................... 141

Branch Test scene ........................................................................................................................................... 142

Merge Test scene ............................................................................................................................................... 143

Synchronize Test scene ................................................................................................................................... 145

Start Test scene ............................................................................................................................................... 146

CHAPTER 7 - PROBE SCENES .................................................................................................................................. 147

ADMINISTRATION SCENES ............................................................................................................................................. 147

Agent restart (hard) scene ................................................................................................................................. 148

Agent Restart (soft) scene ................................................................................................................................. 149

CHAPTER 8 - TERMINALS SCENES ........................................................................................................................ 150

PowerUp Modem scene .................................................................................................................................... 151

PowerDown Modem scene ................................................................................................................................ 152

Disable Modem scene ........................................................................................................................................ 153

Recover Modem scene ....................................................................................................................................... 154

Reset Modem scene ........................................................................................................................................... 155

Verify Modem scene .......................................................................................................................................... 156

Ensure Modem Ready scene ............................................................................................................................... 157

Get Modem Information scene ........................................................................................................................ 158

Get Additional Modem Information scene ......................................................................................................... 159

ADVANCED SIM MANAGEMENT SCENES ....................................................................................................................... 160

Connect to Remote SIM scene ........................................................................................................................... 161

Select SIM scene .................................................................................................................................................. 162

Load SIM From Resource scene .......................................................................................................................... 163

CHAPTER 9 - CONNECTIONS SCENES .................................................................................................................. 164

PACKET SCENES............................................................................................................................................................. 164

Make Data Connection scene............................................................................................................................ 165

Drop Data Connection scene ............................................................................................................................ 167

GPRS Attach scene ............................................................................................................................................ 168

GPRS Detach scene ........................................................................................................................................... 169

GPRS PDP Activate scene ................................................................................................................................ 170

GPRS PDP Deactivate scene ............................................................................................................................ 171

Wait for PDP Context Deactivation scene ....................................................................................................... 172

Get SIM Number scene ........................................................................................................................................ 173

Verify Network Accessibility (ETSI) scene ......................................................................................................... 174

CIRCUIT SCENES ............................................................................................................................................................ 174

Make Voice Call scene ...................................................................................................................................... 175

Drop Voice Call scene ...................................................................................................................................... 176

Wait for Call scene ............................................................................................................................................ 177



Maintain Voice Call scene ................................................................................................................................ 178

Answer Voice Call scene .................................................................................................................................. 179

Analyze PESQ scene .................................................................................................................................... 180

Test Circuit Switched Loopback scene ............................................................................................................. 182

Test Circuit Switched Remote scene ................................................................................................................. 183

Test Circuit Switched Echo scene ..................................................................................................................... 184

CHAPTER 10 - VOICE SCENES ................................................................................................................................ 185

Assess Call Quality scene ............................................................................................................................. 186

Process Announcement scene ........................................................................................................................... 187

Stop Voice Recording scene ............................................................................................................................. 188

Start Voice Recording scene ............................................................................................................................ 189

Record Volume scene ........................................................................................................................................ 190

Playback Volume scene ..................................................................................................................................... 191

Play Audio scene............................................................................................................................................... 192

TELEPHONY SCENES ...................................................................................................................................................... 192

Make DTMF Tone scene ................................................................................................................................... 193

Make Voice Call scene ...................................................................................................................................... 194

Drop Voice Call scene ...................................................................................................................................... 195

Wait for Call scene ........................................................................................................................................... 196

Maintain Voice Call scene ................................................................................................................................ 197

Answer Voice Call scene .................................................................................................................................. 198

Analyze PESQ scene .................................................................................................................................... 199

Measure Voice Quality scene .......................................................................................................................... 201

TELEPHONY: DEPRECATED SCENES............................................................................................................................... 203

Play Spoken Phrase scene ................................................................................................................................ 204

Play TEC Audio scene ...................................................................................................................................... 205

Record TEC Audio scene .................................................................................................................................. 206

VOIP SCENES ................................................................................................................................................................ 206

Make SIP Call scene......................................................................................................................................... 207

Drop SIP Call scene ......................................................................................................................................... 208

Wait for SIP Call scene .................................................................................................................................... 209

Send SIP Message scene ................................................................................................................................... 210

Receive SIP Message scene .............................................................................................................................. 211

CHAPTER 11 - VIDEO CALL SCENES .................................................................................................................... 212

Test Circuit Switched Loopback scene ............................................................................................................. 213

Test Circuit Switched Remote scene ................................................................................................................. 214

Test Circuit Switched Echo scene ..................................................................................................................... 215

CHAPTER 12 - NETWORK SCENES ........................................................................................................................ 216



Query Signal Strength scene ............................................................................................................................. 217

Select Operator scene ....................................................................................................................................... 218

Get Operators scene ......................................................................................................................................... 219

Wait for Network scene ..................................................................................................................................... 220

Set RAT scene ................................................................................................................................................... 221

Lock Band scene ............................................................................................................................................... 224

DATA SCENES ............................................................................................................................................................... 225

Download FTP scene ........................................................................................................................................ 226

Upload FTP scene ............................................................................................................................................. 229

Download HTTP scene ..................................................................................................................................... 231

Ping scene ......................................................................................................................................................... 233

Video Ping scene ............................................................................................................................................... 234

DNS Lookup scene ............................................................................................................................................ 235

AUTHENTICATION SCENES ............................................................................................................................................. 235

Set RADIUS Details scene ................................................................................................................................ 236

Check RADIUS Access scene ........................................................................................................................... 237

PCAP SCENES ............................................................................................................................................................... 237

Examine PCAP scene ........................................................................................................................................ 239

PCAP Start scene .............................................................................................................................................. 240

PCAP Stop scene ............................................................................................................................................... 241

DIAGNOSTICS SCENES .................................................................................................................................................... 241

resources: Diagnostics Writer resource ........................................................................................................... 243

resources: Diagnostics Reader resource .......................................................................................................... 244

Diagnostics Trace Start scene ........................................................................................................................... 245

Diagnostics Trace Stop scene ........................................................................................................................... 246

Diagnostics Trace Reporter scene .................................................................................................................... 248

Diagnostics Trace Available scene ................................................................................................................... 250

CHAPTER 13 - SUPPLEMENTARY SERVICES SCENES ..................................................................................... 251

Call Barring scene .......................................................................................................................................... 252

Call Forwarding Service scene ........................................................................................................................ 253

CLIR scene ........................................................................................................................................................ 254

CLIP scene ....................................................................................................................................................... 255

SUPPLEMENTARY SERVICES: DEPRECATED SCENES ...................................................................................................... 255

Call Forwarding scene .................................................................................................................................... 256

CHAPTER 14 - MESSAGING SCENES...................................................................................................................... 257

EMAIL SCENES: POP3 ................................................................................................................................................... 257

Receive Email scene .......................................................................................................................................... 258

Clear POP3 Mailbox scene ............................................................................................................................... 259



Disconnect POP3 scene .................................................................................................................................... 260

EMAIL SCENES: SMTP .................................................................................................................................................. 260

Send Email scene .............................................................................................................................................. 261

Disconnect SMTP scene ................................................................................................................................... 262

EMAIL SCENES: IMAP .................................................................................................................................................. 262

List Available IMAP Mailboxes scene .............................................................................................................. 263

Count all IMAP Emails scene........................................................................................................................... 264

List all IMAP Emails scene .............................................................................................................................. 265

Receive IMAP Email scene ............................................................................................................................... 266

Delete all IMAP Emails scene .......................................................................................................................... 267

Disconnect IMAP scene .................................................................................................................................... 268

EMAIL SCENES: SECURITY ............................................................................................................................................ 268

Make Email Secure scene ................................................................................................................................ 269

SMS SCENES ................................................................................................................................................................. 269

Clear SMS Inbox scene ..................................................................................................................................... 270

Receive SMS scene ............................................................................................................................................ 271

Receive SMS Notification scene ........................................................................................................................ 273

Send SMS scene ................................................................................................................................................ 275

Send and Receive SMS (P2A2P) scene ............................................................................................................. 276

Send and Receive SMS (P2P) scene.................................................................................................................. 278

Send and Receive SMS (P2OP) scene ............................................................................................................... 280

MMS SCENES ................................................................................................................................................................ 281

Clear MMS Inbox scene .................................................................................................................................... 282

Clear MMS Local Inbox scene .......................................................................................................................... 283

Send MMS scene ............................................................................................................................................... 284

Receive MMS scene .......................................................................................................................................... 285

Receive MMS Notification scene ...................................................................................................................... 286

Receive MMS Delivery Report scene ................................................................................................................ 287

Download MMS scene ...................................................................................................................................... 288

INSTANT MESSAGING: OMA IMPS SCENES .................................................................................................................. 288

Login to IM Service scene ................................................................................................................................. 289

Logout from IM Service scene .......................................................................................................................... 290

Send Instant Message scene .............................................................................................................................. 291

Receive Instant Message scene ......................................................................................................................... 292

Set IM Presence scene ....................................................................................................................................... 293

Get IM Presence scene ..................................................................................................................................... 294

CHAPTER 15 - BROWSER SCENES ......................................................................................................................... 295

WAP/WEB SCENES ....................................................................................................................................................... 295

Visit Page scene ................................................................................................................................................ 296



Autobrowse scene .............................................................................................................................................. 297

Choose Option scene ......................................................................................................................................... 299

Select Form scene ............................................................................................................................................. 300

Enter Data scene ............................................................................................................................................... 301

Follow Link scene ............................................................................................................................................. 302

Go Back scene ................................................................................................................................................... 303

Navigate scene .................................................................................................................................................. 304

Click Numbered Link scene ............................................................................................................................... 305

Visit Multipart Page scene ................................................................................................................................ 306

Visit Video scene ............................................................................................................................................. 307

Browser GetCookies scene ................................................................................................................................ 308

Browser SetCookies scene .................................................................................................................................. 309

Browser ClearCookies scene ............................................................................................................................. 310

Browser ClearCache scene .............................................................................................................................. 311

Record Navigation scene .................................................................................................................................. 312

Browse to Page scene ..................................................................................................................................... 318

Click Button scene ......................................................................................................................................... 319

Click Image scene .......................................................................................................................................... 320

Click Index scene ........................................................................................................................................... 321

Click Input scene ............................................................................................................................................ 322

Click Name scene ........................................................................................................................................... 323

Enable Checkbox scene .................................................................................................................................. 324

Enter Text scene .............................................................................................................................................. 325

Select Option scene .......................................................................................................................................... 326

Select Form (IE) scene ...................................................................................................................................... 327

Select Frame scene ........................................................................................................................................... 328

Record Frame Content ...................................................................................................................................... 329

Click JS Entity scene ..................................................................................................................................... 330

STK SCENES .................................................................................................................................................................. 331

Launch SIM Toolkit Application scene ................................................................................................................ 332

WEBBROWSER SCENES .................................................................................................................................................. 332

Take Snapshot scene ......................................................................................................................................... 334

Open New Window scene .................................................................................................................................. 335

Select Window scene ......................................................................................................................................... 336

Close Window scene ......................................................................................................................................... 337

Enable Multiple Windows scene ....................................................................................................................... 338

Simple Autobrowse scene ................................................................................................................................. 339

CHAPTER 16 - REAL DEVICES SCENES ................................................................................................................ 341



S60 SCENES ................................................................................................................................................................... 341

Make Tethered MA Connection S60 scene ....................................................................................................... 342

Drop Tethered MA Connection scene ............................................................................................................... 343

Press Tethered MA Key S60 scene ................................................................................................................... 344

Enter Tethered MA Text S60 scene ................................................................................................................... 345

Match Tethered MA Screen scene .................................................................................................................... 346

Capture Tethered MA Screen scene .................................................................................................................. 347

Clear Tethered MA Inbox S60 scene ................................................................................................................ 348

Send Tethered MA SMS S60 scene ................................................................................................................... 349

Send Tethered MA MMS S60 scene .................................................................................................................. 350

Receive Tethered MA SMS S60 scene ............................................................................................................... 351

Receive Tethered MA MMS S60 scene .............................................................................................................. 352

Visit Tethered MA Page S60 scene ................................................................................................................... 353

SE SCENES .................................................................................................................................................................... 353

Make Tethered MA Connection SE scene ......................................................................................................... 354


Press Tethered MA Key SE scene ..................................................................................................................... 356

Enter Tethered MA Text SE scene .................................................................................................................... 357

Match Tethered MA Screen scene .................................................................................................................... 358


Capture Tethered MA Text SE scene ................................................................................................................ 360

ANDROID SCENES .......................................................................................................................................................... 360

ADB Get Property scene .................................................................................................................................. 361

ADB Input Events scene ................................................................................................................................... 362

ADB resource ................................................................................................................................................... 364

ADB Set Property scene .................................................................................................................................... 365

ADB Start Activity scene ................................................................................................................................... 366

CHAPTER 17 - CONTENT INSPECTION SCENES ................................................................................................ 367

PROTOCOL SCENES ........................................................................................................................................................ 367

Match Protocol Headers scene ......................................................................................................................... 368

CONTENT SCENES ......................................................................................................................................................... 368

Match Textual Content scene ............................................................................................................................ 369

Basic Content Tests scene .................................................................................................................................. 371

mobileOK scene ................................................................................................................................................. 372

Start Content Tests scene .................................................................................................................................. 375

Stop Content Tests scene ................................................................................................................................... 376

Check Device Hurdle scene ............................................................................................................................... 377

Record Content Metrics scene ........................................................................................................................... 378

XPath Query scene ........................................................................................................................................... 382



IMAGES SCENES ............................................................................................................................................................. 383

Match Image scene ........................................................................................................................................... 385

Match Image on Page scene ............................................................................................................................ 386

AUDIO SCENES .............................................................................................................................................................. 387

Audio Analysis scene ......................................................................................................................................... 388

Detect-mWatt scene .......................................................................................................................................... 389

Detect-fax scene ................................................................................................................................................ 390

VIDEO SCENES ............................................................................................................................................................... 390

Generate Video MOS Score scene .................................................................................................................... 391

CHAPTER 16 - REAL DEVICES SCENES ................................................................................................................ 392

S60 SCENES ................................................................................................................................................................... 392

Make Tethered MA Connection S60 scene ........................................................................................................ 393


Press Tethered MA Key S60 scene .................................................................................................................... 395

Enter Tethered MA Text S60 scene ................................................................................................................... 396

Match Tethered MA Screen scene ..................................................................................................................... 397


Clear Tethered MA Inbox S60 scene ................................................................................................................. 399

Send Tethered MA SMS S60 scene .................................................................................................................... 400

Send Tethered MA MMS S60 scene .................................................................................................................. 401

Receive Tethered MA SMS S60 scene ............................................................................................................... 402

Receive Tethered MA MMS S60 scene .............................................................................................................. 403

Visit Tethered MA Page S60 scene ................................................................................................................... 404

SE SCENES ..................................................................................................................................................................... 404

Make Tethered MA Connection SE scene ......................................................................................................... 405


Press Tethered MA Key SE scene ..................................................................................................................... 407

Enter Tethered MA Text SE scene ..................................................................................................................... 408

Match Tethered MA Screen scene ..................................................................................................................... 409


Capture Tethered MA Text SE scene ................................................................................................................ 411

ANDROID SCENES .......................................................................................................................................................... 411

ADB Get Property scene ................................................................................................................................... 412

ADB Input Events scene.................................................................................................................................... 413

ADB resource ................................................................................................................................................... 415

ADB Set Property scene .................................................................................................................................... 416

ADB Start Activity scene ................................................................................................................................... 417

CHAPTER 18 - ALARMING SCENES ....................................................................................................................... 418

Check Thresholds scene ..................................................................................................................................... 419



Raise SNMP Trap scene ................................................................................................................................... 420

Raise ARF Trap scene ...................................................................................................................................... 422

CHAPTER 19 - REPORTING SCENES ..................................................................................................................... 424

Record Message scene...................................................................................................................................... 425

Record Metric scene ......................................................................................................................................... 426

Record Timing scene ........................................................................................................................................ 427

Record Meta Tag scene .................................................................................................................................... 428

Record Service Type scene ............................................................................................................................... 429

Get GPS Location scene ................................................................................................................................. 430

Random scene ................................................................................................................................................... 431

Internal timing point scene ............................................................................................................................... 432

Scale Metric scene ............................................................................................................................................ 433

Report Hardware Platform scene .................................................................................................................... 434

DATA SCENES ............................................................................................................................................................... 434

Upload File to Projector scene ......................................................................................................................... 435

PARTY RESOURCES ........................................................................................................................................................ 437

Propagate Metrics resource ............................................................................................................................. 438

Propagate Messages resource .......................................................................................................................... 439

Propagate Timings resource ............................................................................................................................ 440

COLLECTOR SCENES ...................................................................................................................................................... 440

Combine Availabilities scene ............................................................................................................................ 441

Aggregate Metrics scene ................................................................................................................................... 442

Rereport Metrics scene .................................................................................................................................... 443

Aggregate Timings scene ................................................................................................................................. 444

Rereport Messages scene ................................................................................................................................. 445

Rereport a Message scene ................................................................................................................................ 446

ETSI SCENES ................................................................................................................................................................. 446

ETSI KPI Reporter scene .................................................................................................................................. 447

ETSI Network Non-Accessibility scene ............................................................................................................. 448

ETSI Generic KPI Calculator resource ............................................................................................................ 449

ETSI HTTP KPI Calculator resource ............................................................................................................... 450

ETSI FTP-DL KPI Calculator resource ........................................................................................................... 451

ETSI FTP-UL KPI Calculator resource ........................................................................................................... 452

ETSI SMS KPI Calculator resource ................................................................................................................. 453

ETSI GPRS Attach KPI Calculator resource .................................................................................................... 454

ETSI PDP Context Activation KPI Calculator resource .................................................................................. 455

ETSI Voice KPI Calculator resource ................................................................................................................ 456

ETSI WAP KPI Calculator resource................................................................................................................. 457



ETSI DNS KPI Calculator resource ................................................................................................................. 458

ETSI Ping KPI Calculator resource ................................................................................................................. 459

CDR SCENES ................................................................................................................................................................. 459

CDR Reporter scene ......................................................................................................................................... 460

CDR Calculator resource ................................................................................................................................. 462

CHAPTER 20 - INTEGRATION SCENES ................................................................................................................. 463

Run Local Command scene ............................................................................................................................... 464

Access a Database scene ................................................................................................................................... 465

CHAPTER 21 - CDMA SCENES ................................................................................................................................. 466

MDNCSVList resource ....................................................................................................................................... 467

CDMA Setup Modem scene .................................................................................................................................. 468

CDMA Report Party scene ................................................................................................................................ 469

CDMA Report Byte Counters scene................................................................................................................... 470

CDMA Report Hardware Info scene ................................................................................................................. 471

CDMA Report Network Info scene .................................................................................................................... 472

CDMA Report Voice TimeStamps scene ........................................................................................................... 473

CDMA Make Voice Call scene .......................................................................................................................... 474

CDMA Receive voice call scene ........................................................................................................................ 475

CDMA Drop Voice Call scene .......................................................................................................................... 476

CDMA Enable Call-Forwarding scene ............................................................................................................. 477

CDMA Disable Call-Forwarding scene ............................................................................................................ 478

CDMA Send DTMF Tone scene ....................................................................................................................... 479

CDMA Send DTMF Sequence scene ................................................................................................................ 480

CDMA MDN CSV List Get First scene......................................................................................................... 481

CDMA MDN CSV List Get Next scene ............................................................................................................. 482

CDMA Set Mobile Id scene.................................................................................................................................. 483

CDMA Set Network scene ................................................................................................................................... 484

CDMA Set Active NAM scene .............................................................................................................................. 485

CDMA Write PRL File scene ............................................................................................................................ 486

CDMA Set CDMA Mode scene ......................................................................................................................... 487

CDMA Set Akey scene ....................................................................................................................................... 488

CDMA Reset Modem scene .............................................................................................................................. 489

CDMA Enable Notifications scene .................................................................................................................... 490

CDMA Report Notifications scene ..................................................................................................................... 493

CDMA Receive MMS DM scene ....................................................................................................................... 494

CHAPTER 22 - THE REPORTING FRAMEWORK GROUP ................................................................................. 495

Testcase resource .............................................................................................................................................. 497



Record Step Status scene .................................................................................................................................. 498

Report Testcase scene ...................................................................................................................................... 500

Start Testcase scene .......................................................................................................................................... 501

End Testcase scene ........................................................................................................................................... 502

Rereport Testcase Metrics scene ..................................................................................................................... 503

Rereport Testcase Messages scene TBA ........................................................................................................... 504

APPENDIX A - REAL DEVICE KEY CODES .......................................................................................................... 505

KEY CODES FOR SERIES 60 DEVICES .............................................................................................................................. 505

KEY CODES FOR SONY ERICSSON DEVICES .................................................................................................................... 506

APPENDIX B - CDMA TESTING ............................................................................................................................... 507

CDMA SCRIPTING ........................................................................................................................................................ 507

CDMA SETUP ............................................................................................................................................................... 507

CDMA TROUBLESHOOTING .......................................................................................................................................... 507

APPENDIX C - SUPPORTED NETWORKS.............................................................................................................. 510

NETWORK SUPPORT FOR SCENES AND RESOURCES ........................................................................................................ 510

APPENDIX D - HTTP RESPONSE CODES .............................................................................................................. 524

HTTP V1.X RESPONSE CODES ...................................................................................................................................... 524

INDEX ............................................................................................................................................................................. 526


Chapter 1 - Introduction

This guide provides a detailed reference for each of the Story Boarder scenes and resources that may be available to

you, as well as other supporting information. It is mainly intended for use as a reference, while developing scripts.

Story Boarder is a GUI tool for creating Test Scripts from pre-defined objects called scenes and resources. A scene

specifies a test step, such as Send SMS or Visit page; a resource configures information used by the test, such as

Device, Recipient or Connection.

To create a Test Script, you connect the scenes (steps) together using the outcomes you want to handle (such as

OK, SMS sent or SMS not sent due to service failure) to create a diagram of the Test you want to run, in the

Overview Window:

You then edit the properties of the test's scenes and resources to suit your particular network and service, and your

Test Script is ready to run.

To create a more complex (multi-party) script, you create each party on a separate tab in the Overview Window -

and view the combination in the Master Window.

Using this Guide This guide provides a detailed reference for test script developers, to supplement the contextual help provided, as

follows:

Chapter 1: A brief introduction to this guide.

Chapter 2: A brief introduction to using scenes and resources.

Chapter 3 - Chapter 22: A separate chapter per Sidebar Group, providing a detailed reference for each scene

and resource available, describing its purpose, the properties you use to customize it, and the routes

(outcomes) you can use to connect scenes together. Presented in Sidebar order for ease of access.

Appendix A lists keycodes for use with Real Devices.

Appendix B provides a brief overview of support for CDMA networks and guidelines for CDMA

troubleshooting.



Appendix C lists all scenes and resources, indicating which can be used with each type of network (GSM,

CDMA, LTE or TD-SCDMA).

Appendix D lists HTTP return codes and explains what they mean.

Other Guides There are two other guides of particular importance to test script writers:

The Story Boarder User Guide - detailed introduction to using Story Boarder, complete with step-by-step

tutorials.

The Advanced Scripting Guide - more advanced information, including the ArgoScript functions, the

properties and methods of the other COM objects you can use, useful techniques and technical details of

how scripts work.

For information on scheduling tests, see:

The Quality Manager User Guide - enterprise-level scheduling and resource management in Central Mode,

using Monitor Master QM users

The Screening Room User Guide - single-Agent scheduling and resource management in Local Mode, using

Screening Room (deprecated)

For information on using test results, see:

Using Box Office Reports - using the Standard Reports and Custom Reports

Developing Reports with Box Office - customising the Standard Reports and creating your own dashboards

and reports

The Projection Room User Guide - enterprise-level reports (deprecated)

The Screening Room User Guide - single-Agent reports (deprecated)


Chapter 2 - Using scenes and resources

This chapter serves as a brief review of the techniques you will need to use scenes and resources:

Main Techniques

Default Routes

Resource Files

Sidebar Groups

This information is presented in much more detail in the Story Boarder User Guide.

Main Techniques Here is a brief summary of the main techniques you will use to build a script from scenes and resources:

To add a scene to the Script, double-click it, or drag it from the Sidebar to overlap the scene to connect to,

then choose the route to connect to from the popup menu

To change an added scene's properties (parameters), double-click it or right-click it and choose Properties

from the popup menu

To change the connections between scenes, you can drag the arrows around or right-click a scene and

choose Link To from the popup menu

To add a resource to the Script, double-click it or drag it to the resource pane

To change an added resource's properties (parameters), double click it or right-click it and choose

Properties from the popup menu

To delete a scene or resource, select it and press Del, or right-click it and choose Delete from the popup

menu

To rename a scene or resource, select it and press F2, or right-click it and choose Rename from the popup

menu

Note: For more detailed information, see the Story Boarder User Guide.

Default Routes In the scene descriptions, the first route listed is always the OK route. This is the "no error" route, the one that the

next scene added will connect to, by default.

Resource Files Once you have added a resource to a Script and configured it, you can save it as a resource File (*.mtsr) to create a

customized resource, pre-configured with the settings you need for your network, test accounts, users, etc.

You can add resource Files to a Script by right-clicking in the resources pane and selecting the Read From option

from the popup menu.

For details, see Saving and Loading resources, in the Story Boarder User Guide.



Sidebar Groups The scenes and resources provided with Story Boarder are organised into Groups in the Sidebar. This guide

describes each one in the Groups and order within the Groups:

Standard

Resources

Scripting

Test

Probe

Terminals

Connections

Voice

Video Call

Network

Supplementary Services

Messaging

Browser

Real Devices

Content Inspection

Alarming

Reporting

Integration

CDMA

Testcase Scenes

You may not see all these Groups, or all the scenes and resources listed in each Group: some are optional

(providing support for options such as PESQ or VoIP which you may not have) and Story Boarder may also be

configured to hide Groups that are of no interest to you.


Chapter 3 - Standard scenes

The scenes in the Standard Group are:

Start

Comment

End



Start scene Purpose: Defines the beginning of the Test (where execution starts) and configures the Test's properties, which

include:

Runtime parameters. These provide a way to prompt for selected scene / resource properties when the

script is run, or read values from the User Data Table. You can add validation rules to help guarantee valid

data

Metric Aliases. Alternative names for the built-in metrics.

Settings for this test, such as whether to perform multipart recursion.

Plugins that this test needs to use. Plugins provide additional facilities for use in the Script, but may make it

run slower.

A Script can only have one Start scene.

Properties:

Analysis Levels

AnalyseXMLContent - select True to analyse XML content. Default: True

DeviceCapabilityChecks - select True to emulate the selected device(s) i.e. to enforce the device capabilities

and behavior specified by the selected device profile(s). Default: True

MultipartRecursion - select True to recurse into multipart MIME documents. Default: True

PurgeRunData - select True to delete all detail records after a successful run (to help reduce database

loading and network traffic). Default: False

RecordContent - select True to record content in the database. Default: True

RecordDebugData - select True to record debug data (browser variables and the script) in the database.

Default: True

RecordScriptState - select True to record Script State records in the database. Default: True

XMLScripting - select True to analyse XML scripts. Default: True

Data

Description - a simple, short description of this Script. (For a longer description, use a Comment scene.)

MetricAliases - used to define additional names for metrics. These aliases will then be used as well as the

usual metric names, in the reports and results database. See Metric Aliases.

Parameters - used to define runtime parameters. Add a runtime parameter for each scene/resource property

you want to configure at runtime. You can specify whether to read their values from the current Agent's

User Data Table, or enter them at run time - the values are then assigned to the related scene/resource

properties. See Runtime Parameters.

Plugins

DMP - select True to enable the DMP plugin, to support DMP text menus. Default: False

HTML - select True to enable the HTML plugin, to generate better-quality HTML. Default: True

Hint: for more information on using Plugins, see Chapter 8 of the Story Boarder User Guide

Routes:

Normal - the Test has started. There are no failure routes for this scene!



Metric Aliases

A Metric Alias is an additional name for a Metric, providing an easy way to output Metrics with names that are

customised to your purposes. The script will output the Metric value twice: once with its original name and once

with its alias.

Adding a Metric Alias

Click the button in the MetricAliases value field in the Start scene's properties, to display the List of

Transaction Metric Aliases

Click Add to add a default "blank" alias:

Click Alias and type the alias (new name) to create

Click MetricName and select the metric to alias from the dropdown list

Click TransactionName and select the transaction (scene or Custom Transaction) that creates the metric

Click Add and repeat to add another alias, or click OK if finished.

Deleting a Metric Alias

Delete a Metric Alias to output the Metric with just its default name.

Select the alias from the left-hand list.

Click Remove

Runtime Parameters

A Runtime Parameter provides an easy way to change the value of a specified property of a specified scene or

resource, at runtime.

Hint: Also see the Parameter resource.

Adding a Runtime Parameter

To add a runtime parameter:

Click the Parameters value field to display its button. Click this to display the List of Parameters dialog.



Click Add to add a default "blank" parameter:

To validate the input data, click the Constraints field then click its button to display the List of

Constraints dialog - see Parameter Validation Rules, below

To supply a default value, click Default and type the value to use.

Click Description and type a description. This will be displayed as help text for this parameter, when

prompting for it at runtime.

Click Name and type the parameter name. This will be used to prompt the user at runtime or search the

User Data Table.

Click Scene and select the scene/resource to pass the value to

Click SceneParameter and select the property to pass the value to

Click Source to select where the value will come from, at runtime:

Test Parameter - the user will be prompted with the current default value at runtime. The user can

edit the default value or leave it. When they click OK, the current displayed value will be used. The

default value is set in the Start scene, but the user can change it at runtime.

User Data Table - the value will be read from the parameter with the same name in the Agent's User

Data Table. If there is no parameter with this name, the default value defined in the Start scene will

be used

Both - the user will be prompted to supply a value at runtime. If they do not supply a value, the

value will be read from the Agent's User Data Table. If there is no matching parameter, the default

value (from the Start scene) will be used

Click Add and repeat to add another parameter or click OK if finished.

In Central Mode, change parameter values on the Scheduler's Parameters tab. In Local Mode, change parameter

values in the Parameters for Test dialog.

Adding Parameter Validation Rules (Constraints)

In the List of Parameters, click the Constraints field then click its button



In the List of Constraints:

Click the down-arrow on the right of the Add button and select the validation:

IntValidationAttribute - defines the range of numeric values allowed for this parameter, and any

exceptions outside of that range

RegexValidationAttribute - defines a regular expression that the parameter must match

ObjectValidationAttribute - defines whether the parameter may be omitted (Null) or left blank

StringValidationAttribute - defines the range of characters that may appear in the parameter

StringLengthValidationAttribute - defines the range of lengths of the text that may be entered

Configure the constraint using the fields on the right. For example, if you added an IntValidationAttribute

constraint it starts like this:

Click Exemptions to add the list of valid values

Click Max to change the maximum value allowed

Click Max to change the minimum value allowed

Notice how the member name (on the left) evolves to reflect your changes as you move between the fields.

For example, with Exemptions=0,2 it changes to Number must be one of 0,2

Once you've finished the constraint either use Add to add another, or OK to save the constraints and return

to the List of Parameters dialog



Note: Parameters are validated at runtime according to any validation rules (defined in the Start scene) AND the

range and data type of the destination scene/resource property (in the scene/resource definition).

Changing the order of Runtime Parameters

The order in the list of parameters sets the order they are prompted for. In the List of Parameters, select the

parameter to move from the left-hand list.

Use the buttons to move it up or down.

Click OK when finished.

Deleting a runtime parameter

In the List of Parameters, select it from the left-hand list.

Click Remove



Comment scene Purpose: Adds a Comment window to the Script.

The Comment window is a yellow rectangle. Click inside it to type or edit comments about this Script. You can

move a Comment window by dragging its border, and resize it by dragging its lower right-hand corner. The

comment text is only visible while in the Story Boarder; comments are for Script writers rather than Script users.

You can add multiple comments, e.g. to document different parts of the Script.

The Comment scene does not have any Routes - it is not connected to any scenes in the Script.



End scene Purpose: Marks the end of the Script and provides a way to execute code at the end of the script.

An End scene is optional, but helps make the structure and flow of the script much clearer.

Properties:

Text

Cleanup - code to execute after the test has finished. Click the button to display the Properties for

Cleanup dialog:

Type the code to execute, using standard VBScript syntax, VBScript and ArgoScript functions and other

supported COM objects.

Note: This code will be executed when the script ends normally, or with a system error or service error. It

will NOT be executed if the script ends with a scripting error or timeout.

See Writing code in the Script scene description for information on the script editor.

See the Advanced Scripting Guide for detailed information on the scripting environment, including the

ArgoScript functions.

Click OK to save the changes.

A single-part script can have only one End scene. A multi-party script can have one End scene per party.


Chapter 4 - resources

Resources are information items that are used by scenes, typically representing (and configuring) a real resource

such as a device, port, connection, or device user. When you select a resource it is added to the resources Pane

rather than being added to the storyboard in the Script Window. If you use a scene that requires a resource that has

not been added to the Script, you will be prompted for it.

You can add more than one instance of certain resources to a Script and then specify which one to use in a scene by

editing the scene's properties. You can edit a resource's name, once added to the Script, save a resource to disk

(complete with all properties) and load it from disk.

Resources don't have Routes because they aren't executed.

The resources are organised into the following Groups within the Resources Group, for your convenience:

Scripting

Test

Terminals

Connections

Browser

Audio

Video

Content

PCAP

Power Control

Advanced SIM Management

XML File

VoIP

Resources are also included in other Groups where relevant to that area.

Scripting resources These resources can be used to support and extend the functions provided, by adding code written in VBscript and

ArgoScript:

Script

Engineer



Script resource Purpose: Used to define functions for your Script scenes to use. A Script scene uses the resource name and function

name to invoke a function.

Properties:

Script: Type the function/procedure/subroutine definition(s) to share, using standard VBScript syntax,

VBScript and ArgoScript functions.

For example:

Function getquarter()

Select Case Month(Date)

Case 1, 2, 3

getquarter="first"

Case 4, 5, 6

getquarter="second"

Case 7, 8, 9

getquarter="third"

Case 10, 11, 12

getquarter="fourth"

End Select

End Function

For general information on creating functions, procedures, and subroutines, see any standard text on VBScript. For

information on using the Script resource and a complete description of the ArgoScript functions see the Advanced

Scripting Guide. See Writing code in the Script scene description for more information on using the script editor.

References

You can use the References tab to document other objects that the Script resource uses. This is not a requirement,

although future versions of the product may use this information to help automate script deployment.

Select the References tab from the Script resource properties dialog:



Click the on the Add button and select the object type:

Library Function - add a Library Function

COM Object - add a COM Object reference

URI - add a file reference



Engineer resource Purpose: Used to define engineering functions, to extend the processing performed by a standard scene. If a scene

specifies an Engineer resource in its properties, when the scene is executed it will call the appropriate engineering

functions from that resource at specific stages. For example, if the Engineer resource for a scene contains a

definition for the SceneEntry() function, this function will be executed at the start of that scene.

Story Boarder also provides pre-defined Engineer resources for specific applications. See Video Engineer and

PCAP Engineer for details.

Properties:

Script: Type, paste, or edit the function definitions to execute, using standard VBScript syntax, VBScript and

ArgoScript functions. See the Advanced Scripting Guide for details of the ArgoScript functions and the

scripting environment; in particular, see The Engineer resource for essential information on writing

engineering functions.

See Writing code in the Script scene description for more information on the script editor.

References: On this tab, declare any external objects the engineering functions use. See References, below.

References

You use this tab to document other objects that the resource uses. This is not a requirement, but future versions of

the product may use this information to help automate script deployment.

Select the References tab from the Engineer resource properties dialog:


Library Function - add a Library function

COM Object - add a COM Object references

URI - add a file reference



Test resources General-purpose data stores:

Prop

Props

PropStore

File

Parameter



Prop resource Purpose: Used to define a global variable for use by scenes in this script. A Prop can be used to:

create a constant (named value)

pass information to or from a scene, at run time

create a global variable for use by Script scenes (using VBScript)

Properties:

Value - Type the (initial) value for this Prop or leave blank.

Prop resources will normally be renamed to give them a name reflecting their value, such as Test User APN or

Password. For more information on using Props, see Using Props in the Story Boarder User Guide.

Hint: Don't confuse the Prop resource with the Props resource - described next.



Props resource Purpose: Used to define an array of global variables for use from VBScript (in Advanced Script scenes) at run time.

Script scenes uses the resource name and a numeric index (0, 1, 2, etc.) in VBScript to refer to a string.

Properties:

Strings - click the button to display or edit the strings. This displays the List of Strings dialog:

To add a string, click Add, click the Text field on the right, type the string, and press Enter. Repeat to add

more strings.

To remove a string, select it from the left-hand list and click Remove.

To change the order of the strings (renumber them), select a string and use the buttons.

Click OK to close the dialog.

VBScript (in Script scenes) can read or write Props resources at run time by using the Prop name and member

number - see the Advanced Scripting Guide for details.



PropStore resource Purpose: Used to define global variables for use from VBScript (in Script scenes) at run time. Script scenes uses the

resource name and member name to refer to a value.

Properties:

Values - click the button to display or edit the member variables. This displays the NameValue

Collection Editor:

To add a member:

Click Add to add a blank name and value

Click the Name field on the right and type the member name

Click the Value field on the right and type its value

Repeat to add more members.

To remove a member, select it from the left-hand list and click Remove.

To change the order of the members (renumber them), select a member and use the buttons.

Click OK to close the dialog.

VBScript (in a Script scene) can read or write member values at runtime, by using the PropStore name and member

name - see the Advanced Scripting Guide for details.



File resource Purpose: Defines a file for use by scenes such as Send MMS.

Properties:

Data

FileName - type the pathname to use or click the button to display a Select File dialog and select it.

Default: blank



Parameter resource Purpose: Defines a Prop whose value is set by a matching Runtime Parameter.

This Parameter will be included in the Parameters for Test dialog when running this test from Story Boarder in

Local Mode, and on the Parameters tab of Schedule Test dialog when scheduling from QM (Central Mode), giving

you an easy way to set the value of the Prop at runtime.

Properties:

This resource has no properties.

Terminals resources The following resources define and configure the devices used to connect to the network under test:

SmartModem

LAN

Modem

CDMA Hardware

They are also referred to collectively (by other scenes and resources) as Hardware resources.



SmartModem resource Purpose: Defines the hardware (SmartModem) to use to connect to the service under test and (for Type 2 Modems)

optionally the Operator and RAT to use. Can also be used to check the modem state before use.

Key changes for v10.3.3

Added reporting of the assigned IP address, once a data connection has been made (see IP address, below)

Using this resource

Properties:

Data

CentralManaged - select True if the SmartModem is managed by QM; select False if not. Default: True

DeviceName - the name of the SmartModem to use in Local Mode - ignored in Central Mode. Default:

blank

On a Monitor Master QM system, test scripts are usually saved to, loaded from and scheduled from your

QM Server. This is Central Mode. In Central Mode, DeviceName is ignored; you choose which SmartModem

to use when you schedule the testrun.

A script can also be saved direct to an Agent and run from Story Boarder or Screening Room. This is Local

Mode. In Local Mode, DeviceName specifies the SmartModem to use so it must be set to the name of a

SmartModem on that Agent so the script can find and use it when it runs.

Operator Settings

Operator - optional. Type the name of the Operator resource to use, for a Type 2 Modem. Ignored on Type 1

Modems. Default: blank

Radio

RAT - the RAT lock to attempt during initialization of a Type 2 Modem, if RATLocked (below) is set to

True. For a list of valid settings, see the Set RAT scene. Default: LTE

State

GPRSAttached - whether to wait for the modem to attach to the GPRS service. Default: True

NetworkRegistered - whether to wait for the modem to register on the network. Default: True

Note: Must be set to False for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs

PoweredOn - whether to wait for the modem to power on. Default: True

RATLocked- whether to attempt to RAT lock a Type 2 Modem during initialisation. The RAT lock to

attempt is set by the RAT setting described above. Default: True

SMSReady - whether to wait for the SIM to be ready. Default: False

Power-up sequence

If the modem is powered down when you run the test, it will power up on the first access attempt by the script;

the script will wait for the time specified by the powerup-report-delay setting before beginning the enabled checks.

If a test uses the modem's Local SIM or the modem does not have a SIM, the modem will stay powered up when

the script ends. If a test uses a SIM Server SIM the modem will power down when the script ends.



Checks

The state checks that you have enabled (GPRSAttached, NetworkRegistered, etc) are performed in the following

sequence, the first time the script attempts to access to the hardware (after the power-up delay, if the modem was

powered down):

PoweredOn

Attempt RAT Lock

SMSReady

NetworkRegistered

GPRSAttached

Timeouts

If the modem is not (yet) in the specified state when the check is made, the script will wait for the state to change

for:

PoweredOn - 150 seconds (or powerup-report-delay + 30 seconds, if greater)

SMSReady - 240 seconds

NetworkRegistered - 120 seconds

GPRSAttached - 240 seconds

If the specified state is not achieved within the timeout period, the scene that accessed the modem will fail with a

system error.

Network Registration and LTE Modems

An LTE device needs a valid APN (Access Point Name) in the PDP profile it uses to register on the network when

it starts up. Since the APN is network-specific, it is usually stored in (and read from) the Operator Settings file for

each Operator.

For Monitor Master v9.2.0 and earlier, the OperatorSetting setting could be used to specify which Operator

settings (service type) to use from the Operator Settings, for Type 2 Modems. The APN from these settings was

written to the modem's default profile (#1) before registering to the network with that profile.

In Monitor Master v9.2.1 the OperatorSetting setting was removed from this resource. The Operator Settings now

specify which settings to use to register on each network and can also specify the PDP type (IPv4 or IPv6):

the service type to use is specified by adding a CID field to it with the value "1"

the PDP type to use is specified by adding a PDP_TYPE field to it with the value set to "IP" or "IPv4" (for

IPv4) or "IPv6" (for IPv6)

If the Operator Settings for the network do not include a service type with a CID field set to "1", the settings for

"Internet" will be used as in previous releases.

So, to make sure that LTE modems register correctly:

1. Check that your Operator Settings file contains a service type for each LTE network you want to use, with a

valid APN for that network.

2. Check that this service type contains a CID field set to "1" to identify it as the default service.

3. (You can view the Operator Settings file by using the QM System/Operators menu option - and edit it if you

have the right permissions.)

4. In the script, set the SmartModem resource's Operator parameter to the name of the Operator resource.

If you do not follow these three simple steps, LTE devices may have trouble registering on LTE networks, as they

will attempt to register using whatever APN their default profile is currently set to.

When the script runs, it will only reprogram the modem's APN if:

The Operator Settings file specifies a APN as described above



The APN specified is different to the modem's current default APN

Reprogramming the modem's APN may take up to 20 seconds. This should not affect most users, but might cause

scripts to take slightly longer to run, compared to previous versions of Monitor Master.

SMS Ready, Network Registration and GPRS Attached checks

For Monitor Master v9.0 and earlier, the SMS Ready check was only performed if the Network Registered check

was enabled - and it was performed after Network Registration. This could cause problems if the SMS caching took

more than 2 minutes.

For Monitor Master v9.1 onwards:

The SMS Ready check is performed even if the Network Registered check is not enabled

If both are enabled, the SMS Ready check is performed before the Network Registered check

For Monitor Master v9.0 and earlier, the SMS Ready and GPRS Attached checks were repeated each time a scene

accessed the hardware - causing unnecessary delays.

For Monitor Master v9.1 onwards:

The SMS Ready and GPRS Attached checks are usually only performed once, during modem power-up

If the device is powered down and up again during the script, the checks will be performed again for each

power-up

Unmanaged Terminals in Central Mode

When you schedule a test via QM, you assign the Terminal (SmartModem) to use for the script (or each party, in a

multi-party script). If the script/party doesn't use a SmartModem resource, assign an UNMANAGED or DUMMY

Terminal to it, to avoid booking resources that aren't needed.

IP address

Once a data connection has been made, the IP address that's been assigned to it can be accessed through the

SmartModem resource's IPAddress property (using an Advanced Script). This will return a single address as

follows:

If the PDP_TYPE is IPv4 and an IPv4 address has been assigned: the first IPv4 address found

If the PDP_TYPE is IPv4 but no IPv4 address has been assigned: the first IPv6 address found

If the PDP_TYPE is IPv6 and an IPv6 address has been assigned: the first IPv6 address found

If the PDP_TYPE is IPv6 but no IPv6 address has been assigned: the first IPv4 address found



LAN resource Purpose: Defines the network adaptor (hardware) or virtual network adaptor (software) to use to connect to the

service under test

Note: If your test uses a LAN connection, you should set up a LAN Operator and LAN Subscriber in QM as

described in the Quality Manager User Guide (see Adding a LAN Subscriber), then use the LAN Subscriber to schedule

testruns.

Properties:

Data:

DeviceName - the name of the LAN terminal to use (as listed by the QM System/Terminals/Administer

Terminals menu option). If left blank, AdaptorName will be used instead, or if that's blank too, the default

Windows adaptor will be used.

Used if there is more than one LAN adaptor on the probe, to select which to use. Should not be used in

Local Mode (leave blank or use AdaptorName). Ignored in Central Mode (overidden by QM) unless

IsManaged is False. Default: blank

Management:

IsManaged - select whether this resource is managed from QM Server (True) or not (False). If True, when

the adaptor is selected by the QM scheduler, it will over-ride DeviceName. Default: True

Network:

AdaptorName - the name of the LAN adaptor to use (the adaptor description displayed by ipconfig /all).

Required if using IP Trace on a probe with more than one LAN adaptor. Can also be used to specify which

LAN adaptor to use when running in Local Mode. Default: blank

Using a Virtual Network Adaptor

If you are using a virtual network adaptor, you must configure the LAN resource as follows:

DeviceName must be blank because virtual adaptors are not defined in NTService.ini

IsManaged must be True

AdaptorName must be set to the adaptor description displayed by ipconfig /all on the probe. For example,

for OpenVPN: TAP Windows Adapter V9



Modem resource Purpose: Defines the hardware (modem) to use to connect to the service under test

Properties:

Data

DeviceName - the port (COM1, COM2, etc) the modem is connected to, or the Connector name* (e.g.

mblox). Default: COM1

DMPort - type the name of the port to use for Diagnostic Mode, or leave blank if there is none. Default:

blank

LocalPosition - type the slot number for a SmartModem, or any number between 0 and 99 for a

conventional modem

Misc

NetworkType - the type of network being used. This property should be ignored by most users. It can be

set to GSM/WCDMA, GSM/WCDMA/LTE, CDMA or CDMA/LTE but should only be changed if you have

been told to do so by our Support Department

TraceVersion - the trace version being used. This property should be ignored by most users. It can be set to

QUALCOMM_TRACE, QUALCOMM_TRACE_CDMA or LG_TRACE but should only be changed if you

have been told to do so by our Support Department.

*Note: For information on the optional Connectors, see the Story Boarder User Guide.



CDMA Hardware resource Note: For use on CDMA networks only.

Purpose: Defines the hardware (CDMA device) to use to connect to the service under test

Properties:

Control Set

Note: These settings are only used in Central Mode; the Subscriber details must include the appropriate

MIN and MSL to enable NAM programming.

PrimarySetupAction: select the primary action to perform: Use or Overwrite. Default: Use.

Use means use NAM0 if its MDN matches the selected Subscriber's MSN. Otherwise perform the secondary

setup action.

Overwrite means write the selected subscriber details (MDN, MIN, NID and SID) to NAM0, then use it.

SecondarySetupAction: select the secondary action to perform: UseIfSame or Overwrite. Default:

Overwrite

UseIfSame means use NAM1 if its MDN matches the selected Subscriber's MDN. Otherwise overwrite and

use NAM1

Overwrite means write the selected Subscriber's details (MDN, MIN, NID and SID) to NAM1, then use it.

Data

Note: This setting is only used in Local Mode.

DeviceName: Type the name of the SmartModem to use to connect to the CDMA network. (Ignored in

Central Mode, when the SmartModem to use is selected when the test is scheduled.)

For information on testing CDMA networks, see Chapter 21, Appendix B and Appendix C.

Connections resources These resources configure aspects of the connection to the network under test:

Operator

Device

Devices

User

Connection

Multi Connection

Connection Context

HTTP Client

CDMA MMS Client



Operator resource Purpose: Defines the operator and service to use in legacy Local Mode only. There is a separate version of the

Operator resource for each country, operator and service supported by Monitor Master.

The Operator resource is only used if the script runs in Local Mode (outside Monitor Master QM) i.e. if the script is

stored on an Agent (rather than on the QM Server) and run from there using Screening Room or Story Boarder.

(Think of the Operator resource specifying a default Operator for Local Mode users.)

For most Monitor Master QM users the Operator resource is ignored! Operator definitions are stored centrally, on

the QM Server, and maintained by the QM administrator. If a script is run in the default Central Mode, the

operator definition used is dictated by the Subscriber/SIM allocated to the testrun; the script's Operator resource

will be completely ignored.

Note: If you are using a LAN connection, you should set up a LAN Operator and LAN Subscriber in QM as

described in the Quality Manager User Guide (see Adding a LAN Subscriber) and use that Subscriber to schedule

testruns.

When you add an Operator to the script, the Operator Wizard runs to list the Operators available - simply choose

one and click Finish.

Properties:

Connection

Settings - a list of the connection types (services) supported by this operator and the settings they require.

Click the Invoke Wizard link to choose a different Operator.

Data

CentralManaged - set to True to load the Operator Settings from QM Server, at runtime. Default: True

To examine the Operator settings:

Click the Settings field to display its button

Click the button to display the List of Connection Types:

Select the service (connection type) from the Members list on the left, then click the Values field on the

right to display its button



Click the button to display the values used for that connection type, like this:

To examine a setting, select it from the Members on the left.

To edit a displayed setting (for this test only), click in the Value field on the right, retype the value, then

click OK or select another member to save the change.

To add a setting (for this test only), click the Add button, fill in the Name and Value on the right, then click

OK or select another member to save the change.

Operator settings can use values from the testrun - see Using values from the testrun, below.

You can use Operator settings to define client (request) headers - see Adding client headers, below.

Remember that this resource (with any changes made by the script) is only used when running the script in Local

Mode. To make changes to an Operator for use in Central Mode, your System Administrator must edit the

Operator details in Quality Manager - see Managing QM resources in the QM Administration Guide.

Hint: Click the Invoke Wizard link in the Operator resource's main properties dialog to select a different Operator.

Hint: For more detailed information and application examples, see The Operator resource in the Advanced Scripting

Guide.

Adding client headers

You can add headers to the settings for a service so they will be sent automatically as part of the client (request)

headers for a data connection.

Note: These headers are only output when using the legacy ArgoBrowser; they are not output by the Internet

Explorer or WebBrowser browsers.

To add a client header to an Operator resource service:

Edit the properties of the Operator resource

Edit the settings field, then select the service as described above

Click Add to add a new setting (member)

Set the setting Name to ClientHeader_ followed by the header name. For example: to send a header called

x-test-enabled, set Name to ClientHeader_x-test-enabled

Set the setting Value to the value to pass in the header, e.g. True

Click OK to add the header.

You can add multiple headers in this way, for use by the script in Local Mode. See Example client headers, below.



To add headers to an Operator for use in Central Mode, your System Administrator must edit the Operator details

in Quality Manager - see Managing resources in the QM Administration Guide.

Using values from the test

To use values from the test (at runtime) in an operator setting, use this syntax:

{location/valuename}

where location is TestProperty or Hardware or { and valuename is as described below. This technique can be used to

set client headers or any other operator settings.

Using TestProperty values

The TestProperty values you can use are listed in Appendix A and Appendix B of the Advanced Scripting Guide. They

include phone, data, and fax numbers, operator name and terminal name.

For example: to set a header value to the MSISDN used by the main party followed by the fixed text "@who.com",

you would use:

{TestProperty/v1.1/SIMs/main/callNr}@who.com

Using Hardware values

The Hardware values you can use are:

DeviceName - the device (modem) name, e.g. SW8795V#1

MDN - the MDN from CDMA hardware

MSID - the MSID from CDMA hardware

ESN - the ESN from CDMA hardware

NID - the NID from CDMA hardware

SID - the SID from CDMA hardware

For example: to set a header value to "Device is" followed by the device name, you would use:

Device is {Hardware/DeviceName}

Using { values

To include the { character in the header value, use "{{}"

For example, to set a setting value to {Test}, you would use:

{{}Test}

Notice that the } character can be output by typing } on its own.

Example client headers

Verizon requires three Operator settings which could be set by using this Advanced script:

Dim MDN

MDN = {Hardware}.MDN

Set OpSettings = {Connection}.Operator.GetOperatorSettings("internet")

ArgoScript.SetClientHeader "x-vzw-mdn", MDN

OpSettings("PROXY-AUTHNAME") = MDN & "@vzw3g.com"

OpSettings("PROXY-AUTHSECRET") = "vzw"

However, this can be achieved more easily by adding these three settings to the Operator's Internet settings:



ClientHeader_x-vzw-mdn » {Hardware/MDN}

PROXY-AUTHNAME » {Hardware/MDN}@vzw3g.com

PROXY-AUTHSECRET » vzw



Device resource Purpose: Defines a single mobile device (e.g. phone) simulation to use in this Script. (To use more than one, use the

Devices resource.)

When you add a Device resource to the Script, the Device Wizard runs to help you select a device from your

currently defined data source(s). For details, see The Device Wizard, below and Data Sources in the Story Boarder User

Guide.

Hint: You can also select the device at runtime, by using a parameter. See Selecting the device at runtime, below.

Properties:

Device

Browser - select the Browser resource to use, or leave set to Nothing to use the default ArgoBrowser.

Default: (Nothing)

CookieSupport - select the version of cookies to support, from: Default, Disabled, Version0 and Version1.

(See Cookie support, below.) Default: Default

EnableDeviceCache - select True to enable the device cache. Default: True

EnableHttpConfig - select True to allow the HTTP Client to be configured (with HttpClient). Default: True

Note: If upgrading a Monitor Master 7.4 (or earlier) test script, the default is False.

HttpClient - select the HTTP Client resource to use to configure the HTTP Client. Default: (Nothing)

VideoPlayer - select the name of the VideoPlayer resource to configure video playback. Default: (Nothing)

These are the properties you can edit; the others are defined in the device's entry in the Monitor Master device

database and cannot be edited.

Click the Invoke Wizard link to run the Device resource Wizard again, to select a different device; click the

Configure Sources link to run the Data Source Wizard.

Cookie support

The CookieSupport setting is interpreted as follows:

Default - use the support level defined in the device profile. (Current device profiles default to version 1.)

Disabled - turn off client-side cookie support.

Version0 - force compliance with the original Cookie proposal (from Netscape)

Version1 - force compliance with RFC2109 HTTP State Management Mechanism

The Device Wizard

The Device Wizard runs when you add a Device resource to your script. (If you add a Connection, the Connection

Wizard runs a simplified Device Wizard - click the Advanced button to see the full wizard.)



It is divided into four panes:

Selection (top) controls to sort, group, search and filter the list

Device Tree (left) displays a hierarchy of all devices available

Device List (right) a list of all devices in the selected branch

Details (bottom) properties of the selected device

Devices are initially listed in alphabetical order of device name, within manufacturer, within data source. One

simple way to choose a device is:

Scroll through the device names in the Device List, on the right, to locate the device

Click the device checkbox to check (tick) it

You can check its image and other properties in the Details pane, below

Click the Finish button

To navigate the Device List more quickly use the Device Tree pane:

Click a button in the Device Tree pane to open any branch (list its contents); click a button to collapse

a branch.

Click a branch to select it and list its contents in the Device List pane. For example, if the list is grouped by

manufacturers, click a manufacturer's name to list all their devices in the Device List; to see all

manufacturers from a particular data source, click that data source's button

To change the device sorting and grouping order:

Select the order from the Sorting/Grouping list in the Selection pane.:

Group by Source/Manufacturer - list devices in alphabetical order of device name within manufacturer

within data source

Group by Browser - list all devices in alphabetical order of browser name

Group by Hardware - list all devices in alphabetical order of hardware name

Group by Source - list devices in alphabetical order of device name within data source

All items - list all devices in alphabetical order of device name



Selected items - list just the selected device

Note that the current sort/group type is displayed at the top of the Device Tree.

To search for a device by name:

Type the text to match in the Search for box, in the Selection pane. For example, type nokia to list all

devices from Nokia.

Click the button

This will list all matching devices in the Device List

To filter the device list by device features, use the checkboxes in the Selection pane:

Check MMS to only list devices that can send and receive MMS

Check Video to only list devices that can play video

Check WAP1 to only list devices that support WAP1

Check WAP2 to only list devices that support WAP2

Check Include Legacy to include all Legacy Profiles. When you check any of the feature checkboxes, all

Legacy Profiles will be hidden - use the Include Legacy checkbox to show them

Selecting the device at runtime

To select (or override) the Device at runtime:

Add a parameter to the Start scene:

Set Default to the name of the default device to use, or leave it blank to use the device specified by

the Device resource

Set Name to a suitable name such as DeviceId

Set Scene to the name of the Device/Devices resource to override

Set SceneParameter to DeviceIdentifier

Set Source to TestParameter

Save the changes

When you run the script, type the Device Identifier (see next heading) of the Device to use as the value of

the DeviceID parameter

Device Identifier

A Device Identifier uniquely identifies a Device (profile) in an installation. It consists of three parts separated by

ampersands (&):

the device authority - http://dm.argogroup.com/profiles for device profiles from InfoVista Sweden AB

the full device name, such as Nokia.N73.EMEA

the device DMId, a number such as 3195

Producing: http://dm.argogroup.com/profiles&Nokia.N73.EMEA&3195

You can find all three parts by using the Device Wizard:

http://dm.argogroup.com/profiles





Devices resource Purpose: Defines one or more mobile device (e.g. phone) simulations to use in the Script. (To use a single device,

you can use the Device resource.)

Properties:

Browser

Browser - select the Browser resource to use, or leave set to Nothing to use the default ArgoBrowser.

Default: (Nothing)

CookieSupport - select the version of cookies to support, from: Default, Disabled, Version0 and Version1.

(See Cookie support, below.) Default: Default

EnableDeviceCache - select True to enable the device cache. Default: True

EnableHttpConfig - select True to allow the HTTP Client to be configured (with HttpClient). Default: True

Note: If upgrading a Monitor Master 7.4 (or earlier) test script, the default is False.

HttpClient - select the HTTP Client resource to use to configure the HTTP Client. Default: (Nothing)

RunInSerial - select True to run the Script for each device in turn; select False to run it for all devices at the

same time (in parallel). Default: False

VideoPlayer - select the name of the VideoPlayer resource to configure video playback. Default: (Nothing)

Data

Devices - the list of devices to be used by the Script. Click the button to edit the list of devices in the List

of Devices dialog

When you add a Devices resource to the Script, the Device Wizard runs automatically, prompting you to select

devices from the Monitor Master device database by ticking their checkboxes. See The Device Wizard for details.

You can click the Invoke Wizard link at any time to use the Device Wizard to redefine the list.

Cookie support

The CookieSupport setting is interpreted as follows:

Default - use the support level defined in the device profile. (Current device profiles all default to version

1.)

Disabled - disable client-side cookie support.

Version0 - force compliance with the original Cookie proposal (from Netscape)

Version1 - force compliance with RFC2109 HTTP State Management Mechanism



User resource Purpose: Defines a User (account) for use by this Script. Different properties are used by different scenes - you may

not need to set them all

Properties:

Data

CentralManaged - whether this resource is centrally managed (by Quality Manager): True or False. Default:

True

Email

Email - this user's email address. Default: blank

Email-General

KeepEmailOpen - select whether to keep the email connections (POP3, IMAP, SMTP) open between scenes.

Default: False

EmailIMAP

IMAPAuthenticationMode - select the authentication mode to use with an IMAP server, when secure

email is selected: PlainText, Cram-MD5, NTLM, SASLPlain, or SASLDigest-MD5. (Secure email is selected

by using the Make email secure scene.) Default: PlainText

IMAPPassword - password for this user's IMAP account. Default: blank

IMAPPort - type the IMAP port number to use, usually 993 for SSL, 143 for non-SSL. Default: 143

IMAPServer - the address of the IMAP server to use. Default: blank

IMAPSSLMode - select the IMAP SSL Mode to use: None, Automatic, Implicit or Explicit. Default: None

IMAPSSLOptions - click the field's button to check or change the IMAP SSL Options:

IMAPUsername - this user's IMAP username. Default: blank

EmailPOP3

POP3AuthenticationMode - select the authentication mode to use with an POP3 server, when secure email

is selected: PlainText, Cram-MD5, NTLM, APOP, SASLPlain, or SASLDigest-MD5. (Secure email is selected

by using the Make email secure scene.) Default: PlainText

POP3Password - password for this user's POP3 account. Default: blank

POP3Port - type the POP3 port number to use, usually 995 for SSL, 110 for non-SSL. Default: 110

POP3Server - address of this user's POP3 server (for reading mail). Default: blank



POP3SSLMode - select the POP3 SSL Mode to use: None, Automatic, Implicit or Explicit. Default: None

POP3SSLOptions - click the field's button to check or change the POP3 SSL Options:

POP3Username - this user's POP3 username. Default: blank

EmailSMTP

SMTPAuthenticationMode - select the authentication mode to use with an SMTP server, when secure

email is selected: PlainText, Cram-MD5 or NTLM. (Secure email is selected by using the Make email secure

scene.) Default: PlainText

SMTPPassword - password for the SMTP account. Default: blank

SMTPPort - type the SMTP port number to use, usually 465 for SSL, 25 for non-SSL. Default: 25

SMTPServer - address of this user's SMTP server (for sending mail). Default: blank

SMTPSSLMode - select the SMTP SSL Mode to use: None, Automatic, Implicit or Explicit. Default: None

SMTPSSLOptions - click the field's button to check or change the SMTP SSL Options:

SMTPUsername - this user's SMTP username . Default: blank

MSISDN

Number - this user's telephone number. Default: blank

VoIP

SIPAddress - this user's SIP address (used by the VoIP scenes) e.g. sip:[email protected]. Default: blank

WVInstant Messaging

WVDomain - the domain for Instant Messaging, can usually be left to default. Default: blank

WVPassword - this user's password for Instant Messaging. Default: blank



WVScheme - the scheme used for Instant Messaging, can usually be left to default. Default: wv

WVServer - the server used for Instant Messaging, for example messenger.hotmail.com. Default: blank

WVUserId - the user id used for Instant Messaging, derived automatically from the WV username and

domain. Can usually be left to default. Default: blank

WVUsername - this user's username used for Instant Messaging, for example [email protected].

Default: blank

Email security - SSL Mode

If secure email is enabled (by using the Make email secure scene), connections to email servers will use SSL as

configured by the User's SSLMode setting for the connection type (POP3, SMTP or IMAP):

None - do not use SSL

Automatic - if connecting via a known SSL port, use SSL; if connecting via a known non-SSL port, establish

an SSL connection with STARTTLS or STLS

Implicit - assume the SSL part has already been established

Explicit - assume the SSL part has not been established and use STARTTLS or STLS to go into SSL mode

The SSL protocol is configured by the User's SSLOptions settings for the connection type:

AllowTLS - tick to enable the TLS protocol

AllowSSL3 - tick to enable the SSL3 protocol

AllowSSL2 - tick to enable the SSL2 protocol

AllowPCT1 - tick to enable the PCT1 protocol

IgnoreCertErrors - tick to ignore any errors in the certificate. This allows the use of self-signed certificates.

Email security - Authentication

If secure email is enabled (by using the Make email secure scene), connections to email servers will use the

authentication method configured by the User's AuthenticationMode setting for the connection type (POP3, SMTP

or IMAP).

Authentication occurs after SSL negotiation (if enabled). With SSL enabled, even if PlainText is selected as the

authentication mode, the username and password will be encrypted.



Connection resource Purpose: Defines a connection for use by this Script. If you are using multiple connections, you should use the

Multi Connection resource instead, to define each one.

Note: If an Agent has n modems, it can run n scripts at the same time (concurrently) to use those modems. Make

sure that:

Each script uses a different modem i.e. each script's Connection resource specifies a different COM port or

SmartModem on that Agent

Each script's Connection resource has a different name, as Monitor Master creates a Dial-Up Networking

Connection for each Connection resource, named after the resource

Properties:

Connection

AuthenticationMode - select the authentication mode to use: Default or CHAP. Leave Default selected

(makes Windows try various methods). Default: Default

Device - select the Device or Devices resource to use

GPRSCharacteristics - select whether to enable GPRS: select Always to enable it (as in previous versions of

Monitor Master); select IfDeviceSupportsIt to enable GPRS only if the device supports it; select Never to

disable GPRS. Default: IfDeviceSupportsIt

Hardware - select the Hardware resource (Modem / SmartModem / LAN / CDMA Hardware) to use

Operator - select the Operator resource to use

OverrideSettings - leave this blank to allow Monitor Master to select the appropriate service settings

automatically, or type the name of the service settings to use: internet, wap, wap1, wap2, sms, mms, ims, etc.

(Check the Operator resource for the names of the services it supports.) Default: blank

Note: If you are using a Legacy Device Profile, you MUST use this setting to choose the service to use.

Note: This setting is case-sensitive.

Timeout - type the timeout for this connection, in seconds. Default: 30

Note: This is the time to allow for each download/upload to complete. It is NOT an idle timeout.

PCAP

PCAPManager - to capture IP Trace packets automatically when this connection is used or extend the

packet filtering available, add a PCAP Manager resource to the script and select it here. Default: Nothing

Click the Invoke Wizard link to use the Connection Wizard to redefine the connection.



Multi Connection resource Purpose: Defines a data connection so a script can use 2 or more concurrently. Add a separate Multi Connection

resource to define each connection that you want to use. Once multiple connections have been opened by using the

Make Data Connection scene, data scenes can select which one to use by specifying the connection (Multi

Connection resource) name.

Support for multiple data connections is a new feature introduced in Monitor Master v10.4.0. See Using Multiple

Data Connections in the Story Boarder User Guide for a detailed explanation and example script.

This resource (and feature) is only supported by the MC7304 modem at present; this modem supports two

connections.

Use this resource instead of the Connection resource if you want to define and use two concurrent connections.

Properties:

Connection

ConnectionContext - select the Connection Context resource that mode to use: Default or CHAP. Leave

Default selected (makes Windows try various methods). Default: Default

ConnectionIndex - set to 1 for the primary connection, 2 for the secondary connection. Each Multi

Connection resource must have a different ConnectionIndex. Default: 1

Operator - select the Operator resource to use

OverrideSettings - leave this blank to allow Monitor Master to select the appropriate service settings

automatically, or type the name of the service settings to use: internet, wap, wap1, wap2, sms, mms, ims, etc.

(Check the Operator resource for the names of the services it supports.) Default: blank

Note: This setting is case-sensitive.

PCAP

PCAPManager - to capture IP Trace packets automatically when this connection is used or extend the

packet filtering available, add a PCAP Manager resource to the script and select it here. Default: Nothing

Using IP Trace

IP Trace (PCAP) using PCAP Start and PCAP Stop is supported for multiple data connections, but requires

additional steps. See Using Multiple Data Connections in the Story Boarder User Guide for a detailed explanation.



Connection Context resource Purpose: Used to support switching the data connection from one Multi Connection resource to another

Support for multiple data connections is a new feature introduced in Monitor Master v10.4.0. See Using Multiple

Data Connections in the Story Boarder User Guide for a detailed explanation and example script.

This resource (and feature) is only supported by the MC7304 modem at present; this modem supports two

connections.

Properties:

Device

Device - select the Device or Devices resource to use

Hardware

Hardware - select the Hardware resource (SmartModem) to use



HTTP Client resource Purpose: Define the properties of a Device's HTTP Client, by reading the device profile or specifying settings

manually.

Note: If the Device Profile does not provide a value, the values in the properties dialog will be used even if

IsUseDeviceProfile is set to True.

Properties:

IsKeepAliveSocket - select True to keep sockets alive and reuse them. Default: True

IsSeparateMarkupSocket - select True to use a separate socket for markup. Default: True

IsUseDeviceProfile - select True to use the Device Profile settings, or False to override them. Default: True

IsUseVersion1 - select True to use HTTP/1.0, select False to use HTTP/1.1. Default: True

SubFetchSocketCount - type the number of sockets available for subfetches. Default: 4

The HTTP stack used Monitor Master supports multiple sockets, allowing a more accurate emulation of many

devices. Using multiple sockets speeds up downloading of WAP, Web, and MMS content.

If the device profile contains the number of sockets used by the device, you can tell Monitor Master to read it by

setting IsUseDeviceProfile=True. If not, set IsUseDeviceProfile=False and set the number of sockets manually

with SubFetchSocketCount=n.



CDMA MMS Client resource Purpose: Defines the Client used by the CDMA Receive MMS DM scene.

Properties:

None.

Browser resources These resources are used to select the type of Browser to use in a test and to configure it:

Internet Explorer

ArgoBrowser

WebBrowser



Internet Explorer resource Purpose: Allows you to use the Internet Explorer Browser in your script and configure its behaviour

Your script will use the version of Internet Explorer installed on the Agent. Their behavior will be affected by how

Internet Explorer is installed and configured on the Agent, as well as by the properties of the Internet Explorer

resource.

Internet Explorer supports the IE scenes. See IE scenes for details.

Properties:

Browser

RecordEvents - select True to record messages when clicking links, visitng pages; select False to ignore

them. Default: True

Visible - select True to display Internet Explorer on the Agent while the Script executes; select False to hide

it. Default: False

Note: There are other steps you must take to make the window visible - see Visibility, below.

Content

EmptyPageIsError - select True to report a service error if an empty page is downloaded; select False to

report no error. Default: False

RecordContent - select True to record page contents while browsing; select False to discard them. Default:

False

Timeout

Timeout - type the maximum time (seconds) to wait for IE to handle a request and return to a "ready" state

after a request, before reporting a timeout error. Default: 30

TimeoutIsError - select True to report a service error if a timeout occurs; select False to report no error.

Default: False

Visibility

To display the Internet Explorer window on the Agent running the test (to view visited pages etc), you must also

change the properties of the Monitor Master Scripting Engine:

Logon to the Agent PC as a Windows administrator

Display the Windows Services applet (in the Control Panel's Administrative Tools window)

Double-click the Monitor Master Scripting Engine entry to display its properties dialog

Select the Log On tab and tick Allow service to interact with desktop:



Click Apply to store the change

Select the General tab and use its Stop and Start buttons to restart the service and bring the change into

effect



ArgoBrowser resource Purpose: Allows you use the (legacy) ArgoBrowser Browser in your script

The ArgoBrowser supports the WAP/Web scenes. See WAP/Web scenes for details.

Properties:

This resource has no properties



WebBrowser resource Purpose: Allows you to use the WebBrowser Browser in your script and configure its behaviour

The new WebBrowser supports most of the WAP/Web and IE scenes, as well as the new WebBrowser-specific

scenes. See:

WAP/Web scenes - details

IE scenes - details

WebBrowser scenes - details

Using the new WebBrowser, in Chapter 6 of the Story Boarder User Guide

Notes:

The new WebBrowser does not record timings for the download of individual pieces of content.

Any timings recorded using the new WebBrowser are indicative only and should not be used as

performance Metrics.

WebBrowser timings are not directly comparable with the timings recorded using the other Browsers.

Properties:

Browser

CookiesEnabled - select True to enable browser support for Cookies; select False to disable support.

Default: True

JavaScriptEnabled - select True to enable browser support for JavaScript; select False to disable support.

Default: True

RecordEvents - select True to record messages when clicking links, visiting pages; select False to ignore

them. Default: True

Visible - select True to display the new WebBrowser on the Agent while the Script executes; select False to

hide it. Default: False

Note: To make the window visible you must take some additional steps - see Visibility, below.

Content

RecordContent - select All to record all page content and sub-content including images, TopLevel to record

the page only, or None to discard all content. Default: All

RecordMetaContent - the list of meta content types to record: compressed, document, and spreadsheet.

Click the button to edit the list. Default: Screeenshot

System

Engineer - select an Engineer resource to use it for this scene. Optional

Timeout

Timeout - type the maximum time (seconds) to wait for the browser to download content while browsing,

before reporting a timeout error. Default: 30

Visibility

To display the WebBrowser window while the test runs (so you can view the pages as they visited to see how

they're rendered):

Ask your Monitor Master administrator to:

Logon to each Probe as a Windows administrator



Edit the Argo.Camaro.Service.exe.config file to change the application setting DesktopOption value from

"Private" to "Interactive":

<add key="DesktopOption" value ="Interactive"/>

In your script:

Set Visible=True in the WebBrowser resource properties

Save the script to the Probe

Login to the Probe and run the script in Local Mode - so the Web Browser window will be displayed on

your desktop

Advanced scripting

The WebBrowser does not support some of the ArgoScript functions used to access content. The WebBrowser

object does however provide access to a range of additional functions.

Both these topics are covered in the Advanced Scripting Guide.

Engineering functions

The WebBrowser Engineer resource can include definitions for these four engineering functions:

SavingContent( ) is called just before the resource saves the content it's fetched to the database. An example

is when "Visit Page" scene is used to fetch content from a web page.

SavedContent( ) is called after the Web Browser resource is finished saving the content it's fetched to the

database.

WaitingForPage( ) is called just before the resource starts waiting for a page to load. An example is when a

button is clicked on a web site.

WaitedForPage(success) is called just after the resource is finished waiting for a page to load. It takes a

parameter "success" that indicates whether the page loaded successfully.

For example, to provide simple diagnostic messages:

Sub SavingContent

ArgoReport.DebugLog "Starting to save content"

End Sub

Sub SavedContent

ArgoReport.DebugLog "Finished saving content"

End Sub

Sub WaitingForPage

ArgoReport.DebugLog "Waiting for page"

End Sub

Sub WaitedForPage(success)

ArgoReport.DebugLog "Page wait completed: " & success

End Sub

For general information on writing Engineering resources, see the Advanced Scripting Guide.

Audio resources These resources configure operation of the probe's audio capture and playback hardware:



Smart Voice Session (deprecated)

IAPI Voice Session

Voice Session

Audio Bridge



Smart VoiceSession resource Deprecated. This resource should not be used. Use the IAPI VoiceSession resource instead.

Note: This resource does not support the Agent RTU-5.



IAPI VoiceSession resource Purpose: Defines the interface to use for a voice call. An IAPI Voice Session supports audio playback and

recording, and text-to-speech output.

Optimal input and output volume levels are the key to successful voice testing - especially PESQ. These can be set

by using the Windows Audio Mixer, but Monitor Master provides better methods:

To change the default volume levels used for a probe, configure it by using Service Controller as described

in Chapter 15 of the Installing & Managing Monitor Master guide. See the following settings in the Terminal

Configuration Service section:

input-mixer-volume-levels

mute-input-mixers

output-mixer-volume-levels

mute-output-mixers

To set the levels for a test (over-ride the defaults) use the Record Volume and Playback Volume scenes in a

script.

Optimal volume settings for voice testing are described in the Story Boarder User Guide - see Using PESQ in

Chapter 6.

Properties:

Hardware - select the Hardware resource (SmartModem) to use for audio input/output



VoiceSession resource Purpose: Defines the devices to use for a voice call

Properties:

AudioIn - type the name of the Windows device to use for audio input (typically a sound card). Leave blank

to use the operating system default audio input. Default: blank

AudioOut - type the name of the Windows device to use for audio output (typically a sound card). Leave

blank to use the operating system default audio output. Default: blank



Audio Bridge resource Purpose: Configures the optional Audio Bridge facility, which connects the audio channels of two SmartModems

together so that audio input to Modem 1 is input to Modem 2 too, and audio input to Modem 2 is input to Modem

1. (This is similar to the remote diagnostic mode used by some operators to join in a customer's session.)

Note: To use this facility install the optional Virtual Audio Cable software on the probe.

Properties:

Modem

Modem A - select the SmartModem to bridge from. Default:

Modem B - select the SmartModem to bridge to. Default:

System

VACInstallDir - type the pathname of the folder where the Virtual Audio Cable is installed. Default:

C:\Program Files\Virtual Audio Cable

Note: The bridge is turned off initially. To turn it on or off, use the {AudioBridge}.StartBridge and

{AudioBridge}.EndBridge functions in an Advanced Script scene. The bridge is turned off automatically when the

script ends.

Video resources These resources are used for video streaming:

Video Player

Video Engineer

Video MOS Engine



VideoPlayer resource Purpose: Define parameters to configure video playback, for a specified device.

Properties:

ConnectionBandwidth - type the bandwidth (in bits per second) of the connection to the server, or set to 0

to use the default. (This corresponds to the Bandwidth argument in the RTSP DESCRIBE method.) Default: 0

InitialBandwidth - select the initial bandwidth (in bits per second) to request from the server, or set to 0 to

use the default. (This corresponds to the DeliveryBandwidth in the first RTSP SET_PARAMETER exchange.)

If you select a value greater than the ConnectionBandwidth, the default value will be used instead. You

should choose a value less than ConnectionBandwidth that the connection is likely to sustain. Default: 0

MaxDuration - type the maximum time (in seconds) to play video for. Default: 120

RequiresDefaultGateway - select True if the video player requires the default gateway (most do); see Using

the Default Gateway, below. Default: True

ShowWindow - select True to display the video player window on the Agent PC during playback, False to

hide it. Default: False

Note: To display the video player window, you must also run the Windows Service Control Manager on the

Agent and tick the Allow service to interaction with desktop checkbox for the Monitor Master Scripting

Engine service.

The VideoPlayer is enabled by setting the Device resource's VideoPlayer property to the name of the VideoPlayer

resource.

The bandwidth settings depend on the bearer, but here are some typical settings:

Bearer Connection Bandwith

GPRS 30720 (30 Kb/s)

EDGE 102400 (100 Kb/s)

UMTS 256000 (250 Kb/s)

HSDPA, 1.8 Mb/s network 1153434 (1.1 Mb/s)

HSDPA, 3.6 Mb/s network 2097152 (2.0 Mb/s)

See Video Streaming and Download in the Advanced Scripting Guide for more information on video streaming,

including more on choosing these parameters.

Using the Default Gateway

If you configure the VideoPlayer resource to require a Default Gateway, you must be careful how you use other

data connections in your script. To avoid problems, you must NOT:

Establish a normal data connection and then establish a connection to the video player device. Data that

was intended for the normal data connection may be sent over the new Default Gateway connection.

Establish a connection to the video player device and then establish a normal data connection. Data that

was intended for the video player device may be sent over the normal data connection.

Establish more than one connection using the default gateway. All data will be sent over one of these

connections, but you won't know which.



Your script CAN use other data connections before connecting to the video player device, or after closing the

connection to the video player device.



Video Engineer resource Purpose: A pre-defined Engineer resource that contains code to generate additional metrics and messages for

monitoring video downloads, using the CheckOutcome hook. The additional metrics include:

Startup_Buffering_Length - the time (seconds) spent buffering before playback commenced.

Total_Number_Rebuffering_Periods - the number of distinct periods of rebuffering.

Total_Rebuffering_Length - the total time (seconds) spent rebuffering (excludes startup buffering.)

Source_ClipBandwidth - declared bandwidth (in bits per second) of the stream

Properties:

The Script tab defines the engineering functions called automatically when the attached scene executes. You may

edit the function definitions if you wish, to add further processing.

To use the Video Engineer, select it as the Engineer for the Visit Page scene that starts the video download.

See Video Streaming and Download in the Advanced Scripting Guide for more information on video streaming,

including the metrics and messages reported.



VideoMOSEngine resource Purpose: Configure a Video Mean Opinion Score analysis engine, to use the Video MOS option.

Note: The Video MOS option is compatible with Real Video 8-10 media.

Properties:

DeviceUAProfOverride

DeviceUAPROF - type the URL of the emulated device's UAProfile, if using a legacy profile - leave blank if

using an NGP. Default: blank

Reporting

DetailedReporting - select True to report detailed VMOS, AMOS, Jerkiness, Bluriness and Blockiness

metrics. Default: False

System

GenistaExecFile - type the name of the program file used to execute the Video MOS engine time (in

seconds) to play video for. Default: GenistaPQoSConsole.exe

GenistaInstallDir - type the pathname of the folder where the program file is installed. Default: C:\Program

Files\Genista\GenistaPQoSSW

Trialling

DebugResultFile - type the pathname of a file to analyse instead of the video stream - for debugging

purposes. Default: blank

Content Resources These resources provide access to content from the network under test:

Content



Content resource Purpose: This is the content holder used by this Script. See the Advanced Scripting Guide for information on using it

from Advanced Script scenes.

Properties:

This resource has no properties.

PCAP resources Use these resources to access diagnostic detail from the (TCP/IP) network under test:

PCAP Engineer

PCAP Examiner

PCAP Manager

See PCAP scenes for more on IP Trace.

See also:

VoIP PCAP resource



PCAP Engineer resource Purpose: A pre-defined Engineer resource that contains code to capture packets from the scene it is attached to.

The packets are then accessible as content, e.g. in the Results Window.

Note: This resource is only supported by IP Trace for Type 1 Modems, on Legacy (10.2.0) probes.

See Using IP Trace in the Story Boarder User Guide for further information.

Properties:

The Script tab defines the engineering functions called automatically when the attached scene executes. You may

edit the function definitions if you wish, to add further processing.

This scene uses the ArgoScript RasPCAP function - for details, see RasPCAP in the Advanced Scripting Guide.



PCAP Examiner resource Purpose: Configure the network analyzer to use to visualize network captures.

You can use Ethereal or Wireshark as a visualizer. If both are installed, Monitor Master will use Wireshark.


Properties:

Executable

AdditionalParameters - additional parameters for Tethereal. Default: blank

TEtherealLocation - pathname of the Tethereal exe file, if installed. Default: C:\Program

Files\Ethereal\tethereal.exe

TSharkLocation - pathname of the Wireshark exe file, if installed. Default: C:\Program

Files\Wireshark\tshark.exe

Network

IPAddress - the IP address to listen to, or leave blank to listen to all addresses. Default: blank



PCAP Manager resource Purpose: Add to a Connection resource to automatically capture all IP Trace data as connections are made and

dropped using that resource.

You can use this instead of using the PCAP Start and PCAP Stop scenes to control capture explicitly in the script -

or use them as well.


Properties:

Capture

AutoCapture - set to True to automatically capture traffic on the associated connection(s), or False to disable

capture. This allows you to control capture at runtime, by setting this property from a runtime parameter. It

also allows you to control capture directly by using PCAP Start and PCAP Stop scenes in the script. Default:

True

PCAPFilename - select a Prop resource to store the name of the IP Trace file in it.

Promiscuous - select whether to use promiscuous mode on the network interface, True or False. Default:

False

ReadPCAP - select whether to read the IP Trace file into the content table when the connection is dropped,

True or False. Default: True

Filter

AutoFilter - select whether to automatically add filter rules depending on context (see AutoFilter, below).

Default: True

ConnectedFilter - type the capture filter (using WinPCAP rules) to use while connected. Default: blank

ConnectingFilter - type the capture filter to use while connecting or disconnecting. Default: blank

Warning: If you use multiple filters in the ConnectedFilter and ConnectingFilter filters, they can interfere

with each other, especially if you filter on IP addresses. We recommend that you only use a single filter of

each type.

Filter

ForcePCAPture - set to True to force the use of PCAPture; set to False to choose the default for the device.

Default: False

AutoFilter

If AutoFilter is enabled, additional filtering is performed based on the dial-up connection string and current

operation:

While connecting - only PPP packets are captured

While connected or disconnected - all PPP packets are captured, as well as all IP packets that originate from

or are destined for the dial up connection

This filtering is performed outside of WinPCAP, so filters do not interfere with each other if you have multiple

data connections established.

If the current IP address is unknown, then only PPP packets are captured (or, more accurately, Ethernet protocol

0x8021, 0xc021 and 0xc223 - these are seen during RAS connections)

If the IP address is known, then the following packet types are captured:



TCP packets whose source or destination IP address is equal to the filtered IP address

UDP packets whose source or destination IP address is equal to the filtered IP address

ICMP packets whose source or destination IP address is equal to the filtered IP address

IGMP packets whose source or destination IP address is equal to the filtered IP address

IP packets whose source or destination IP address is equal to the filtered IP address (packets which are not

TCP, UDP, ICMP or IGMP are decoded differently to allow for future filter capabilities)

The PPP protocol doesn't contain the filtered IP address, so all PPP packets are captured. This means that you will

see the PPP packets for other connections being captured.

Sequence of operation

The PCAP Manager is called at four key stages for a dial-up connection:

Pre-dial

Connected

Pre-disconnect

Disconnected

Pre-dial

This stage is just before the connection resource is used to make the data connection. the PCAP Manager starts IP

Trace and applies the ConnectingFilter (if present). If AutoFilter is enabled, then only the PPP packets are

captured.

Connected

This stage is just after the data connection has been established. The PCAP Manager switches to using the

ConnectedFilter. If AutoFilter is enabled, it captures all PPP packets and any IP packets that originate from or are

destined for the dial-up connection.

Pre-disconnect

This stage is just before the data connection is dropped. The PCAP Manager switches to using the

ConnectingFilter again. If AutoFilter is enabled, it captures all PPP packets and any IP packets that originate from

or are destined for the dial-up connection.

Disconnected

This stage happens is just after the data connection has been dropped. The PCAP Manager will stop IP Trace, store

the IP Trace filename in the PCAPFilename Prop (if chosen). If ReadPCAP is True, it will also read the IP Trace file

as a content record.

Ending capture

The Drop data connection scene must be called to drop the connection and end the capture correctly. If the

connection is not dropped correctly (e.g. because of a script error), then the IP Trace file will not be stored on the

Agent hard disk or in the content table.

Capturing from a LAN connection

You can also use PCAP Manager to capture packets from a LAN connection, but only if you use an explicit Make

data connection scene to establish the connection (as well as a Drop data connection scene to drop it). The PCAP

Manager is called at three key stages for a LAN connection:

Pre-dial

Connected



Disconnected

The Pre-disconnect stage is not used, and the Pre-dial stage is very short.

Power Control resources Use these resources to configure remote power control devices:

BetterBox Device Control - for control of an AC-powered modem

iBoot Device Control - for control of an AC-powered modem

APC Device Control - for control of an AC-powered modem

DevCon Device Control - for control of a USB-powered or PCMCIA modem

ActeSys Device Control - deprecated



External Hardware:BetterBox Device Control resource Purpose: Defines the configuration of a BetterBox device for the Verify Modem scene to use, to reset a non-

functioning AC-powered modem.

Properties:

BetterBox Connection

Armcode - type the single character code used to arm the BetterBox. Choose the character that the BetterBox

is configured to use. Default: !

ComPort - type the COM port that the BetterBox is connected to, on the PC. Default: COM1

DataRate - type the Baud rate that the BetterBox is configured to use. Default: 115200

Outlet - choose the power outlet that the modem is connected to, a number in the range 1 to 8. Default: 1

Device control

CycleSeconds - how long to switch the power off, in seconds. Choose a value to suit the modem. Default: 5

seconds

For information on installing and configuring a BetterBox device, see chapter 2 of Installing & Managing Monitor

Master.



External Hardware:iBoot Device Control resource Purpose: Defines the configuration of an iBoot device for the Verify Modem scene to use, to reset a non-

functioning AC-powered modem.

Properties:

Advanced


Password - type the password to enable access to this iBoot device. Default: blank

Data

Address - type the IP address of the iBoot device. Default: blank

For information on installing and configuring an iBoot device, see chapter 2 of Installing & Managing Monitor

Master.



External Hardware:APC Device Control resource Purpose: Defines the configuration of an APC device for the Verify Modem scene to use, to reset a non-functioning

AC-powered modem.

Properties:

APC connection

Address - type the IP address of the APC device. Default: blank

Password - type the password for this APC user. Default: blank

UserName - type the APC user name to use to control this device. This must be an outlet user. Default:

blank

Device control


Outlet - type the power outlet number that the modem is connected to. Default: 1

For information on installing and configuring an APC device, see Chapter 2 of Installing & Managing Monitor

Master.



External Hardware:DevCon Device Control resource Purpose: Defines how to configure the Devcon utility for the Verify Modem scene to use, to reset a non-

functioning USB-powered or PCMCIA modem.

Note that in testing we have found that the more reliable way to reset a PCMCIA modem is to reset the PCMCIA

interface, not the modem.

Properties:

Data

DeviceInstanceID - type the Device Instance ID of the modem or PCMCIA interface to reset (see below).

Default: blank

For more information on installing and configuring DevCon, see Chapter 2 of Installing & Managing Monitor Master.

Setting the Device Instance ID

To determine the DeviceInstanceID to use with the Devcon Device Control resource for a USB or PCMCIA

modem:

Login to Windows and display a command prompt on the Agent

Change directory to the Monitor Master Agent software directory. With default install options, this is:

C:\Program Files\Argogroup\UbiquinoX Monitor Master

To list modem IDs, type: devicecontrol listclass Modem

Listing 1 device(s) for setup class "Modem" (Modems).

PCI\VEN_8086&DEV_24C6&SUBSYS_542214F1&REV_01\3&61AAA01&0&FE : Conexant D480 MDC V.9x

Modem

To list PCMCIA interfaces, type: devicecontrol listclass PCMCIA

Listing 2 device(s) for setup class "PCMCIA" (PCMCIA adapters).

PCI\VEN_104C&DEV_AC47&SUBSYS_014E1028&REV_01\4&39A85202&0&08F0: Texas Instruments

PCI7510 CardBus Controller

PCI\VEN_104C&DEV_AC4A&SUBSYS_014E1028&REV_01\4&39A85202&0&09F0: Texas Instruments

CardBus Controller with SmartCard

Hint: To save typing, you can copy the ID to the clipboard by selecting it with the mouse and pressing Enter (if

Quick Edit is enabled in the command prompt properties).

If deploying the script to more than one Agent, the ID will be different on each one. Specify this property as a

runtime parameter in the script (see the Start scene for details) so you can supply the appropriate one for each

Agent via the QM Scheduler.



External Hardware:ActeSys Device Control resource Deprecated.

Advanced SIM Management resources Use these resources for direct control of SIM usage (in Local Mode):

ActeSys Remote SIM Server

SIM

SIM List

SIM Server



ActeSys Remote SIM Server resource Deprecated. Use the SIM Server resource instead.



SIM resource Purpose: Defines and loads a SIM from a SIM Server so it can be used directly.

Properties:

Descriptor - type the SIM Descriptor, used to locate the SIM. Default: blank

IMSI - type the SIM IMSI number, which uniquely identifies the SIM. Default: blank

MSISDN - type the SIM's MSISDN (voice) number. Default: blank



SIM List resource Purpose: Configures the list of SIMs for use with the Select SIM scene.

Note: Do NOT use this scene if the script will be run by QM; you will choose the SIM to use when you schedule the

testrun.

Properties:

SIMs - a list of SIMs. Click the button to edit the list directly, in the SIMs Collection dialog, or click the

Invoke Wizard link to redefine the list as described below.

Adding a SIM List

Add this resource and you will be prompted to select the SIM Server(s) to interrogate:

If the Script doesn't include any SIM Servers, you will be asked to configure one:

Type the SIM server's IP address and click Next. (This will add a SIM Server resource to the Script.)

If the Script includes any SIM Servers, a list will be displayed:

Tick the checkboxes for the ones to use, then click Next. Story Boarder will list the SIMs available on the

selected SIM Servers:



Tick the SIMs to make available, then click Finish to add the SIM List resource to the Script.



SIM Server resource Purpose: Defines a SIM Server so you can use its SIMs with the Select SIM scene.

Properties:

Address - type the IP address of the SIM Server. Default: blank

Port - type the port to use to connect to the SIM Server. The default is usually acceptable. Default: 18008

XML File resources Use these resources to configure the Site Configuration File:

XML file



XML File resource Purpose: Defines the name and location of a System Configuration File (used to configure FTP access to the

Projector, if it's set up with non-default settings). This resource is used by the Upload file to Projector scene.

Properties:

XML File

FileName - the pathname of the System Configuration File to use. Default:

D:\APS\ref\SiteConfig\SiteConfig.xml

If a Site Configuration File has been created and deployed by your system administrator (as described in Installing

& Managing Monitor Master), it should be accessible as D:\APS\ref\SiteConfig\SiteConfig.xml.

Hint: In a Monitor Master QM system, the contents of the QM Server D:\APS\Ref directory is automatically

distributed to Agents, so this is a good place to keep common information.

VoIP resources Use these resources to test VoIP (Voice over IP) connections:

VoIP Client

VoIP VoiceSession

VoIP PCAP

Note: These resources are only available if VoIP Support has been licensed and installed.



VoIP Client resource Purpose: Defines a VoIP User.

Properties:

Audio

AudioCodec - leave blank to allow the system to choose the best codec for the connection speed

(recommended), or type the name (or part of the name) of the codec to use. Default: blank

Internet Connection

Connection - leave blank to use the Windows default adaptor type (usually LAN) or select the Connection

resource to use (e.g. to connect OTA). Default: blank

NAT - select No if there is a direct connection to the SIP server; if SIP needs to traverse a NAT or firewall,

select the protocol to use: STUN or TURN. Default: No

RTPPortRangeMax - leave set to 0 for automatic, or type the highest RTP port number to use. Default: 0

RTPPortRangeMin - leave set to 0 for automatic, or type the lowest RTP port number to use. Default: 0

Outbound Proxy

Address - leave blank or type the address of a proxy server to use. Default: blank

Registration

Name - type the name to use to register on the presence server. Default: blank

Password - type the password to use to register on the presence server. Default: blank

Signalling Port

SIPPort - the port to use for SIP. Default: 5060

System

ClearVoipProcess - whether to clear any instance of the VoipEventHandler process, True or False.

Default: True

Engineer - select an Engineer resource to use it for this scene. Optional

User Agent

UserAgentName - type the name to use for presencing. Default: blank

UserAgentURI - type the URI of the User Agent, for example: sip:[email protected]. Default: blank



VoIP VoiceSession resource Purpose: Defines a Voice Session for a VoIP User.

Note: Do not use any other type of VoiceSession resource.

Properties:

Connection

Client - select the VoIP Client to use. Default: blank



VoIP PCAP resource Purpose: Trace the network traffic associated with a VoIP Client.

Note: Do not use the standard PCAP Manager resource with a VoIP Client.

Note: This resource is only supported by IP Trace for Type 1 Modems, on Legacy (10.2.0) probes.

Properties:

Connection

Client - select the VoIP Client to use.


Chapter 5 - Scripting scenes

Use the scenes in the Scripting Group for general-purpose scripting:

Script scene

Loop scene

Wait scene

Delete File scene

Synch Point scenes

Retrieve Values scenes

Set Values scenes

XML resource File scenes



Script scene

Changes in v10.4.0

The Intellisense script editor has been replaced to improve performance and provide a slightly different set of

functions and options, as described below.

Purpose: To execute VBScript, to implement custom functionality not provided by the supplied scenes.

Properties:

Script - type or edit the VBScript on this tab (see Writing code)

References - define any external references used by the VBScript on this tab (see References, below)

Routes:

OK - your module has exited with an OK code (indicating success)

Alternate OK - your module has exited with the Alternate OK code

System error - your module has exited with the System error code

Service error - your module has exited with the Service error code

General error - your module has exited with the General error code

Using the Script scene

Use the Script scene to add VBScript to your script, to implement custom functionality not provided by the

supplied scenes.

Note: You must use the Script resource to define any functions you want to use in the Script scene. You must NOT

include function definitions in Script scenes.

Writing code

Choosing the editor

The simple script editor

The Intellisense script editor

References

Writing code

To write (or edit) VBScript, click in the large box on the Script tab and start typing:



Hint: You can change the window size by dragging its edges.

Write the Script using the VBScript scripting language, ArgoScript functions, and the documented COM objects

from InfoVista Sweden AB.

For details of the VBScript scripting language, see any of the standard texts available - and see the notes in the

Advanced Scripting Guide.

For details of the ArgoScript functions, and general guidance on writing Script modules, including the other COM

objects and methods you can use, see the Advanced Scripting Guide.

Note: If you want to define functions or subroutines, you must do so in a Script resource, not in a Script scene.

Choosing the editor to use

You can use two different editors in the Script window:

The Simple Text Editor - a very simple editor

The Intellisense Editor - an advanced editor with additional features and commands

Most users will prefer the Intellisense editor for its additional features. The simple text editor is provided for users

who need maximum performance when editing large scripts.

To change editors:

Select Options from the Story Boarder Tools menu

Select the Misc tab

Click the Intellisense script editor checkbox

Click OK to save your choice

Note: The choice you make affects every Script window, including the Script scene and resource, the Engineer

resources, and the View Script window. See Customization Options in the Story Boarder User Guide for more

configuration options.



The simple script editor

This editor allows you to type, cut, copy and paste by using the usual Clipboard keys (e.g. press Ctrl+C to copy the

selected text to the Clipboard; press Ctrl+V to paste the Clipboard contents).

Right-click to display a popup menu with these options:

Undo - undo the most recent edit

Cut - delete the selected text and put it on the Clipboard

Copy - copy the selected text to the Clipboard

Paste - insert the text from the Clipboard

Delete - delete the selected text

Select All - select all text

Right to left Reading order - not supported

Show Unicode control characters - not supported

Insert Unicode control character - not supported

Open IME - not supported

Reconversion - not supported

The Intellisense script editor

With the Intellisense editor selected, a wide range of additional facilities is available in the Script window.

Menus

Right-click to display a popup menu with these options:

Cut, Copy and Paste: use the clipboard to copy, move or delete text

Find and Replace: search and replace text, including options such as case matching and regular expressions

Go To: jump to a specific line number

Undo and Redo: undo or redo recent edits, one at a time

Advanced displays a second menu of advanced options, including case conversion, commenting and

sorting:



Properties provides configuration options for the editor - see Editor options, below

Automatic coloring, capitalization and indents

Once you've added some code to the Script scene, you will notice that the script editor formats what you've written

to help make the structure clear, like this:

Syntax highlighting gives each element of the language a different color:

blue for VBScript keywords and operators such as Sub and Dim

green for comments such as 'store the value

red for operators such as & and =



purple for strings such as "_"

black for everything else

Autocompletion and tooltips

You'll also discover that the editor supports autocompletion for ArgoScript functions and the main internal objects

(see the Advanced Scripting Guide) to save you some typing - and typing errors. For example, when you begin to

type the name of an ArgoScript function, as soon as you type "Argoscript." a list of matching function names will

drop down, like this:

You can select the function name from the list now (e.g. by using the cursor up/down keys or clicking it) or

keep typing until it scrolls into view:

Press Enter to insert the selected function.



Select a function name (by clicking it or using the cursor up/down keys) to display a Tooltip that explains

what it does, before inserting it:

Once you've inserted the function name, type the opening parenthesis and a Tooltip will list each of the

function's parameters:

Editor options

You can adjust many aspects of the Intellisense editor by changing its properties. These options are exactly as

described for the Script Window (in the Story Boarder User Guide). For example, to turn off line numbering:

Right-click in the Script tab and select Properties from the popup menu



Select the Misc tab

Select <none> from the Style dropdown in the Line numbering group

Click OK to make the change.

References

You can use this tab to document other objects that the scene uses. This is not a requirement but future versions of

the product may use this information to help automate script deployment.

Select the References tab from the Script scene properties dialog:




Library Function - to add a Library function

COM Object - to add a COM Object references

URI - to add a file reference



Loop scene Purpose: Repeat part of the Script n times

Properties:

Count - type the number of additional times to repeat the scenes in the loop. Default: 0

Routes:

Looping - the loop has been repeated less than n times (so execute it again)

Finished - the loop has been executed n times

There are two subtly different ways to use the Loop scene, use whichever you prefer, but be consistent to avoid

mistakes! You can:

Use the Loop scene at the start of the loop

Use the Loop scene at the end of the loop

Using Loop at the loop start

Place the Loop scene at the start of the sequence of scenes to repeat. Connect the Loop's Looping route to the first

scene in the repeat sequence. Connect the Loop's Finished route to the next scene to execute once the loop has

finished. Set the Loop's Count property to the number of times to execute the loop:

With this design and Loop's Count set to 2, the loop would be executed 2 times:

Start - scene1 - Loop - scene2 - scene3 - Loop - scene2 - scene3 - Loop - scene4 - End

Using Loop at the loop end

Place the Loop scene at the end of the sequence of scenes to repeat. Connect the Loop's Looping route to the first

scene in the repeat sequence. Connect the Loop's Finished route to the next scene to execute once the loop has

finished. Set the Loop's Count property to 1 less than the number of times to execute the loop:

With this design and Loop's Count set to 1, the loop would be executed 2 times:

Start - scene1 - scene2 - scene3 - Loop - scene2 - scene3 - Loop - scene4 - End



Wait scene Purpose: Wait for a period of time, typically to simulate user activity, or to give slow processes time to complete

Properties:

Data

Seconds - type the time to wait, in seconds. Default: 30

System

Engineer - select an Engineer resource to use it for this scene. Optional.

Routes:

OK - the specified time has elapsed

Note: There are no failure routes for this scene.



Delete File scene Purpose: Delete the specified file or files from the Agent's filing system

Hint: Typically used to delete temporary files such as created by the voice recording scenes.

Properties:

Data

Filename - the full pathname of the file to delete, e.g. D:\temp\test.tmp. Default: blank

Filenames - select a Props resource containing the full pathname of each file to delete. Default: blank

Note: If you specify a file with Filename and a set of files with Filenames, then all the specified files will be

deleted. If you don't set either property, this scene has no effect

System


Routes:

OK - the specified file or files have been deleted - or no files were specified

File did not exist - the specified file does not exist, so cannot be deleted

Failed to delete file (system) - the specified file exists, but cannot be deleted. For example, it might be write-

protected or in use

Synch Point scenes Use the scenes in the Scripting/Synch Point Group to synchronise parties in a multi-party script:

Synch Point

Verifying Synch Point

Neutral Synch Point



Synch Point scene Purpose: Define a synchronisation point, to synchronise elements of a branched or multi-party script and

optionally share data between them.

When this scene is executed in a multi-party script, this party will wait for n parties to execute Synch Points with

the same name (where n is the Count setting). This provides a simple method to help ensure that the parallel parts

of a multi-party script execute in synchronisation. For example, if party1 sends an SMS and party2 receives it, you

might add a Synch Point to each (with Count set to 2) to make sure that party1 has finished sending the SMS

before party2 tries to receive it.

For information on sharing data See Sharing data with Synch Points, below.

Note: The Synch Points synchronise by name i.e. all Synch Points that are meant to synchronise with each other

must have the same name. If you have more than one set of Synch Points (because you need to synchronise the

parties at more than one point), then all the Synch Points in each set must have the same name, which must be

different to the Synch Points in the other sets.

If this scene times out, it will report a system error and take the Timeout route (see below); if you'd rather that a

system error was not reported, use the Neutral Synch Point instead.

Properties:

Data

Parameter - select the Prop containing the value to pass to the other parties or type the value itself. Optional.

Default: blank

Results - select the PropStore to use to write and read the shared data. Optional. Default: (Nothing)

Synch

Count - type the number of parties to synchronise. For example, to synch with one other party, set Count to

2. Default: 0

Timeout - type the number of seconds to wait to synchronise. 0 means don't wait. Default: 0

System


Routes:

OK - the specified number of parties have synchronised within the time limit

Timeout - the specified number of parties have not synchronised within the time limit

System - synchronisation has failed due to a system error

Sharing data with Synch Points

Each of the parties using a Synch Point can use it to share data with the other parties using the Synch Point with

the same name, as follows:

To send data to other parties, a party must set the Synch Point Parameter setting to the value to send or the name

of the Prop containing the value.

To read data from other parties, a party must set the Synch Point Results setting to the name of a PropStore. A

subsequent Advanced Script scene within this party can then access the shared data by using the PropStore name

and source party's name, like this:

{propstore-name}("party-name")

For example, if the PropStore is called SharedData, to access the data sent by the party called main, you'd use:



{SharedData}("main")

(A PropStore is a dictionary object. See the Advanced Scripting Guide for more on using dictionary objects.)



Verifying Synch Point scene Purpose: Just like the Synch Point scene, this is a synchronisation point, to synchronise elements of a branched or

multi-party script. However, it also checks the value returned by each other party (via its Parameter setting) for

"OK" and branches accordingly: if any party reports a status other than "OK", this scene will exit with a timeout

error and include the party name in the diagnostic message.

Note: For this scene to work correctly, you must set the Parameter and Results; for a standard Synch Point, these

settings are optional.

Properties:

Data

Parameter - select the Prop containing a status value to pass to the other parties or type the value to pass.

This value should either be "OK" or an ArgoScript list whose first item is "OK" to indicate this party is

working correctly - any other value will indicate a problem. Default: blank

Results - select the PropStore to use to write and read the shared data. Default: (Nothing)

Synch


2. Default: 0


System


Routes:

OK - the specified number of parties have synchronised within the time limit, and returned a status of "OK"

Timeout - the specified number of parties have not synchronised within the time limit, or one or more has

returned a status value other than "OK"




Neutral Synch Point scene Purpose: Define a synchronisation point, to synchronise elements of a branched or multi-party script and

optionally share data between them.

This scene is very similar to the Synch Point scene - the only difference is that it does not produce a system error if

synchronisation times out. - it just follows the Timeout route (see below).

When this scene is executed in a multi-party script, this party will wait for n parties to execute Synch Points with

the same name (where n is the Count setting). This provides a simple method to help ensure that the parallel parts

of a multi-party script execute in synchronisation. For example, if party1 sends an SMS and party2 receives it, you

might add a Synch Point to each (with Count set to 2) to make sure that party1 has finished sending the SMS

before party2 tries to receive it.

For information on sharing data see Sharing data with Synch Points.

Note: The Synch Points synchronise by name i.e. all Synch Points that are meant to synchronise with each other

must have the same name. If you have more than one set of Synch Points (because you need to synchronise the

parties at more than one point), then all the Synch Points in each set must have the same name, which must be

different to the Synch Points in the other sets.

Properties:

Data

Parameter - select the Prop containing the value to pass to the other parties or type the value itself. Optional.

Default: blank

Results - select the PropStore to use to write and read the shared data. Optional. Default: (Nothing)

Synch


2. Default: 0


System


Routes:

OK - the specified number of parties have synchronised within the time limit

Timeout - the specified number of parties have not synchronised within the time limit


Retrieve Values scenes Use the scenes in the Scripting/Retrieve Values Group to access individual values stored in complex structures

such as the Props and PropStore resources:

Match Values

Get PropStore Value

Find Value in Props

Match PropStore Value

Get Props Value



Match Values scene Purpose: Branch execution of the Script depending on the value of a Prop resource - usually set by a previous

scene.

Hint: A Prop's value can be set by the output from certain scenes, allowing you to branch depending on runtime

results. See Using Props, in the Story Boarder User Guide.

Properties:

Input

Value - select the Prop resource to test

Match

Condition - select how to compare the Prop value with the reference value. Choose from:

equal to (default)

not equal to

greater than

greater than or equal to

less than

less than or equal to

contains

does not contain

contains any of

does not contain any of

starts with

does not start with

ends with

does not end with

is empty

is not empty

ReferenceValue - type the value to compare with Value:

For equal to, not equal to, greater than, greater than or equal to, less than or less than or equal to:

type a numeric value

For contains, does not contain, contains any of or does not contain any of: type a list of words

separated by commas

For starts with, does not start with, ends with or does not end with: type a word or string

For is empty or is not empty: type anything (it's not used, but still required)

System

Engineer - select an Engineer resource to use it for this scene; see page 24.

Routes:

Condition met - the value of the specified Prop matches the comparison and reference value

No conditions met - the value of the specified Prop does not match the comparison and reference value OR

the Prop, comparison, and reference value are not of compatible types

Note: The Prop value, comparison, and reference value must all be of the same type (e.g. all numeric or all string)

for a valid comparison. If they are not, the No conditions met route will be taken.

For information on creating a Prop resource, see Advanced resources. For information on assigning a scene's output

to a Prop, see Using Props, in the Story Boarder User Guide.



Get PropStore Value scene Purpose: Read a value from a PropStore and store it in a Prop

Properties:

Data

CopyIfNotPresent - select True to return the key as the value, if the key is not found in the PropStore; select

False to report a service failure. Default: False

Key - type the name of the value to read. Default: blank

Lowercase - select True to try a lowercase version of the key, if the supplied key does not exist in the

PropStore; select False to only use the key exactly as supplied. Default: False

Prop - select the Prop resource to store the value in

PropStore - select the PropStore to search for the key

System


Routes:

OK - the Prop has been set to the value of the specified key in the PropStore

Failed to set PropStore value (system) - the Prop has not been set, due to a system error



Find Value in Props scene Purpose: Check if a specific value is stored in a Props resource and branch accordingly

Properties:

Input

Props - select the Props resource to search

System


Value

Value - type the value to search for, or select a Prop containing it. Default: blank

Routes:

Found value - the value is present in the Props resource

Unable to find value - the value is not present in the Props resource



Match PropStore Value scene Purpose: Branch execution of the Script depending on the value (or existence) of a named element of a PropStore

resource.

Properties:

Input

Name - type the name of the PropStore element to check or select a Prop that the naem is stored in

PropStore - select the PropStore resource to test

Match

Condition - select how to compare the element value with the reference value. Choose from:

equal to (default)

not equal to

greater than

greater than or equal to

less than

less than or equal to

contains

does not contain

contains any of

does not contain any of

starts with

does not start with

ends with

does not end with

is empty

is not empty

exists

does not exist

ReferenceValue - type the value to compare with Value:

For equal to, not equal to, greater than, greater than or equal to, less than or less than or equal to:

type a numeric value

For contains, does not contain, contains any of or does not contain any of: type a list of words

separated by commas

For starts with, does not start with, ends with or does not end with: type a word or string

For is empty, is not empty, exists or does not exist: type anything (it's not used, but still required)

System

Engineer select an Engineer resource to use it for this scene. Optional.

Routes:

Condition met - the value of the specified PropStore element matches the comparison and reference value

No conditions met - the value of the specified PropStore element does not match the comparison and

reference value OR the element, comparison, and reference valued are not of compatible types

Note: The element value, comparison, and reference value must all be of the same type (e.g. all numeric or all

string) for a valid comparison. If they are not, the No conditions met route will be taken.



Get Props Value scene Purpose: Get a single value from a Props resource and store it in a Prop resource

A Props resource is an array, storing multiple values accessed by a numeric index starting at 0 i.e. the first value

has an index of 0, the second has an index of 1, and so on.

Properties:

Input

ElementIndex - type the index number of the element to return. Default: 0

Props - select the Props resource to return the value from

Output

Result - select the Prop resource to write the value to

System


Value

Routes:

OK - the value has been stored in the specified Prop resource

Failed, array element not found - the specified element is not present in the Props resource

Failed to get Props Value (system) - attempt has failed due to a system error

Set Values scenes Use the scenes in the Scripting/Set Values Group to write values to resources:

Set Prop Value

Set Props List

Set PropStore Items

Encode Base64 Data

Decode Base64 Data

Convert ArgoList to Props



Set Prop Value scene Purpose: Set the value of a Prop based on two values and an (optional) random number

Hint: Values don't have to be numeric, they can be any text - provided you don't use a numerical operation

Properties:

Data

Prop - select the Prop resource to store the value

Value - type the first value to use, or choose a Prop containing it. Default: blank

Value2 - type the second value to use, or choose a Prop containing it. This will be used as specified by the

Operation chose below. Default: blank

Operation

AppendRandom - choose whether to append a 5 digit random number to the value, True or False. Default:

False

Operation - choose how to set the Prop value:

Concatenate (default) - use Value followed by Value2, followed by a 5 digit random number (if

AppendRandom=True)

Concatenate with space - as Concatenate, but leave a space between each value

ArgoScript.BuildList - create an ArgoScript list from the two/three values and use it

Numerical add - add Value to Value2 and use the result. The random number is not used

Numerical subtract - subtract Value2 from Value and use the result. The random number is not used

Numerical multiply - multiply Value and Value2 and use the result. The random number is not used

Numerical divide - divide Value by Value2 and use the result. The random number is not used

ReferenceValue - type the value to compare with Value. For the first 6 conditions, this should be numeric;

for the next 3 conditions, this should be a list of words separated by commas; for the last four conditions,

this should be a word or string. Default: blank

System


Routes:

OK - the value of the specified Prop has been set

Failed to set prop value (system) - the value of the specified Prop has not been set, due to a system error



Set Props List scene Purpose: Set the value of Props elements to the supplied list of values

Hint: Values don't have to be numeric, they can be any text

Properties:

List

ValueList - type a string containing the values to insert into the Props list. For example, "a,b,c". You can

choose the value separator below (see SplitSequence). Default: blank

Props

ClearProps - choose True to clear the Props list before inserting the new values; choose False to keep the

existing values and add the new values after them. Default: False

Props - select the Props resource to store the values in

System


Values

AllowDuplicates - choose True to allow duplicate values in the Props list; choose False to remove any

duplicate values before inserting them. This also applies to existing values in the Props list. Default: True

LowerCase - choose True to force the new values to lower case; choose False to leave lowercase characatre

alone. This does not apply to existing values in the Props list. Default: False

SplitSequence - type the character or sequence of characters to interpret as a value separator in ValueList.

Default: ,

TrimValues - choose True to remove any whitespace from the start or end of values before inserting them.

This does not apply to existing values. Default: True

Routes:

OK - the values of the specified Props list have been set

Failed to set props list (system) - the values of the specified Props list have not been set, due to a system

error



Set PropStore Items scene Purpose: Set the value of PropStore elements using the supplied list of names and values

Hint: Values don't have to be numeric, they can be any text

Properties:

Items

ItemSplitSequence - type the character or sequence of characters to interpret as a separator between items,

in ValueList. Default: ,

NameValueSplitSequence - type the character or sequence of characters to interpret as a separator between

the item name and the item value, in ValueList. Default: =

List

ItemList - type a string containing the values to insert into the PropStore. For example, with the default

separators: "a=1,b=2,c=3". You can choose the item and value separators above (see the ItemSplitSequence

and nameValueSplitSequence). Default: blank

Names

LowerCaseNames - choose True to force the new names to lower case; choose False to leave lowercase

characters alone. This does not apply to existing names in the PropStore. Default: False

TrimNames - choose True to remove any whitespace from the start or end of names before inserting them.

This does not apply to existing names in the PropStore. Default: True

Props

ClearPropStore - choose True to clear the PropStore list before inserting the new values; choose False to

keep the existing values and add the new values. Default: False

PropStore - select the PropStore resource to store the values in

System


Values

DefaultValue - if a name/value separator is not found for an item, it is treated as a name, and added with

this default value. Default: True

For example:

if DefaultValue=True and ItemList="pcap=True,trace,upload=False", three items will be added to thet

PropStore:

pcap = True

trace = True

upload = False

LowerCaseValues - choose True to force the new values to lower case; choose False to leave lowercase

characters alone. This does not apply to existing values in the PropStore. Default: False

TrimValues - choose True to remove any whitespace from the start or end of values before inserting them.

This does not apply to existing values. Default: True

Routes:

OK - the values of the specified Props list have been set



Failed to set PropStore items (system) - the values of the specified PropStore have not been set, due to a

system error



Encode Base64 Data scene Purpose: Get data from a Prop resource, convert it to the equivalent Base 64, and write it to another Prop

Base64 is an encoding method used for MIME content that represents binary data using a 64-character alphabet,

typically for transmission over a system that does not support 8-bit data.

Properties:

Input

DataToEncode - select the Prop resource containing the data to encode

Output

EncodedData - select the Prop resource to write the encoded data to

System


Value

Routes:

OK - the data has been encoded and stored in the specified Prop resource

Failed to encode Base64 (system) - attempt has failed due to a system error



Decode Base64 Data scene Purpose: Get a Base64-encoded value from a Prop resource, decode it, and write it to another Prop

Base64 is an encoding method used for MIME content that represents binary data using a 64-character alphabet,

typically for transmission over a system that does not support 8-bit data.

Properties:

Input

DataToDecode - select the Prop resource containing the data to decode

Output

DecodedData - select the Prop resource to write the decoded data to

System


Value

Routes:

OK - the value has been decoded and stored in the specified Prop resource

Failed to decode Base64 (system) - attempt has failed due to a system error



Convert ArgoList to Props scene Purpose: Get an ArgoList from a Prop resource, extract the list members, and write each value to a separate

element of a Props resource

An ArgoList is a string containing multiple values separated by a list separator. ArgoLists are returned by many

ArgoScript functions - see the Advanced Scripting Guide for details.

Properties:

Input

ArgoScriptList - select the Prop resource containing the list to convert

Output

Result - select the Props resource to write the decoded values to

System


Value

Routes:

OK - the list has been decoded and stored in the specified Props resource

Failed to convert ArgoList (system) - attempt has failed due to a system error

XML Resource File scenes Use the scenes in the Scripting/XML resource File Group to read values from an XML resource file:

Set Prop from XML Resource

Set Prop from SiteConfig

Set Props from XML Resource

Set PropStore from XML Resource



Set Prop from XML resource scene Purpose: Set the value of a Prop resource from information in an XML file fetched by an XPath query. You need to

know how to construct XPath queries.

Hint: For more on using XPath queries, see Using the Site Configuration File in the Advanced Scripting Guide.

Properties:

Data

Prop - select the Prop resource to store the data in

Query

DefaultValue - type the value to use if the XPath did not evaluate. Default: blank

ErrorIfNotFound - select True to take the XPath did not return a value system error route if the XPath did

not evaluate; select False to take the OK (XPath not found) route. Default: False

ExpandTokens - select True to expand any tokens (see below) in the XPath. Default: False

XPath - type the XPath query to make. This must return a text value, not a node. If the query matches

multiple values, the first will be used Default: blank

Source

XMLFile - select the XML File resource that specifies the location of the XML file to query

System


Routes:

OK - the query has returned a value to the specified Prop

OK (no XPath match) - the query has not returned a value, and ErrorIfNotFound is set to False

Failed to set Prop from XML (system) - the query has failed due to a system error

XPath did not return a value - the query has not returned a value, and ErrorIfNotFound is set to True

Tokens

You can use these tokens in the XPath query:

{AGENT} - this expands to the name of the Agent running the script, as returned by the ComputerName

environment variable. (To display an Agent's name, login on it, open a command prompt, and type echo

%computername%)

{{} - this expands to "{", should you need it.



Set Prop from SiteConfig scene Purpose: Set a Prop resource to the value of an attribute from the SiteConfig XML file.

SiteConfig.xml is an optional configuration file that your administrator may set up to simplify the use of FTP

within your Monitor Master system. For a description of the file structure, see Installing an FTP Server, in the

Installing & Managing Monitor Master guide.

Properties:

Data


Query

AttributeName - type the name of the attribute to read. Default: blank

DefaultValue - type the value to use if the query does not return a value. Default: blank

SettingGroup - type the name of the settings group that includes the attriibute. Default: blank

Source

XMLFile - select the XML File resource that specifies the location of the SiteConfig file

System


Routes:

OK - the query has returned the attribute value to the specified Prop

Failed to set Prop from SiteConfig (system) - the query has failed due to a system error

Tokens




%computername%)




Set Props from XML resource scene Purpose: Set the values of a Props resource from information in an XML file fetched by an XPath query. You need

to know how to construct XPath queries.


Properties:

Data

Props - select the Props resource to store the data in

Query


not evaluate; select False to take the OK (XPath not found) route. Default: False


XPath - type the XPath query to make. This must return a text value, not a node. If the query matches

multiple values, the first will be used Default: blank

Source


System


Routes:

OK - the query has returned values to the specified Props resource

OK (no XPath match) - the query has not returned any values, and ErrorIfNotFound is set to False

Failed to set Props values from XML (system) - the query has failed due to a system error

XPath did not return any values - the query has not returned any values, and ErrorIfNotFound is set to

True

Tokens




%computername%)




Set PropStore from XML resource scene Purpose: Extract a list of named values from an XML file (by using three XPath queries) and write them to a

PropStore. You need to know how to construct XPath queries.

Hint: See the example below.

Properties:

Data

PropStore - select the PropStore resource to store the data in

Query


not return any values; select False to take the OK (XPath not found) route. Default: False


XPathName - type the XPath query to make on each node in the generated node list, to return a list of

names, one per node. Default: blank

XPathNode - type the XPath query to make to generate a node list. Default: blank

XPathValue - type the XPath query to make on each node in the generated node list, to return a list of

values, one per node. Default: blank

Source


System


Routes:

OK - the query has returned values to the specified Props resource

OK (no XPath match) - the query has not returned any values, and ErrorIfNotFound is set to False

Failed to set PropStore values from XML (system) - the query has failed due to a system error

XPath did not return any values - the query has not returned any values, and ErrorIfNotFound is set to

True

Example

Assuming the XML File contains this XML:

<a>

<b agent="agent1" server="qmserver1">

Agent 1, located in Elstead

</b>



</b>


Agent 3, located in Eningen

</b>


Agent 4, located in Solothurn

</b>

<b agent="agent5" server="qmserver3>

Agent 5, located in Atlanta

</b>

</a>



Set XPathNode to /a/b to match all the "b" nodes.

And set XPathName to ./@agent and set XPathValue to ./@server to return the agent names as the name list and the

server names as the value list, to set the PropStore to:

agent1 = qmserver1

agent2 = qmserver1

agent3 = qmserver2

agent4 = qmserver2

agent5 = qmserver3

Or set XPathName to ./@agent and XPathValue to ./text() to set the PropStore to:

agent1 = Agent 1, located in Elstead

agent2 = Agent 2, located in Elstead

agent3 = Agent 3, located in Eningen

agent4 = Agent 4, located in Solothurn

agent5 = Agent 5, located in Atlanta

Or set XPathName to ./@server and XPathValue to ./text() to set the PropStore to:

qmserver1 = Agent 2, located in Elstead

qmserver2 = Agent 3, located in Eningen

qmserver3 = Agent 5, located in Atlanta

Because the duplicate names are overwritten.

Tokens




%computername%)


mailto:./@server

mailto:./@server


Chapter 6 - Test scenes

Use the scenes in the Test Group to access data about the Test, at runtime:

Checks scenes - branch depending on values found

Properties scenes - access to properties at runtime

Parameters scenes - using parameters at runtime

Deprecated scenes - various flow control scenes which are only retained for backwards compatibility; you

should use multi-party scripts instead

Checks scenes Use these scenes to check whether the environment is suitable for the test, at runtime:

Check Device Capabilities

Check Environment

Check Props

Check User

Check Operator Service



Check Device Capabilities scene Purpose: To check details of the selected device (profile) and branch accordingly

Note: This scene checks a device profile (emulation), not actual hardware (modem)

Properties:

Device

DeviceSupport - a list of checks to perform on the Device, displayed as (StringBoolList). To see the list,

click (StringBoolList) to display the button, then click the button:

Tick the checks to perform:

Tick WAP1.x if this device must support WAP1.x

Tick WAP2.0 if this device must support WAP2.0

Click OK

System


Routes:

OK - all checks have been passed, the test should run

Device is incompatible with this test (system) - one or more of the checks has failed, the test should not be

run



Check Environment scene Purpose: To check the testing environment and branch accordingly

Properties:

Agent

AgentChecks - a list of checks to perform on the Agent, displayed as (StringBoolList). To see the list, click

(StringBoolList) to display the button, then click the button:

Tick PCAP must be enabled if this party needs the IP Trace option installed on the Agent

Tick PESQ must be enabled if this party needs the PESQ option installed on the Agent

Tick Speech must be enabled if this party needs a Speech-capable modem

Click OK

AgentVersion - type the lowest Monitor Master version number that this party can run on, such as 8.2 or

8.4, or type 0.0 for any version. Default: 8.4

Misc

UseModemErrorPath - select how to report a modem's failure to initialise: select True to report it as a

modem failure; select False to report it as an environment issue. Default: False

System


Terminal

SupportedTerminals - a list of Terminals (modems) that the test can run on, displayed as (StringBoolList).

To see the list, click (StringBoolList) to display the button, then click the button:



Tick the supported modems.

LAN will match modems with the LANManaged and LANUnmanaged modem types; Unmanaged

will match modems with the LANUnmanaged, UNMANAGED and DUMMY modem types.

Tick Any if the party will run on any modem, including the external (serial) modems used in Local

Mode

Tick Any SmartModem if the party will run on any SmartModem (internal modem in an Agent

appliance such as the X1100)

Tick Any TEMS Device if the party will run on any Type 2 Modem, such as the SW7700 or SW7710

LTE modem

Otherwise tick the specific modems that this party will run on

TerminalToCheck - select the hardware resource (SmartModem, LAN, Modem or CDMA Hardware) to

check

TraceRequired - select True if the terminal must support Trace. Default: False

Routes:


Environment is incompatible with this test (system) - one or more of the checks has failed, the test should

not be run

Note: For Monitor Master 8.5SP1 onwards, this scene initialises the terminal before performing the checks. This

means that the terminal powers up earlier than it did with previous versions.



Check Props scene Purpose: Check the value of up to 5 Prop resources and branch accordingly if any fail

Properties:

Prop 1

Error1 - type the text of the error to report if the Prop1 value is not equal to the Regex1 regular expression

Prop1 - select the Prop resource to check

Regex1 type the regular expression that the Prop1 value must match. For example [0-9]{1,3} will match

values of between 1 and 3 digits.

See http://www.boost.org/doc/libs/1_39_0/libs/regex/doc/html/index.html for details of the regular

expression syntax.

Prop2, Prop3, Prop4, Prop5

Errorn - as Prop1

Propn - as for Prop1

Regexn - as for Prop1

System


Routes:


Values do not fit requirements - one or more of the checks has failed, the test should not be run

http://www.boost.org/doc/libs/1_39_0/libs/regex/doc/html/index.html



Check User scene Purpose: Check whether specific properties of a User resource have been set and branch accordingly if not

Note: The User passes the check if all specified properties have a value; this scene does not validate the values in

any other way.

Properties:

Email

Email - select True to check this user's email address. Default: False

IMAP - select True to check the user's IMAP details. Default: False

POP3 - select True to check the user's POP3 details. Default: False

SMTP - select True to check the user's SMTP details. Default: False

Instant Messaging

WV - select True to check the user's WV details. Default: False

MSISDN

MSISDN - select True to check the user's MSISDN details. Default: False

System


User

UserToCheck - select the User resource to check

VoIP

SIP - select True to check the user's SIP details. Default: False

Routes:


User settings are incompatible with this test - one or more of the checks has failed, the test should not be

run



Check Operator Service scene Purpose: Check whether an Operator provides a specific service and branch accordingly if not

Hint: To check for multiple services, use multiple Check Operator Service scenes.

Note: This scene is mainly used in Local Mode (when the script is saved direct to and run on an Agent). If a script

is run in Central Mode (via the QM Scheduler), the Operator is chosen when scheduling the script (by chossing a

Subscriber/SIM) and the Operator resource is ignored.

Properties:

Operator

Operator - select the Operator resource to check

Parameter

ServiceName - type the service name to check for; you must type the complete name in the correct case, e.g.

wap1 not WAP1 or wap. Default: blank

System


Routes:

OK - the Operator supports the specified Service

Operator service could not be found - the Operator does not support the specified Service

Properties scenes Use these scenes to access properties of the test or party:

Get MSISDN for Party

Get Test Property



Get MSISDN for Party scene Purpose: To read the MSISDN number or other "addressing" information (such as the Email or SIP address) from

the SmartModem SIM used by another party in this script, at runtime. This is really useful!

Hint: This allows you to access the terminal assigned to another party, at runtime. Write the information to a Prop

if you simply want to manipulate it; write it to a User resource if you want to use it for calling or messaging them

Properties:

Data

DataType - select the information to read from the other party: Number, SIP, Email, WV IM or All. Default:

Number

Message - type the name of the message to use when reporting this MSISDN number, or leave blank.

Default: blank

Party - type the name of the party to read from, or leave blank to read from the party containing this scene.

Default: blank

Prop - select the Prop resource to write the number to (optional).

User - select the User resource to write the number to (optional).

System


Routes:

OK - success, the voice call has been set up

Failed to get SIM number (system) - could not get SIM number due to system failure

Example

Imagine you've written a two-party script, to call party2 from party1:

party1

party2

But what number does party1 call i.e. what should we set Recipient.Number to, in party1? You could manually

check the modem number and type that - but then this script would only work if you always assign the same

modem to party2, when you schedule it in Quality Manager.

A much better solution is to read the party2 modem's MSISDN at runtime. Add a Get MSISDN for party scene to

party1:



And configure it like this:

Message - leave blank

Party - type party2, the the name of the party to read from

Prop - leave blank

User - select the Recipient resource

Other properties can be left to default.

Now, when party1 runs, it reads the number assigned to party2 and stores it in the Recipient resource, so it calls

the right "phone". The script can now be run successfully by Quality Manager on any two modems - without any

edits.



Get Test Property scene Purpose: Get the value of a Test property and store it in a Prop

Hint: Test properties are stored in a data dictionary and accessed by using a hierarchy of keys. To use this scene,

you need to know how this works - see Appendix A and Appendix B in the Advanced Scripting Guide for details.

Properties:

Data


Parameter

PropertyName1 - type the first (top-level) key for the property to read. Default: operators

PropertyName2 - type the next key. Default: wap2

PropertyName3 - type the next key. Default: URL

PropertyName4 - type the next key. Default: blank

PropertyName5 - type the next key. Default: blank

Version - type the data dictionary version. Default: v1.0

System


Routes:

OK - specified Operator resource has been updated

Example

The default parameter values shown above will read the v1.0/operators/wap2/URL value from the Test properties

i.e. the default URL that will be used for WAP2 in the current party.

Parameters scenes Use these scenes to load information from parameters into specific resources:

Operator Load from Params

Device Load from Params



Operator Load from Params scene Purpose: Change an operator's parameters at run time

Properties:

Authentication

Password - the password to use with this operator

User - the username to use with this operator

Data

APN - the access point to use

Bearer - the data network bearer protocol. Default: GPRS

DialupNumber - the data network dialup number (if required)

MMSRelay - the URL of this operator's MMS-C

Port - the data service port to connect to

Proxy - the data service proxy address to connect to

Operator

Operator - select the Operator resource to update with the values above

System


Routes:

OK - specified Operator resource has been updated



Device Load from Params scene Purpose: Load new device settings into a device at run time

Properties:

Device

Device - select the Device resource to update

Id - type the id of the device profile to use, on this Agent

System


Routes:

OK - specified Device resource has been updated

Deprecated scenes These flow control scenes have been retained for backwards compatibility only, so that old scripts will continue to

work. You should use multi-party scripts instead.

Branch if Test Running

Configure Branch Test

Branch Test

Merge Test

Synchronise Test

Start Test



Branch if Test Running scene Purpose: Branch if this test is already running. This scene is typically used by a Script that runs itself again, to help

distinguish which instance is being executed.

DEPRECATED

Properties:

Output

TestIDArray - select a Props resource to store the ids of any other instances of this test that are running.

Optional. Default: (Nothing)

System


Routes:

Only Me - there are no other instances of this script running on this Agent

Many Instances - there are other instances of this script running on this Agent (for a list, check the

TestIDArray Props resource)

Failed to retrieve running instances - system error



Configure Branch Test scene Purpose: To control the initialisation of a Script that branches - used in conjunction with the Branch Test and

Merge Test scenes, to create a Branching Test.

DEPRECATED

For correct operation, this scene must be the first scene in the Script. Its Continue route should be connected to the

initialisation scenes for the Master script; its Jump to Branch route should be connected to the Branch Test scene.

See Creating a Branching Test, in the description of the Merge Test scene.

Properties:

Input

Branch Type - do not edit this property! Instead, add a Parameter to the Start scene to set this property.

Branch Type PropStore - do not edit this property! It selects the PropStore resource to use to store Branch

Type information

RemoteSlaveIp - type the IP address of the Agent to run the remote (slave) branch

System


Routes:

Continue - normal execution in master mode

Jump to Branch - normal execution in slave mode - must be connected to the Branch Test scene

Failed to Configure Branch Test (system) - failed due to a system error



Branch Test scene Purpose: To split execution of a Test into a Master Route and a Slave Route - used in conjunction with the

Configure Branch Test and Merge Test scenes, to create a Branching Test.

DEPRECATED

See Creating a Branching Test, in the description of the Merge Test scene.

Properties:

Input

Branch Type PropStore - do not edit this property! It selects the PropStore resource to use to store Branch

Type information

Timeout - type the time (in milliseconds) to wait for the slave to start. Default: 6000

System


Routes:

Master Route - route taken in Master mode

Slave Route - route taken in Slave mode

Failed to Branch Test (system) - failed due to a system error



Merge Test scene Purpose: To provide the Master thread with a way to update its data from the Slave thread. Used in conjunction

with the Configure Branch Test and Branch Test scene in a Branching Script.

DEPRECATED

Properties:

Input

Branch Type PropStore - selects the PropStore resource that stores Branch Type information (the Master

Sequence Number)

Timeout - the maximum time (in seconds) the Master Script should wait for the Slave Script to finish; 0

means no timeout, wait for the Slave Script to finish. Default: 0

System


Routes:

Master - normal execution (in Master thread)

Slave - normal execution (in Slave thread)

Service Failure in Slave - failed due to a service error in the Slave thread

System Failure in Slave - failed due to a system error in the Slave thread

Creating a Branching Test

When you run a Branching Test it starts as normal, but when it reaches the Configure Branch Test scene, it splits

into two threads: the Master Script and the Slave Script. runs itself again, in Slave mode. Different parts of the

design are executed in the two modes, with the Configure Branch Test and Branch Test scenes acting as the

switch points controlled by the value of the BranchType PropStore. Results from the Slave Script are combined

with the Master Script by using the Merge Test scene.

The design is thus:

In Master mode, the scenes in the top two thirds of the Script are executed; in Slave mode, the sequence of scenes in

the bottom two thirds of the Script are executed.

A Branching Test must have a runtime Parameter that sets the Configure Branch Test property BranchType and

when you run the Test, you must set its value to 'master'.

Warning:

The Branch Test scenes provide the logical framework of the test - it is up to you to implement the functions. For

example, to combine the results from the two testruns in the "merging data" path.

Limitations of a Branching Test

You cannot use any runtime parameters in a Branching Test (other than the mandatory parameter used to

set BranchType)



A Branching Test uses two threads (consumes two Actors)

The only way for the Slave thread to return information to the Master thread is via the User Data Table -

they cannot share data via Props, for example

Timeline View does not work correctly for a Branch Test



Synchronize Test scene Purpose: Wait for the other thread to synchronize with this thread (reach its Sync Point with the same name). You

need to add a Synchronize Test scene with the same Sync Point name to both threads of a Branched Test to

synchronize them.

DEPRECATED

Properties:

Input

Branch Type PropStore - do not edit this value! Selects the PropStore resource that stores Branch Type

information (the Master Sequence Number)

SyncPointName - type a name for this Sync Point. Default: blank

Timeout - the maximum time (in milliseconds) to wait for the threads to synchronise; 0 means no

timeout. Default: 10000 (10 seconds)

System


Routes:

OK - the other thread has synchronised

Timeout - the other thread has not synchronised within the specified timeout period

Failed to synchronize threads (system) - system error



Start Test scene Purpose: Start a named test on a named Agent.

DEPRECATED

Properties:

Configuration

Blocking - select True to wait for the other Script to terminate and return a result; select False to carry on

without waiting for the other script - and ignore its result. Default: True

ProjectorEnabled - select True to report the other script's results to the Projector. Default: True

Input

AgentIP - type the IP address or name of the Agent to run the script. Default: localhost (the current Agent)

Parameters - type a comma-separated list of test parameters to pass to the test. Default: blank

TestName - type the name of the test to run. Default: blank

System


Routes:

OK - the other test returned OK or Blocking=False

Service error - the other test returned a service error

System error - the other test returned a system error


Chapter 7 - Probe scenes

Use the scenes in the Probe Group to control an entire Probe (Agent appliance) from a script:

Agent Restart (hard)

Agent Restart (soft)

Use the Terminals scenes if you want to control individual modems from a script.

Administration scenes Use these scenes to restart the Monitor Master software on a Probe (Agent) or to reboot the Probe - typically used

for error-recovery:

Agent restart (hard)

Agent restart (soft)

Chapter 7 - Probe scenes


Agent restart (hard) scene Purpose: Restart an Agent's operating system

Properties:

System


Routes:

OK - Agent restart successful

Failed to agent restart (hard) - Agent restart failed due to a service error

Failed to agent restart (hard) (system) - Agent restart failed due to a system error



Agent Restart (soft) scene Purpose: Restart Agent i.e. stop, and then restart the Monitor Master system service

Properties:

Misc

RestartAction - select the state in which to leave the Agent, from: Stop, Recover, Inoperable, or Restart.

Default: Restart

System


Routes:

OK - Agent restart successful

Failed to agent restart (soft) - Agent restart failed due to a service error

Failed to agent restart (soft) (system) - Agent restart failed due to a system error


Chapter 8 - Terminals scenes

Use the scenes in the Terminals Group to check and control Terminals (Modems) and their SIMs from the script:

PowerUp Modem

Power Down Modem

Disable Modem

Recover Modem

Reset Modem

Verify Modem

Ensure Modem Ready

Get Modem Information

Get Additional Modem Information scene

Advanced SIM Management scenes - manual control of SIM multiplexing

Use the Probe scenes to control the Agent Appliance (Probe) from the script.



PowerUp Modem scene Purpose: To power up a SmartModem. (Equivalent to turning on a mobile phone.)

Note: This scene can only be used with SmartModems, it cannot be used with legacy modems.

A powered down SmartModem will normally power up automatically when you try to use it, so this scene is not

needed in most cases. Use it when you want to power up the SmartModem before trying to use it.

Properties:

Modem

SmartModem - select the Hardware resource (SmartModem) to power up

System


Routes:

OK - success, the modem has been powered up

Failed to powerup modem - could not power up modem due to service failure

Failed to powerup modem (system) - could not power up modem due to system failure



PowerDown Modem scene Purpose: To power down a SmartModem. (Equivalent to turning off a mobile phone. The SmartModem will

perform IMSI Detach to detach from the mobile network.)

Note: This scene can only be used with SmartModems

A powered down SmartModem will power up when a script attempts to use it, or you can use the PowerUp

Modem scene to power it up manually.

Properties:

Modem

IMSIDetach - set to True to ask the modem to perform an IMSI Detach before powering down. The

outcome of this request is ignored, so even if the modem reports an error, it should still power down.

Default: False

SmartModem - select the Hardware resource (SmartModem) to power down

StopTec - whether to stop the TEC (software that controls the SmartModem) after powering down the

SmartModem, True or False. Default: False

System


Routes:

OK - success, the modem has been powered down

Failed to powerdown modem - could not power down modem due to service failure

Failed to powerdown modem (system) - could not power down modem due to system failure



Disable Modem scene Purpose: To disable a SmartModem. (Equivalent to removing the battery from a mobile phone. The SmartModem

will not perform IMSI Detach to detach from the mobile network.)

Note: This scene can only be used with SmartModems

A disabled SmartModem can be re-enabled by using the Recover Modem scene.

Properties:

Modem

SmartModem - select the Hardware resource (terminal) that defines the SmartModem to disable

System


Routes:

OK - success, the modem has been disabled

Failed to disable modem - could not disable modem due to service failure

Failed to disable modem (system) - could not disable modem due to system failure



Recover Modem scene Purpose: To recover (enable) a SmartModem that was disabled with Disable Modem. This will also turn the

SmartModem on.

Note: This scene can only be used with SmartModems. It cannot be used to recover a SmartModem that has locked

up.

Properties:

Modem

SmartModem - select the Hardware resource (terminal) that defines the SmartModem to recover

System


Routes:

OK - success, the modem has been recovered and powered up

Failed to recover modem - could not recover modem due to service failure

Failed to recover modem (system) - could not recover modem due to system failure



Reset Modem scene Purpose: Reset modem

Note: When used with an ordinary modem, this sends it an AT command (the ResetCommand, see below), which

is unlikely to recover a modem that has locked up. When used with a SmartModem this powers it down and up

again (like using the PowerDown Modem and PowerUp Modem scenes in sequence), which will usually recover a

SmartModem that has locked up.

Properties:

Actor

Modem - select the SmartModem or Modem resource to reset

Data

InitialWaitSeconds - type the time to wait (in seconds) after issuing the reset command. Default: 20

PowerUpSeconds - type the time to wait (in seconds) for the modem/SmartModem after beginning the

reboot before continuing execution of the script. Default: 20

ResetCommand - type the AT command to use to reset a modem (ignored for a SmartModem). Default:

AT+CFUN=1,1. Consult your modem documentation for a suitable AT command for your modem

System


Routes:

OK - restart successful

Failed to reset modem - restart failed



Verify Modem scene Purpose: To check that a modem is functioning and optionally power-cycle a non-functioning modem to recover it.

This scene can be used with a SmartModem or ordinary modem, but to power-cycle an ordinary modem (to

recover it) it must be powered via a power controller.

Note: This scene has no effect (always returns OK) with Type 2 Modems, such as the SW7700 and SW7710

modems.

Properties:

Actor

Controller - select the Power Control resource to use

Modem - select the Modem or SmartModem resource to verify

Data

InitialATCommand - type the AT command to send to test the modem. Default: "AT"

InitialWaitSeconds - type the time (in seconds) to wait for a reply after sending the Initial AT command to

the modem. Default: 0

ModemTimeout - type the maximum time (seconds) to wait for the modem to respond to the status

check. Default: 30

PowerUpATCommand - type the AT command to send to test the modem after a power-cycle. Default:

"AT"

PowerUpSeconds - type the time (seconds) to wait after resetting the modem before checking its status

again. Default: 20

System


Routes:

OK - the modem is functioning OK

Fixed Modem - modem was not functioning, was reset, and is now functioning OK

Failed to fix Modem - modem was not functioning, was reset, but is still not functioning

Note that the second and third outcomes are both treated as errors i.e. will terminate the test unless connected to

further scenes. We recommend that the test proceed normally only if the OK route is taken, to avoid timing

problems.

For information on installing, configuring and using power switching devices, see Chapter 2 of Installing &

Managing Monitor Master.



Ensure Modem Ready scene Purpose: To check whether a specified SmartModem is ready for use.

Note: This scene can only be used with SmartModems.

Properties:

Actor

Modem - select the SmartModem resource to check

Data

ModemTimeout - type the maximum number of seconds to wait for the modem. Default: 240

State

GPRSAttached - whether to check if the modem is attached to the GPRS service. Default: True

NetworkRegistered - whether to check if the modem is registered on the network. Default: True

Note: Must be set to False for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs

PoweredOn - whether to check if the modem is powered on. Default: True

SMSReady - whether to check if the SIM is ready for use. Default: True

System

Engineer -select an Engineer resource to use it for this scene. Optional.

Routes:

OK - modem is ready

Failed to Ensure Modem Ready - modem did not become ready within the specified timeout

Sequence

The checks are performed in the following sequence:

PoweredOn

SMSReady

NetworkRegistered

GPRSAttached

Timeouts

If the modem is not (yet) in the specified state, the scene will wait for the state to change:

PoweredOn - 150 seconds (or powerup-report-delay + 30 seconds, if greater)

SMSReady - 240 seconds

NetworkRegistered - 120 seconds

GPRSAttached - 240 seconds

If the specified state is not achieved within the timeout, the scene will exit through the Failed to Ensure Modem

Ready route.



Get Modem Information scene Purpose: Query a Modem and return information about it. Support is limited to the modems described below.

Also see: Get Additional Modem Information scene.

For GSM Modems that respond to AT commands

ATI - the response is returned as a Modem Information message

AT+GMM - the response is returned as a Modem Type message (device model name)

AT+GMR - the response is returned as a Modem Revision message (firmware revision number)

AT+GMI - the response is returned as a Modem Identity message (device manufacturer)

For selected EMUs

For the Kyocera Torque E6710, Samsung Galaxy SIII GT-i9305 , LG Lucid2 VS870 and Samsung Galaxy S5 SM-

G900V EMUs, the following are returned:

a Modem Type message

a Modem Revision message

a Modem Identity message

Properties:

Actor

Hardware - select the SmartModem or Modem resource to check

System


Routes:

OK - modem is ready

Failed to get modem information (system) - modem did not respond (system error)



Get Additional Modem Information scene Purpose: Query a Modem (Legacy Modem, SmartModem or EMU) for additional information and return it as

Metrics or Messages.

For Type 2 Modems, this scene may return additional information: the NID (Network Id), SID (Subscriber Id) and

LAC/TAC (Location/Tracking Area Code). Reporting is not 100% reliable, but can be improved by powering up the

modem at the start of the script i.e. by starting the script with the modem powered down.

Changes for v10.3.0

Signal Strength: For releases before v10.3.0, this scene reported the Signal Strength (dBm) metric for some Type 2

modems using the wrong name, as Signal Strength (the name for the Signal Strength (RSSI) metric). This caused

confusion and required some users to implement workarounds in their scripts and reports.

For v10.3.0 onwards, the Signal Strength (dBm) metric is always reported with the correct name: Signal Strength

(dBm). If old scripts or reports include workarounds for the previous error, you will need to remove them when

upgrading to v10.3.0 or later.

Also see: Get Modem Information scene.

Changes for v10.4.0

For v10.4.0 onwards, an additional CID metric has been added for most Type 2 Modems:

Bearer up to v10.3.4 v10.4.0 onwards

CID metric CID metric CID (28Bits) metric

GPRS (2G) 16 bit CID 16 bit CID -

UMTS (3G) 28 bit CID - 28 bit CID

LTE (4G) 16 bit CID 16 bit CID 28 bit CID

The 16 bit CID is the unique ID of the Cell. The 28 bit CID (also called the LCID) is a concatenation of the RNC-ID

(12 bit ID of the Radio Network Controller) and the 16 bit Cell ID.

Notes:

1. The F3607 modem reports the same CID information as in previous releases.

2. The following older modems do not report the 16 bit CID for LTE: LG VL600; Motorola XT603; Sierra

Wireless 7700, 7710, and 7750

3. The XT603 always reports a CID of 0.

4. The Samsung SIII SPH-L710 reports the 28 bit CID for both CID and CID (28Bits) metrics.

5. The CID is not reported in some situations, such as when registration is denied.

For most modems

Properties:

Data

Bearer Technology - select True to report the Bearer as a message, or False to ignore it. Default: True

CID - select Metric to record the CID (Cell ID) as a Metric, Message to record the CID as a message, or

None to ignore it. Default: Message



IMEI - select Metric to record the IMEI (International Mobile Equipment Identity - device serial number) as

a Metric, Message to record it as a message, or None to ignore it. Default: Message

IMSI - select Metric to record the IMSI (International Mobile Subscriber Identity) as a Metric, Message to

record it as a message, or None to ignore it. Default: Message

LAC - select Metric to record the LAC (Location Area Code - location within a GSM PLMN) as a Metric,

Message to record it as a message, or None to ignore it. Default: Message

MCC - select Metric to record the MCC (Mobile Country Code) as a Metric, Message to record it as a

message, or None to ignore it. Default: Message

MNC - select Metric to record the MNC (Mobile Network Code) as a Metric, Message to record it as a

message, or None to ignore it. Default: Message

MSISDN - select Metric to record the MSISDN (Mobile Station ISDN - real telephone number) as a Metric,

Message to record it as a message, or None to ignore it. Default: Message

Party - select True to append the Party name to all messages and metrics reported by this scene. Default:

False

RSSI - set to True to record the RSSI (Receive Signal Strength Indicator) in the test results as a number (0 to

31). Default: True

RSSIdBm - set to True to record the RSSI in the test results as dB/m (-113 to -51dBm). Default: False

RSSIPercentage - set to True to record the RSSI in the test results as a percentage (0 to 100%). Default: False

Hardware

Hardware - select the SmartModem or Modem resource to check

System


Routes:

OK - modem is ready

Failed to get modem information (system) - modem did not respond (system error)

Advanced SIM Management scenes Use the scenes in the Terminals/Advanced SIM Management Group to manipulate SIMs directly:

Connect to remote SIM

Select SIM

Load SIM from resource



Connect to Remote SIM scene DEPRECATED. Use the Select SIM scene instead.



Select SIM scene Purpose: To select the SIM to use with a SmartModem.

Note: Do NOT use this scene if the script will be run by QM; you will choose the SIM to use when you schedule the

script with QM.

Properties:

Data

Name - type the name of the SIM to choose from the SIM List. Default: blank

SIMList - select the SIM List resource from which to choose a SIM

SmartModem - select the SmartModem resource to use this SIM

System


Routes:

OK - success, the SIM has been selected

Failed to select SIM - could not select SIM due to service failure

Failed to select SIM (system) - could not select SIM due to system failure



Load SIM From Resource scene Purpose: Add a SIM to the SIM List

Properties:

Recipient

Recipient - optional. Select a User resource to receive the SIM MSISDN

SIM

NameInList - type the name that the SIM should be identifed by within the SIMList

SIM - select the SIM resource to use

SIMList - select the SIMList to add the SIM to

System


Routes:

OK - specified SIM has been added to the SIMlist

Failed to load SIM - operation failed due to a system service error

Failed to load SIM (system) - operation failed due to a system error


Chapter 9 - Connections scenes

Use the scenes in the Connections Group to monitor and take direct control of a modem connection - rather than

allowing scenes to connect and disconnect as required. They can also be used to break the connect and disconnect

processes into separate Transactions, so you can monitor and control them more closely:

Packet scenes

Circuit scenes

Note: We have found that some data modems lock up if you attempt to make a new connection immediately after

disconnecting a previous connection. If you encounter this problem, use the Ensure Modem Ready scene to make

sure the modem is ready before re-connecting.

Packet scenes Use the scenes in the Connections/Packet Group to control packet data connections:

Make Data Connection

Drop Data Connection

GPRS Attach

GPRS Detach

GPRS PDP Activate

GPRS PDP Deactivate

Wait for PDP Context Deactivation

Get SIM Number

Verify Network Accessibility (ETSI)



Make Data Connection scene Purpose: Set up a data connection of the specified type.


Added support for IPv6 addresses for LAN connections


Added support for multiple data connections, via the Multi Connection resource


Added support for IPv6 addresses for specific Type 2 Modems

Using this scene

To specify the type of addresses to use for a connection, your system administrator sets the Operator's PDP_TYPE

to IPv4 or IPv6 or IPv4v6 as appropriate in the Operator Settings file. (Operator definitions are stored centrally by

QM and can only be edited by system administrators.)

A delay of 2 seconds is required after the Make data connection scene before any scene (such as DNS Lookup) uses

the connection. (Hint: Use a Wait scene.)

The PDP Context change may not occur immediately: the test may continue to use the previous PDP Context and

the next test with this connection will use the new PDP Context. We therefore advise against changing

PDP Context frequently.

Properties:

Actor

Connection - select the Connection resource or Multi Connection resource to connect to

Connection Type - type the name of the connection type to set up: csd, internet, mms1, mms2, wap1 or

wap2. Connection types are defined by the Operator Settings file. Default: internet

IP Address

IPAddress - select a Prop resource to store the (main) IP address assigned to this modem/LAN connection

by the network. (This can then be used by the Examine PCAP scene.) Default: blank

IPv4Addresses - select a Props resource to store the list of IPv4 addresses assigned to this

modem/LAN connection by the network. Default: blank

IPv6Addresses - select a Props resource to store the list of IPv6 addresses assigned to this modem/LAN

connectionby the network. Default: blank

The assigned address can also be read from the SmartModem resource's IPAddress property.

System


Routes:

OK - the new connection has been set up

Failed to make data connection - failed due to a service error

Failed to make data connection (system) - failed due to a system error



Failed, connection already open (system) - failed because the connection is already open. (You may want to

interpret this as OK)



Drop Data Connection scene Purpose: Shut down the current data connection, typically because it is no longer needed at the end of the Test or

because you want to set up another connection.

Properties:

Actor

Connection - select the Connection resource to disconnect

System


Routes:

OK - the connection has been shut down (or had already shut down)



GPRS Attach scene Purpose: To attach to a GPRS network. You only need to use this scene if you want separate timings for the GPRS

attach/detach process. A mobile GPRS device normally attaches to the network when it turns on, and stays

attached until it turns off.

If a pre-8.4 script includes this scene, the first time you load it into Story Boarder it will be updated to use the

current definition of all the scenes; the GPRS attach scene SetContext property will be set to No to preserve the

previous behavior.

Note: This scene has no effect on Type 2 Modems such as the SW7700 and SW7710 LTE modems.

Properties:

Actor

Connection - select the Connection resource to use

SetContext - select how to set the PDP context APN, if the GPRS PDP Activate scene is used. Default:

IfPossible

Choose Yes to use the APN from the Operator settings. If the APN is not present in the Operator

settings, this clears the context APN

Choose IfPossible to use the APN from the Operator settings, if the information is present. If the

APN is not present in the Operator settings, the APN context is not changed

Choose No to leave the PDP context APN unchanged

System


Routes:

OK - attached to the GPRS network

Failed to attach - attach has failed due to a service error

Failed to attach (system) - attach has failed due to a system error



GPRS Detach scene Purpose: To detach from a GPRS network. You only need to use this scene if you want separate timings for the

GPRS attach/detach process. A mobile GPRS device normally attaches to the network when it turns on, and stays

attached until it turns off.

Note: This scene has no effect on Type 2 Modems, such as the SW7700 and SW7710 LTE modems.

Properties:

Actor


System


Routes:

OK - detached to the GPRS service

Failed to attach - detach has failed due to a service error

Failed to attach (system) - detach has failed due to a system error



GPRS PDP Activate scene Purpose: To activate the Packet Data Protocol (PDP) Context on a GPRS network.

Properties:

Actor

APN - type the APN to use for the PDP context or leave blank to use the current APN. Default: blank


System


Routes:

OK - activated the PDP context

Failed to activate PDP Context - failed due to a service error

Failed to activate PDP Context (system) - failed due to a system error



GPRS PDP Deactivate scene Purpose: To deactivate the Packet Data Protocol (PDP) Context on a GPRS network.

Properties:

Actor


System


Routes:

OK - deactivated the PDP context

Failed to deactivate PDP Context - failed due to a service error

Failed to deactivate PDP Context (system) - failed due to a system error



Wait for PDP Context Deactivation scene Purpose: To wait for PDP Context Deactivation.

Properties:

Modem

Hardware - select the Hardware resource (terminal) to use

Timeout - type the time (seconds) to wait for PDP Context Deactivation (before timing out). Default: 300

System


Routes:

OK - success, PDP Context Deactivated

Failed to wait for PDP Context Deactivation - network did not reach the specified status within the timeout

period, due to service failure

Failed to wait for PDP Context Deactivation (system) - network did not reach the specified status within

the timeout period, due to system failure



Get SIM Number scene Purpose: To read the MSISDN number from the SmartModem SIM used by a party in this script.

Hint: This allows you to access the number of the terminal assigned to a party, at runtime. Write the number to a

Prop if you simply want to manipulate it; write the number to a User resource if you want to use it for a call or

message

Properties:

Data

Message - type the name of the message to use when reporting this MSISDN number, or leave blank.

Default: blank

Party - type the name of the party to read from, or leave blank to read from the party containing this scene.

Default: blank

Prop - select the Prop resource to write the number to (optional).

User - select the User resource to write the number to (optional).

System


Routes:


Failed to get SIM number (system) - could not get SIM number due to system failure



Verify Network Accessibility (ETSI) scene Purpose: To verify that the service network is accessible.

Properties:

Actor

Modem - select the Modem resource to use

Data

ModemTimeout - type the maximum time (seconds) to wait for the modem to respond. Default: 30

System


Routes:

OK - success

Service error - network is not accessible, due to a service error

System error - network is not accessible, due to a system error

Circuit scenes Use the scenes in the Connections/Circuit Group to control circuit-switched connections:

Make Voice Call

Drop Voice Call

Wait for Call

Maintain Voice Call

Answer Voice Call

Analyse PESQ

Test Circuit Switched Loopback

Test Circuit Switched Remote

Test Circuit Switched Echo



Make Voice Call scene Purpose: To set up a voice call.

Hint: On a CDMA network, use the CDMA Make Voice Call scene instead.


For Type 2 Modems the Call Setup Time metric will be calculated from the Setup Time if the Setup Service

Time Service Request is not available. This means that a Call Setup Time is now reported for VoLTE calls.


For Type 2 Modems, the way that the Call Setup Time metric is calculated has been changed so that

different makes of modem will report similar times. The values returned for the F3607 modem will be a little

higher than in previous releases

A new message was introduced called Call Domain to tell you how the call was handled. Its value can be:

Packet Switched (VoLTE)

Circuit Switched

Unknown

Properties:

Data

CreateContentRecord - choose True to record a content record for this action; choose False to create no

content record. Default: True

Hardware - select the Hardware resource (terminal) to use to make the call

ImmediateReturn - select True to return immediately after making the call; select False to return once the

call has been answered or the timeout has expired. Default: False

Timeout - type the maximum time (seconds) to wait for the call to be established (or answered). Default: 10

UseInternationalAccessCode - select False if the Recipient resource specifies a standard E.164 format

number (e.g. 001nnn... to dial the USA from the UK); select True if it uses a leading + symbol to specify the

country-specific international dialling code (e.g. +1nnn...). Default: True

Note: The PSTN2 modem does not handle a leading + correctly; if you use this number format with a PSTN2

modem the scene will report a system error.

UseTecVoiceMethods - deprecated, leave set to False. Default: False

UseTemporaryCLIR - select False to transmit Caller ID; select True to use a dummy caller id for this call.

Default: False

System


Users

Recipient - select the User resource to call

Routes:


Failed to make voice call - call failed due to service failure.

Failed to make voice call (system) - call failed due to system failure



Drop Voice Call scene Purpose: To end a voice call.

Properties:

Data

AllowNOCARRIER - set to True to treat the No Carrier response as an OK response; set to False to treat the

No Carrier response as a service error. Default: True for scripts created since v8.4; False for v8.4 (and earlier)

scripts - to preserve existing behavior.

CreateContentRecord - select whether to create a content record for this action. Default: True


Timeout - type the maximum time (seconds) to wait for the call to be dropped. Default: 3

UserBusy - select whether to return BUSY to the network (for example, to hand the call over to a messaging

service): True or False. Default: False

Note: This option is only supported by the following modems: SW8785V, SW8790V, SW8792V


System


Routes:

OK - call has ended

Failed to drop voice call - attempt has failed due to service failure

Failed to drop voice call (system) - attempt has failed due to system failure

No Carrier

This scene will encounter No Carrier if asked to drop a voice call when there wasn't one in progress. There are a

number of different scenarios, the main ones are:

A voice call has not been established - or the established voice call has failed

The other party has already dropped the voice call

The network has already dropped the voice call

In a two-party test, you would generally have both parties drop the voice call, but this may not be at the same time.

So it is very possible for one party to get an "OK" response back, whilst the other party gets a "NO CARRIER",

because it tried to drop the voice call after the other party had already dropped it. This is the most likely reason for

a NO CARRIER response.

Hint: To check if the voice call is still in progress use the AT+CLCC command (to get the list of current calls); to get

the reason why a voice has been dropped, use the AT+CEER command.



Wait for Call scene Purpose: To wait for an incoming call i.e. wait for the phone to ring.

Note: This scene does not answer the call; it exits when a call arrives (or times out). Use the Answer Voice Call

scene to answer it.

Properties:

Data

Caller - optional. Select the Prop resource to store the Caller ID in so you can access it later

Hardware - select the Hardware resource (terminal) to check for ringing

Timeout - type the maximum time (seconds) to wait for the call (the phone to ring). Default: 30

System


Routes:

OK - the phone has rung in the specified time

Failed to wait for call - attempt failed due to a service error

Failed to wait for call (system) - attempt failed due to a system error



Maintain Voice Call scene Purpose: To maintain a previously established voice call, for example while recording incoming audio.


Properties:

Data

Duration - type the maximum time (seconds) to wait before terminating the call. Default: 10


Timeout - type the maximum time to wait for individual AT commands. Default: 3

System


Routes:

OK - the call has been maintained for the specified time

Failed to maintain voice call - attempt failed due to a service error

Failed to maintain voice call (system) - attempt failed due to a system error



Answer Voice Call scene Purpose: To answer a voice call

Properties:

CLI

CLIMessage - type the message type to use to report the returned CLI Number. Default: blank

CLIResultProp - select the Prop resource to store the returned CLI Number. Default: (Nothing)

CLIResultProps - select the Props resource to store the array of values returned by the CLIP command (CLI

Number, Number type, etc). Default: (Nothing)

RequestCLI - select True to request the modem to display the received CLI number, select False to answer

the call. Default: True

RequireCLINumber - only relevant if RequestCLI is True. Set to True to fail if an empty string is returned.

Set to False to continue even if an empty string is returned. Default: True

Note: In Monitor Master 8.3, there was a single RequireCLI parameter. If this was set to True, the scene

waited for the CLI number before continuing; if this was set to False, the call was answered without waiting

for the CLI number. To emulate this legacy behavior, simply leave both RequireCLI and RequireCLINumber

set to True.

Data


Timeout - type the time to wait (seconds) for the call or CLI to arrive, or 0 to answer the call without

waiting. Default: 0

UseTecVoiceMethods - deprecated. Leave set to False. Default: False

System


Routes:

OK - answered voice call (success)

Failed to answer voice call - failed due to service error

Failed to answer voice call (system) - failed due to system error



Analyze PESQ scene Purpose: To calculate a PESQ score for a recorded WAV file

Note: This scene supports PESQ for Type 1 Modems; for Type 2 Modems, see the Measure Voice Quality scene.

PESQ (Perceptual Evaluation of Speech Quality) is an algorithm for the objective assessment of the subjective

quality of speech transmitted over telephone networks and speech codecs. PESQ implements ITU-T P.862, the

international standard for end-to-end objective measurement of telephone networks. Extensions allow it to be used

for the assessment of wideband telephony and HATS (head-and-torso simulator) measurements.

PESQ uses two WAV format files: the reference file contains the original transmitted audio and the degraded file, a

recording of the audio received over the network. Both files must use the same sampling rate: 8kHz or 16kHz.

The reference file must meet the specifications laid down by Psytechnics in their PESQ User Guide. Key points:

The reference file must contain speech or speech-like content with speech bursts of 1-3s separated by silent

periods of at least 300ms

PESQ is optimised for recordings of 8s in duration containing at least 4s of active speech.

As a guide, the minimum length file to give a representative PESQ score is about 6s, containing at least 3s of

active speech. Recordings of 16s or more should be split and scored separately.

Use the Play Audio and Start/Stop Voice Recording scenes to record the audio for PESQ scoring, unless you are

using the (discontinued) Radicom PSTN modem - for which you should use the Play TEC Audio and Record TEC

Audio scenes instead.

Optimum volume levels

Record and playback levels must be set correctly on the probes to achieve a fully representative PESQ score. For

details, see Using PESQ in the Story Boarder User Guide.

Properties:

Result

Metric Type - select the type of PESQ result metric to return: score, lq or ie. Default: score

score produces a PESQ score in the range -1 to 4.5

lq produces a PESQ score mapped to a subjective MOS in the range 1 to 6

ie produces the E-model Ie (impairment factor) derived from the PESQ score, in the range 0 to 140

Metric Value - optional. Select a Prop resource to store the result from the PESQ analysis. Default:

(Nothing) i.e. result is not stored

System


Voice

Degraded File - type the pathname (on the Agent) of the WAV file to analyze. Default: blank

Model - choose the PESQ model to use: v1, v2, wb or hatsear. Default: v2

v1 is the PESQ version 1.0-1.3 model, narrowband handset on reference and degraded

v2 is the standard PESQ model, narrowband handset on reference and degraded

wb is the wideband model, headphone listening

hatsear uses a HATS ear recording for degraded, reference is unprocessed (wideband)



ReferenceFile - type the pathname (on the Agent) of the reference WAV file. Default: blank

SampleRate - select the sample rate of the reference and degraded files: 8kHz or 16kHz. Default: 16kHz

Routes:

OK - the call quality has been assessed

Failed to analyse pesq (system) - attempt failed due to a system error



Test Circuit Switched Loopback scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two separate modems on

the same Probe.

Properties:

Actor

DestModem - select the Hardware resource (terminal) to use to receive the call

FileSize - type the number of bytes to transmit for the test. Default: 65536

Recipient - select the User resource specifying the phone number to call

SourceModem - select the Hardware resource (terminal) to use to make the call

Note: This scene requires a modem that supports 64kps circuit switched basic video calling,. If in doubt,

check the modem's SPD or ask our support department about your modem.

Data

Timeout - type the maximum time (seconds) to allow for the circuit test. Default: 60

System


Routes:

OK - test has completed

Failed to test CS - attempt has failed due to service failure

Failed to test CS (system) - attempt has failed due to system failure



Test Circuit Switched Remote scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two modems. This scene

makes the call, which is handled by a second modem under the control of the Test Circuit Switched Echo scene, in

another party.

Check the modem is ready before executing this scene (use Ensure Modem Ready) and allow the Circuit Switched

Echo scene 10 seconds initialise before calling it.

Note: In previous versions of Monitor Master a batch file (circuitswitchecho.bat) could be run on a remote PC to

handle the call. This technology is now deprecated. Contact our support department for more information.

Properties:

Actor


Recipient - select the User resource specifying the phone number to call.

Hint: Use the Get MSISDN for Party scene to fetch the number from the assigned modem, at run time. (See

Get MSISDN for Party for details.)




Data


System


Routes:






Test Circuit Switched Echo scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two modems. Run this

scene on the called party, to handle the call made by the Test Circuit Switched Remote scene.

Check the modem is ready before executing this scene (use Ensure Modem Ready) and allow 10 seconds for it to

initialise before making a call to it.

This scene does not return any metrics, it simply provides an echo server for Test Circuit Switched Remote scene to

use.



Properties:

Actor

Number of Calls - type the number of calls to handle. Default: 1

SourceModem - select the Hardware resource (SmartModem) to receive the call

Note: This scene requires a modem that supports 64kps circuit switched basic video calling. If in doubt,


Timeout - type the maximum time (seconds) to allow for each circuit test to complete. Default: 120

System


Routes:

OK - test have completed




Chapter 10 - Voice scenes

Use the scenes in the Voice Group to set up and test voice calls and services:

Assess Call Quality

Process Announcement

Stop Voice Recording

Start Voice Recording

Record Volume

Playback Volume

Play Audio

Telephony scenes

VoIP scenes



Assess Call Quality scene Purpose: To analyse the quality of a voice that was recorded in a WAV file

Hint: Also see the Measure Voice Quality scene.

Properties:

Result

Echo - optional. Select a Prop resource to store the result for echo detection. Default: (Nothing) i.e. result is

not stored

Quality - optional. Select a Prop resource to store the result for quality analysis. Default: (Nothing) i.e.

result is not stored

System


Voice

Interface - select the Audio Interface resource to use

WavFile - type the pathname of the WAV file to analyse. Default: blank

Routes:


Failed to assess quality - attempt failed due to a service error

Failed to assess quality (system) - attempt failed due to a system error



Process Announcement scene Purpose: To analyse an announcement that has been recorded in a WAV file.

Properties:

Result

AnnouncementLanguage - optional. Select a Prop resource to store the result for announcement language

detection. Default: (Nothing) i.e. result is not stored

AnnouncementText - optional. Select a Prop resource to store the detected announcement text. Default:


AnnouncementType - optional. Select a Prop resource to store the detected announcement type. Default:


System


Voice

Interface - select the Audio Interface resource to use

ReferenceFile - type the pathname of the reference WAV file. Default: blank

WavFile - type the pathname of the WAV file to analyse. Default: blank

Routes:

OK - the announcement has been processed

Failed to process announcement - attempt failed due to a service error

Failed to process announcement (system) - attempt failed due to a system error



Stop Voice Recording scene Purpose: To stop recording a voice call, and store it in a WAV file. The file can then be analyzed using the Assess

Call Quality or Process Announcement scene

Note: This scene is not supported by the F3607 modem.


Audio recording is now supported for the MC7304 and ME909u-521 modems, via the ACM

Audio recording is now supported for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs

Properties:

File

FileName - type the filename to use for the saved file, or leave blank to generate a name automatically.

Default: blank (automatic name)

Folder - type the pathname for the folder to store the file in. Default: blank

SavedFileName - select a Prop resource to store the filename in (if using an automatic name). Default:

(Nothing) - filename not stored

System


Voice

Session - select the IAPI Voice Session that you are recording. Note: This scene will allow you to select a

VoiceSession resource, but this does not work correctly.

Routes:

OK - voice recording has stopped

Failed to stop voice recording - attempt failed due to a service error

Failed to stop voice recording (system) - attempt failed due to a system error



Start Voice Recording scene Purpose: To start recording a voice call, in a WAV file. The file can then be analyzed using the Assess Call Quality

or Process Announcement scene.



Audio recording is now supported for the MC7304 and ME909u-521 modems, via the ACM

Audio recording is now supported for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs

Properties:

System


Voice

SampleRate - select the sample rate to use for the recording: Default, 8kHz or 16kHz. Note: This option is

ignored in the current version of Monitor Master - for most modems recording is at 8kHz; for the MC7304

and ME909u-521 modems recording is at 16kHz.

Session - select the IAPI Voice Session to record from. Note: The scene will allow you to select a

VoiceSession resource, but this does not work correctly.

Routes:

OK - voice recording has started

Failed to start voice recording - attempt failed due to a service error

Failed to start voice recording (system) - attempt failed due to a system error

Note: Use the Stop Voice Recording scene to stop recording and save the file.



Record Volume scene Purpose: Set the audio record volume for a Voice Session, and return the new volume as the Record volume

metric.

Note: The IAPI Voice Session resource sets the optimum record levels for Voice testing (including PESQ)

automatically, so you probably won't need to use the Record Volume scene.

Hint: To set levels on more than one source line, use more than one Record Volume scene. To set playback levels,

use the Playback Volume scene.

Note: This scene is not supported by the F3607, ME909-521 and MC7304 modems, or the Samsung Note 4 N910F

and Samsung Note 4 N910G EMUs.

Properties:

Data

SourceLine - select the mixer input line to set, or leave blank to set the master record level. Default: blank

VoiceSession - select the VoiceSession resource to set (or get) the volume for

Volume - type the volume level to set, from 0 (minimum) to 100 (maximum). Or leave blank to leave the

level unchanged and just return the current level. Default: blank

System


Routes:

OK - the record volume has been set (or got)

Failed to set record volume (system) - the record volume has not been set, due to a system error



Playback Volume scene Purpose: Set the audio playback volume for a Voice Session and return the new volume as the Playback volume

metric.

Hint: To set levels on more than one output line, use more than one Playback Volume scene. To set recording

levels, use the Record Volume scene.

Note: This scene is not supported by the F3607, ME909-521 and MC7304 modems, or the Samsung Note 4 N910F

and Samsung Note 4 N910G EMUs.

Properties:

Data

SourceLine - select the mixer output line to adjust, or leave blank to set the master playback level. Default:

blank

VoiceSession - select the VoiceSession resource to set (or get) the volume for

Volume - type the volume level to set, from 0 (minimum) to 100 (maximum). Or leave blank to leave the

level unchanged and just return the current level. Default: blank

System


Routes:

OK - the playback volume has been set (or got)

Failed to set playback volume (system) - the playback volume has not been set, due to a system error



Play Audio scene Purpose: To play an audio recording (in WAV format) over a voice connection.



Audio playback is now supported for the MC7304 and ME909u-521 modems, via the ACM

Audio playback is now supported for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs

Properties:

Data

AudioFile - type the pathname of the WAV file to use

VoiceSession - select the VoiceSession resource specifying the connection to play over

System


Routes:

OK - the audio has been played

Failed to play audio - attempt failed due to a service error

Failed to play audio (system) - attempt failed due to a system error

Telephony scenes Use the scenes in the Voice/Telephony Group for mobile and wired telephony:

Make DTMF Tone

Make Voice Call

Drop Voice Call

Wait for Call

Maintain Voice Call

Answer Voice Call

Analyse PESQ

Measure Voice Quality

Deprecated scenes



Make DTMF Tone scene Purpose: To issue DTMF (dialling) tones over a voice connection.

Properties:

Data

Duration - type the duration of each tone in hundredths of a seconds, or 0 for the default length. Default: 0

Note: This property is supported by the following modems: the Sierra Wireless SW8785V, SW8790V and

SW8792V and the Siemens MC75. It will be ignored if using other modems or the TEC Voice Methods.

Hardware - select the Hardware resource (terminal) to sound the tone(s) over

Keys - type the key or keys (0-9, *, #) to generate the DTMF tones for. Default: blank

UseTecVoiceMethods - set to True to use the TEC Voice Methods instead of standard modem commands.

Default: False

Warning: you should only use the TEC Voice Methods with the (discontinued) Radicom PSTN1

SmartModem - to improve the audio quality.

System


Routes:

OK - Success, the call has been set up

Failed to make DTMF tone - attempt failed due to service failure

Failed to make DTMF tone (system) - attempt failed due to system failure



Make Voice Call scene Purpose: To set up a voice call.

Hint: On a CDMA network, use the CDMA Make Voice Call scene instead.


For Type 2 Modems the Call Setup Time metric will be calculated from the Setup Time if the Setup Service

Time Service Request is not available. This means that a Call Setup Time is now reported for VoLTE calls.


For Type 2 Modems, the way that the Call Setup Time metric is calculated has been changed so that

different makes of modem will report similar times. The values returned for the F3607 modem will be a little

higher than in previous releases

A new message was introduced called Call Domain to tell you how the call was handled. Its value can be:

Packet Switched (VoLTE)

Circuit Switched

Unknown

Properties:

Data

CreateContentRecord - choose True to record a content record for this action; choose False to create no

content record. Default: True

Hardware - select the Hardware resource (terminal) to use to make the call

ImmediateReturn - select True to return immediately after making the call; select False to return once the

call has been answered or the timeout has expired. Default: False


UseInternationalAccessCode - select False if the Recipient resource specifies a standard E.164 format

number (e.g. 001nnn... to dial the USA from the UK); select True if it uses a leading + symbol to specify the

country-specific international dialling code (e.g. +1nnn...). Default: True

Note: The PSTN2 modem does not handle a leading + correctly; if you use this number format with a PSTN2

modem the scene will report a system error.


UseTemporaryCLIR - select False to transmit Caller ID; select True to use a dummy caller id for this call.

Default: False

System


Users

Recipient - select the User resource to call

Routes:


Failed to make voice call - call failed due to service failure.




Drop Voice Call scene Purpose: To end a voice call.

Properties:

Data

AllowNOCARRIER - set to True to treat the No Carrier response as an OK response; set to False to treat the

No Carrier response as a service error. Default: True for scripts created since v8.4; False for v8.4 (and earlier)

scripts - to preserve existing behavior.

CreateContentRecord - select whether to create a content record for this action. Default: True



UserBusy - select whether to return BUSY to the network (for example, to hand the call over to a messaging

service): True or False. Default: False

Note: This option is only supported by the following modems: SW8785V, SW8790V, SW8792V


System


Routes:

OK - call has ended

Failed to drop voice call - attempt has failed due to service failure

Failed to drop voice call (system) - attempt has failed due to system failure

No Carrier

This scene will encounter No Carrier if asked to drop a voice call when there wasn't one in progress. There are a

number of different scenarios, the main ones are:

A voice call has not been established - or the established voice call has failed

The other party has already dropped the voice call

The network has already dropped the voice call

In a two-party test, you would generally have both parties drop the voice call, but this may not be at the same time.

So it is very possible for one party to get an "OK" response back, whilst the other party gets a "NO CARRIER",

because it tried to drop the voice call after the other party had already dropped it. This is the most likely reason for

a NO CARRIER response.

Hint: To check if the voice call is still in progress use the AT+CLCC command (to get the list of current calls); to get

the reason why a voice has been dropped, use the AT+CEER command.



Wait for Call scene Purpose: To wait for an incoming call i.e. wait for the phone to ring.

Note: This scene does not answer the call; it exits when a call arrives (or times out). Use the Answer Voice Call

scene to answer it.

Properties:

Data

Caller - optional. Select the Prop resource to store the Caller ID in so you can access it later

Hardware - select the Hardware resource (terminal) to check for ringing

Timeout - type the maximum time (seconds) to wait for the call (the phone to ring). Default: 30

System


Routes:

OK - the phone has rung in the specified time

Failed to wait for call - attempt failed due to a service error

Failed to wait for call (system) - attempt failed due to a system error



Maintain Voice Call scene Purpose: To maintain a previously established voice call, for example while recording incoming audio.


Properties:

Data

Duration - type the maximum time (seconds) to wait before terminating the call. Default: 10


Timeout - type the maximum time to wait for individual AT commands. Default: 3

System


Routes:

OK - the call has been maintained for the specified time

Failed to maintain voice call - attempt failed due to a service error

Failed to maintain voice call (system) - attempt failed due to a system error



Answer Voice Call scene Purpose: To answer a voice call

Properties:

CLI

CLIMessage - type the message type to use to report the returned CLI Number. Default: blank

CLIResultProp - select the Prop resource to store the returned CLI Number. Default: (Nothing)

CLIResultProps - select the Props resource to store the array of values returned by the CLIP command (CLI

Number, Number type, etc). Default: (Nothing)

RequestCLI - select True to request the modem to display the received CLI number, select False to answer

the call. Default: True

RequireCLINumber - only relevant if RequestCLI is True. Set to True to fail if an empty string is returned.

Set to False to continue even if an empty string is returned. Default: True

Note: In Monitor Master 8.3, there was a single RequireCLI parameter. If this was set to True, the scene

waited for the CLI number before continuing; if this was set to False, the call was answered without waiting

for the CLI number. To emulate this legacy behavior, simply leave both RequireCLI and RequireCLINumber

set to True.

Data


Timeout - type the time to wait (seconds) for the call or CLI to arrive, or 0 to answer the call without

waiting. Default: 0

UseTecVoiceMethods - deprecated. Leave set to False. Default: False

System


Routes:

OK - answered voice call (success)

Failed to answer voice call - failed due to service error

Failed to answer voice call (system) - failed due to system error



Analyze PESQ scene Purpose: To calculate a PESQ score for a recorded WAV file

Note: This scene supports PESQ for Type 1 Modems; for Type 2 Modems, see the Measure Voice Quality scene.

PESQ (Perceptual Evaluation of Speech Quality) is an algorithm for the objective assessment of the subjective

quality of speech transmitted over telephone networks and speech codecs. PESQ implements ITU-T P.862, the

international standard for end-to-end objective measurement of telephone networks. Extensions allow it to be used

for the assessment of wideband telephony and HATS (head-and-torso simulator) measurements.

PESQ uses two WAV format files: the reference file contains the original transmitted audio and the degraded file, a

recording of the audio received over the network. Both files must use the same sampling rate: 8kHz or 16kHz.

The reference file must meet the specifications laid down by Psytechnics in their PESQ User Guide. Key points:

The reference file must contain speech or speech-like content with speech bursts of 1-3s separated by silent

periods of at least 300ms

PESQ is optimised for recordings of 8s in duration containing at least 4s of active speech.

As a guide, the minimum length file to give a representative PESQ score is about 6s, containing at least 3s of

active speech. Recordings of 16s or more should be split and scored separately.

Use the Play Audio and Start/Stop Voice Recording scenes to record the audio for PESQ scoring, unless you are

using the (discontinued) Radicom PSTN modem - for which you should use the Play TEC Audio and Record TEC

Audio scenes instead.

Optimum volume levels

Record and playback levels must be set correctly on the probes to achieve a fully representative PESQ score. For

details, see Using PESQ in the Story Boarder User Guide.

Properties:

Result

Metric Type - select the type of PESQ result metric to return: score, lq or ie. Default: score

score produces a PESQ score in the range -1 to 4.5

lq produces a PESQ score mapped to a subjective MOS in the range 1 to 6

ie produces the E-model Ie (impairment factor) derived from the PESQ score, in the range 0 to 140

Metric Value - optional. Select a Prop resource to store the result from the PESQ analysis. Default:


System


Voice

Degraded File - type the pathname (on the Agent) of the WAV file to analyze. Default: blank

Model - choose the PESQ model to use: v1, v2, wb or hatsear. Default: v2

v1 is the PESQ version 1.0-1.3 model, narrowband handset on reference and degraded

v2 is the standard PESQ model, narrowband handset on reference and degraded

wb is the wideband model, headphone listening

hatsear uses a HATS ear recording for degraded, reference is unprocessed (wideband)



ReferenceFile - type the pathname (on the Agent) of the reference WAV file. Default: blank

SampleRate - select the sample rate of the reference and degraded files: 8kHz or 16kHz. Default: 16kHz

Routes:


Failed to analyse pesq (system) - attempt failed due to a system error



Measure Voice Quality scene Purpose: To produce voice quality metrics (PESQ, POLQA, Speech Path Delay) for a voice call, by using built-in

test samples.

This scene can be used to measure voice quality for a call between two modems or between a modem and Call

Generator. It can use these modems:

the Ericsson F3607 modem - PESQ and POLQA

the Huawei ME909u-521 modem - POLQA only

the Sierra Wireless MC7304 modem - POLQA only

And these EMUs:

Samsung Galaxy S5 SM-G900A EMU - POLQA only

Samsung Galaxy S5 SM-G900F EMU - POLQA only

Samsung Galaxy Note 4 SM-N910F EMU - POLQA only

Samsung Galaxy Note 4 SM-N910G EMU - POLQA only

Technical note: The ME909u and MC7304 use a new internal hardware option for the RTU-5, the

TEMS ACM (Audio Capture Module). The F3607 and EMUs use Device Digital Audio.


This scene is now supported for the Samsung Note 4 N910F and Samsung Note 4 N910G EMUs


The ACM now supports two modems at the same time

This scene now supports a number of EMUs


Support for 2 new modems and the ACM

Removal of the Measurement Type parameter and the DL Only mode

Using this scene

Mobile to Mobile testing requires a two-party test, with caller and recipient parties synchronized so they both

execute the Measure Voice Quality scene at the same, after the call has been established. Mobile to Fixed Line

testing requires a single-party test which calls the Call Generator and then executes the Measure Voice Quality

scene once it has answered. Results can be downloaded from Call Generator once the call has finished.

The parties in the call record each sample they receive as a separate degraded sample file, which is then scored using

the selected voice quality algorithm. These temporary files are deleted automatically when the test ends. If you

wish to preserve them for later use, set the SavedFileNames property to a Props resource and it will save the

filenames to it. Your script can then use the Upload File to Projector scene to copy the files from the probe to a

convenient location. Note that this can retrieve degraded samples from Agents, but not from Call Generator - to do

that, you will need additional advanced scripting,

Hint: For detailed information, including background, metrics and advanced scripts, see Using Voice Quality

Measurement in the Story Boarder User Guide or Voice Quality Measurement in the Help. For background

information on PESQ, POLQA and other Audio Quality Measurement technologies offered by TEMS products, see

the AQM in TEMS Products guide, NT12-6517.



Properties:

Files

SavedFileNames - add a Props resource to the script and select its name here to store the names of the

degraded sample files; the script can then copy the files to another location so they are accessible after the

script ends. Optional. Default: blank

Hardware

Hardware - the Hardware resource that defines the modem to use. You must select a suitable modem (listed

above)

System


Voice

Algorithm - select the method to use to evaluate voice quality:

PESQ P862.1 - mobile to mobile PESQ scoring, algorithm described in ITU recommendation P.862.1.

Default option.

POLQA P863 Narrowband - suitable for low bandwidth connections, algorithm described in

ITU recommendation P.863

POLQA P863 Super Wideband - suitable for high bandwidth connections, algorithm described in

ITU recommendation P.863

WARNING: If you are performing M2M testing, you must select the same algorithm at both ends, or

the test will fail with a system error.

AudioSource - select the type of audio source from:

Auto - select the mode based on the slot number (slot #0, 1, 2 or 3 selects TEMS RTU5; slot #10 or

more selects Digital Device Audio; the F3607 is detected as a special case)

Digital Device Audio - for the F3607

TEMS RTU5 - for the ME909u and MC7304

Call Type - select M2M if making a call to, or receiving a call from another mobile (modem); select M2F if

making a call to a fixed line (Call Generator). Default: M2M

Duration - type the length of time (seconds) to evaluate quality for i.e. how long a sample to use. (The test

samples are repeated as necessary to produce a call of the selected duration.) Default: 60

WARNING: If you are performing M2M testing, you must select the same duration at both ends, or the test

will fail with a system error.

The Measurement Type parameter has been removed because support for DL Only (receive audio only) mode has

been removed; the measurement type is always set to DL + UL Semi Duplex (send and receive audio). If you run

an old script that uses the DL + UL Semi Duplex mode it will run normally. If you run an old script that has uses

the (now unsupported) DL Only mode, it will fail with a system error. Edit the script and save it to update it.

Routes:

OK - voice quality has been measured

Failed to measure voice quality (system) - attempt failed due to a system error

ACM Diagnostics

If you are using a modem that relies on the Audio Capture Module for audio recording (such as the MC7304 or

ME909u) you may see the following diagnostic messages, which indicate a problem:



VoiceQualityFailure: ACU device not found or not associated to UE - a modem in slot#2 or #3 has tried to use the

ACM. (The ACM is only supported from slots #0 and #1.)

VoiceQualityFailure: Unable to open ACU device, Error Code: FT_DEVICE_NOT_OPENED - a modem has tried

to use the ACM when it is already in use by two other modems. (The ACM can only be used by two modems at a

time.)

In either case the Measure Voice Quality scene will take the Failed to measure voice quality (system) outcome.

Telephony: Deprecated scenes These Telephony scenes are deprecated and should not be used:

Play Spoken Phrase

Play TEC Audio

Record TEC Audio



Play Spoken Phrase scene Purpose: To speak a phrase over a voice connection, using text-to-speech synthesis.

Warning: This scene is deprecated. It should not be used.

Properties:

Data

Asynchronous - set to False to return when the phrase has finished; set to True to return before it has

finished. Default: False

Phrase - type the phrase to speak. Default: blank

VoiceSession - select the VoiceSession resource to use

System


Routes:

OK - success, the phrase was spoken

Failed to speak audio (system) - attempt failed due to a system error



Play TEC Audio scene Purpose: To play an audio recording (in WAV format) over a Radicom PSTN SmartModem, for PESQ analysis.

This scene does not capture timings.

Warning: This scene is deprecated. It should only be used with the (discontinued) Radicom PSTN1 SmartModem,

to provide better quality audio playback than the Play Audio scene. If you're using any other SmartModem,

including the current PSTN2 Modem, use the Play Audio scene instead.

Properties:

System


Voice

Delay - type the time (milliseconds) to wait after playing the audio. Default: 0

Hardware - select the SmartModem resource to use. Default: nothing

WAV File - type the pathname of the WAV file to play. Default: blank

Routes:

OK - the audio has been played

Failed to play tec audio (system) - attempt failed due to a system error



Record TEC Audio scene Purpose: To record audio (in WAV format) from a Radicom PSTN SmartModem, for PESQ analysis. This scene

does not capture timings.

Warning: This scene is deprecated. It should only be used with the (discontinued) Radicom PSTN1 SmartModem,

to provide better quality audio recordings than the Voice Recording scenes. If you're using any other

SmartModem, including the current PSTN2 Modem, use the Start Voice Recording and Stop Voice Recording

scenes instead.

Properties:

System


Voice

Delay - type the time (milliseconds) to wait after recording the audio. Default: 0

Duration - type the time (milliseconds) to record from the TEC. Default: 0

Hardware - select the SmartModem resource to use. Default: nothing

WAV File - type the pathname of the WAV file to store the recording in. Default: blank

Routes:

OK - the audio has been recorded

Failed to record tec audio (system) - attempt failed due to a system error

VoIP scenes Use the scenes in the Voice/VoIP Group to make and receive voice calls and send and receive messages over a

Voice over IP network, using the Session Initiation Protocol (SIP):

Make SIP Call

Drop SIP Call

Wait for SIP Call

Send SIP Message

Receive SIP Message

Also see:

the VoIP Client resource, used to configure a VoIP User

the VoIP VoiceSession resource, used to configure the voice session for a VoIP User

the VoIP PCAP resource, used to trace network traffic for a VoIP Client

You can also use the Start Voice Recording, Stop Voice Recording and Play Audio scenes with a VoIP Client, to

record a call.

Note: VoIP functionality is limited to one VoIP session per Probe.



Make SIP Call scene Purpose: To set up a voice call over a SIP connection.

Note: You must establish a data connection before using this scene, for it to use to connect to the SIP Server. The

connection must use the VoIP Client and VoIP VoiceSession resources.

Properties:

Data

Client - select the VoIP Client resource to use

Destination - select the User resource to call. (A call will be made to its SIPAddress.)


System


Routes:

OK - success, the VoIP call has been set up

Failed to originate VoIP call - call failed due to service failure.

Failed to originate VoIP call (system) - call failed due to system failure



Drop SIP Call scene Purpose: To end a voice call over a SIP connection.

Properties:

Data



System


Routes:

OK - success, the VoIP call has been dropped

Failed to drop VoIP call - call has not been dropped due to service failure.

Failed to drop VoIP call (system) - call has not been dropped due to system failure



Wait for SIP Call scene Purpose: To wait for (and answer) an incoming voice call over a SIP connection.

Note: You must establish a data connection before using this scene, for it to use to connect to the SIP Server.

Properties:

data

Caller - select the User resource in which to store the caller id. Optional. Default: Nothing

Data


Timeout - type the maximum time (seconds) to wait for the other party to call. Default: 60

TimeoutAnswerCall - type the maximum time (seconds) to wait to answer an incoming call. Default: 5

System


Routes:

OK - success, the VoIP call has been answered

Failed to wait for VoIP call - call has not been answered due to service failure.

Failed to wait for VoIP call (system) - call has not been answered due to system failure



Send SIP Message scene Purpose: To send a message over a SIP connection.


Properties:

Data


Destination - select the User resource to send the message to. (It will be sent to their SIPAddress.)

Message - type the text message to send. Default: blank

System


Routes:

OK - success, the VoIP message has been sent

Failed to send VoIP message - message has not been sent due to service failure.

Failed to send VoIP message (system) - message has not been sent due to system failure



Receive SIP Message scene Purpose: To receive a message over a SIP connection.


Properties:

Data


Results - select the Prop to store the received message in. Optional. Default: Nothning

Sender - select the Prop to store the sender's ID in. Optional. Default: Nothing

Timeout - type the maximum time (seconds) to wait for the message. Default: 60

System


Routes:

OK - success, a VoIP message has been received

Timed out - a message has not been received with the timeout period

Failed to receive VoIP message - message has not been received due to service failure.

Failed to receive VoIP message (system) - message has not been sent due to system failure


Chapter 11 - Video Call scenes

Use the scenes in the Video Call Group to test circuit-switched video:

Test Circuit Switched Loopback

Test Circuit Switched Remote

Test Circuit Switched Echo



Test Circuit Switched Loopback scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two separate modems on

the same Probe.

Properties:

Actor

DestModem - select the Hardware resource (terminal) to use to receive the call


Recipient - select the User resource specifying the phone number to call




Data


System


Routes:




Chapter 11 - Video Call scenes


Test Circuit Switched Remote scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two modems. This scene

makes the call, which is handled by a second modem under the control of the Test Circuit Switched Echo scene, in

another party.

Check the modem is ready before executing this scene (use Ensure Modem Ready) and allow the Circuit Switched

Echo scene 10 seconds initialise before calling it.



Properties:

Actor


Recipient - select the User resource specifying the phone number to call.

Hint: Use the Get MSISDN for Party scene to fetch the number from the assigned modem, at run time. (See

Get MSISDN for Party for details.)




Data


System


Routes:






Test Circuit Switched Echo scene Purpose: To test a circuit switched 64kbps connection (used for 3G video calling), using two modems. Run this

scene on the called party, to handle the call made by the Test Circuit Switched Remote scene.

Check the modem is ready before executing this scene (use Ensure Modem Ready) and allow 10 seconds for it to

initialise before making a call to it.

This scene does not return any metrics, it simply provides an echo server for Test Circuit Switched Remote scene to

use.



Properties:

Actor

Number of Calls - type the number of calls to handle. Default: 1

SourceModem - select the Hardware resource (SmartModem) to receive the call

Note: This scene requires a modem that supports 64kps circuit switched basic video calling. If in doubt,


Timeout - type the maximum time (seconds) to allow for each circuit test to complete. Default: 120

System


Routes:

OK - test have completed




Chapter 12 - Network scenes

Use the scenes in the Network Group to test the network level:

Query Signal Strength

Select Operator

Get Operators

Wait for Network

Set RAT

Lock Band

Data scenes

Authentication scenes

PCAP scenes

Diagnostics scenes



Query Signal Strength scene Purpose: Check if signal is strong enough for hardware operation

Note: For Type 2 Modems such as the SW7700 and SW7710 LTE modems, this scene will execute correctly but

return a dummy RSSI value of 42.

Properties:

Actor


Data

Minimum RSSI - type the minimum acceptable Received Signal Strength Indicator value, range 0 to 31.

Default: 5

System


Routes:

OK - measured signal is equal to or greater than minimum set in properties

Signal too weak - measured signal is less than minimum set in properties

Failed to query signal strength (system) - measurement failed due to system error



Select Operator scene Purpose: To roam to another operator

Properties:

Modem

SmartModem - select the Hardware resource (SmartModem) to use

Operator

CountryCode- type the country code of the Operator to roam to, eg 001 for USA, 044 for UK

OperatorCode - type the code of the Operator to roam to, eg 202-01 for COSMOTE, Greece. Operator codes

are listed online, for example from:

http://www.mobileworld.org/gsm_operator_codes.html

System


Routes:

OK - success, the operator has been selected

Failed to select operator - could not select operator due to service failure

Failed to select operator (system) - could not select operator due to system failure



Get Operators scene Purpose: To get a list of network operators

Properties:

Modem

Hardware - select the Hardware resource (terminal) that defines the modem to use

Operator

Props - select the Props resource to store the Operator details in

System


Routes:

OK - success, operator details have been fetched from the specified modem

Failed to get operators - operation failed due to service failure

Failed to get operators (system) - operation failed due to system failure



Wait for Network scene Purpose: To wait for the network to reach a specified state

Properties:

Modem


Timeout - type the maximum time (seconds) to wait for the network to reach the specified status (before

timing out). Default: 5

Network

Status - select the network status to wait for: NotRegistered, Registered, HomeOnly, RoamingOnly, or

Denied. Default: Registered.

OperatorCode - type the code of the Operator to roam to, eg 202-01 for COSMOTE, Greece. Operator codes

are listed online, for example from:

http://www.mobileworld.org/gsm_operator_codes.html

System


Routes:

OK - success, the network reached the specified status before the timeout expired

Failed to wait for network - network did not reach the specified status before the timeout period, due to

service failure

Failed to wait for network (system) - network did not reach the specified status before the timeout period,

due to system failure



Set RAT scene Purpose: To set the Radio Access Technology that a modem should use for the test - or allow it to roam to the best

available network

This scene should be executed before any other scene accesses the modem to give it time to switch to the specified

network before required to accessed it. If the Set RAT scene specifies a RAT that the modem is already locked to, it

will not change anything on the modem.

Hint: To check which network is being used, use the Get Additional Modem Information scene with Bearer

Technology set to True.

Also see the Lock Band scene.

Modems

This scene supports a number of modems, including:

Ericsson F3607 modem

LG VL600 modem

Sierra Wireless MC7304 (SW7304) modem




Samsung Galaxy SIII SPH-L710 EMU

Each modem implements RAT locking differently - see the notes at the end of this description for modem-specific

details.

Properties:

Data

RAT - type the name of the Radio Access Technology to use. Valid options are:

NONE - automatic mode; the modem will choose the best network available when it registers on the

network; roaming mode

GSM - the modem will choose the best network available, from GSM, GPRS and EDGE

WCDMA - the modem will choose the best network available, from WCDMA, UMTS, HSPA and

HSPA+

LTE - force LTE

CDMA - force CDMA 1xEV-DO mode

CDMAONE - force CDMA One (IS-95)

CDMA2000 - force CDMA 2000

EVDO - force EVDO

TDSCDMA - force TD-SCDMA

WIMAX - force Worldwide Interoperability for Microwave Access

In versions of Monitor Master before 9.2, there was only one CDMA option, which was equivalent to the

current CDMA2000 option.

WARNING: Be careful to select a RAT that the modem supports. If you select a valid RAT that the modem

does not support, the scene will lock the modem to it, but the modem will not be able to register to the

network. Check the modem SPD for a list of networks it supports.



Hardware

Hardware - the Hardware resource that defines the modem to use.

System


Routes:

OK - success, the RAT is valid, the modem supports RAT Lock, and the RAT has been locked to the

specified choice. Note that for most modems this does NOT mean that the modem has achieved the

specified RAT or that the specified RAT is available!

OK (RAT selection not supported on device) - the modem does not support RAT Lock so this scene has no

effect. Note that this is not reported as an error

Invalid RAT specified (system) - system error. You have specified a RAT that is not in the list above.

Device does not support RAT (system) - system error. The modem supports RAT Lock and you have

specified a RAT from the list above, but the modem does not support this RAT.

RAT lock operation failed (system) - system error. The modem did not power up or did not achieve the

specified RAT Lock.

The SW7700, SW7710, SW7750 and VL600 modems

These modems are RAT locked to LTE by default so they usually function solely as an LTE modem.

However, they can use other (fallback) bearers, just like LTE phones - to provide 2G or 3G network access when

LTE is not available or not wanted. You can also use the Set RAT scene to override the default RAT Lock for the

length of a test; the default LTE RAT Lock will be asserted for the next test.

The SPH-L710 EMU

This modem is not RAT locked by default and is free to roam between Sprint's LTE and CDMA networks, but is

supported by the Set RAT scene. CDMA testing is not supported on this device at this time, so we recommend that

you use the Set RAT scene to lock it to LTE. The modem will stay RAT Locked to LTE for subsequent testing.

WARNING: Setting (or changing) the RAT Lock on this modem power cycles it, which takes around one minute

and usually causes the script to report an error. The simplest way to avoid this disrupting your testing is to create a

simple script to set the RAT to LTE (and do nothing else) and then run it once on each of your modems to set them

all to LTE before you start using them.

The SW7304 modem

This modem can be RAT locked to a specific bearer or unlocked to allow it to roam just like an LTE phone - to

provide 2G or 3G network access when LTE is not available or not wanted.

You can use the Set RAT scene to choose a RAT Lock and the modem will stay locked to that RAT for subsequent

testing.

The Set RAT scene is enhanced for this modem. When you specify a RAT, the scene will wait (up to 60 seconds)

for the modem to register on the specified network - and reports an error if it cannot. (With most other modems,

the Set RAT scene sets the RAT but doesn't wait for the modem to achieve it.)

The F3607 Modem

This modem can be RAT locked to a specific bearer or unlocked to allow it to roam just like an LTE phone - to

provide 2G or 3G network access when LTE is not available or not wanted.



You can use the Set RAT scene to choose a specific RAT and the modem will stay locked to that RAT for

subsequent testing.

Other modems

Other modems are not supported by the Set RAT scene. If you use Set RAT with an unsupported modem, the scene

will exit with the alternative OK outcome: OK (RAT selection not supported on device). This is not an error.



Lock Band scene Purpose: To set the Radio Access band(s) that a modem should use for a RAT.

Hint: To check which network is being used, use the Get Additional Modem Information scene with Bearer

Technology set to True.

Modems

This scene supports Type 2 Modems only. It has been tested on:

Sierra Wireless MC7710

Sierra Wireless MC7304

Huawei ME909u-521

Modems differ in:

The name used for each Band - see Band Names, below

The number of Bands you can select for each RAT: some modems support only one Band per RAT, while

others support multiple Bands

The way that invalid Bands are handled: some modems will error, while others will simply ignore the

invalid Band

Properties:

Hardware

Hardware - the Hardware resource that defines the modem to use.

Radio

Band - the Props resource that specifies the Band or Bands that you want the modem to lock to (enable).

Each element is the name of a Band, which must exactly match the name of a Band for this modem (see Band

Names, below), such as Band 1 (2100). If the resource is empty, this will remove any Band Locks for the

specified RAT. If the modem supports multiple Band Locks for a RAT, the specified Bands are added to any

Bands that are already set; use an empty resource to remove any locks and start again. Default: Band

resource (empty)

RAT - the RAT that you want the Band lock to apply to. You can apply a Bank Lock to a RAT whether or not

the modem is currently locked to it. Valid options are as for the Set RAT scene:

GSM - GSM, GPRS or EDGE

WCDMA - WCDMA, UMTS, HSPA or HSPA+

LTE - LTE (default)

CDMA - CDMA 1xEV-DO mode

CDMAONE - CDMA One (IS-95)

CDMA2000 - CDMA 2000

EVDO - EVDO

TDSCDMA - TD-SCDMA

WIMAX - Worldwide Interoperability for Microwave Access

WARNING: Be careful to select a RAT that the modem supports. If you select a valid RAT that the modem

does not support, the scene will lock the modem to it, but the modem will not be able to register to the

network. Check the modem SPD for a list of networks it supports.



System


Routes:

OK - success, the Band Lock has been applied to the specified RAT. Note that for most modems this does

NOT mean that the modem has achieved the specified Band or that the specified Band is available!

Failed to lock band (system) - system error. This modem does not support Band Locking or the specified

RAT and Band is not compatible with this modem, or some other error occurred while applying the lock.

(Check the diagnostic message for a detailed explanation.)

Diagnostic messages

If a system error occurs, a diagnostic message will indicate why:

Band Locking not supported by this device - Modem is either not a TCC device, device is incapable

of band locking, or band locking is not yet implemented for this device.

Band lock operation failed - Modem supports band locking with the supplied RAT and Band(s)

combination but the lock operation reported a failure.

Multiple band selection not allowed for RAT <RAT> - You specified multiple bands to lock to but the

modem does not support locking of multi-locking.

<band> unsupported, supported bands are <band1>, <band2>,... The band you specified (<band>)

is not supported by this modem for the specified RAT. The message lists the name of each band that it does

support, which provides a convenient way to investigate new modems.

Band Names

Not only do different modems support different bands for each RAT, but they can also use different names for the

same bands. You must use the correct band name for a modem or the band lock will fail. The band names for each

modem and RAT can be determined by using TEMS Investigation.

Another way to determine the band names supported by a modem for a RAT is to run a test that requests a non-

existent Band such as xxx. The test will fail with a diagnostic message that reports the names you can use, like this:

xxx unsupported, supported bands are Band 1 (2100),Band 3 (1800),Band 7 (2600),Band 8

(900),Band 20 (800)

In this example, you can see that the Band names supported by this modem and RAT are:

Band 1 (2100)

Band 3 (1800)

Band 7 (2600)

Band 8 (900)

Band 20 (800)

Data Scenes Use the scenes in the Network/Data Group to test data networks:

Download FTP

Upload FTP

Download HTTP

Ping

Video Ping

DNS Lookup



Download FTP scene Purpose: Download (get) a file from a specified location (URL) using the FTP protocol

Note: If you wish to download files larger than 80MB (or 30MB if using IP Trace or Radio Trace) or change the

input buffer size, you must use Performance Measuring Mode.

Important change in 10.3.1

The interpretation of the ReceiveWindow property has changed, affecting throughput.

In previous versions of Monitor Master, setting this property to 0 sets the Receive Window size to the

default 64,000 bytes, but in Monitor Master 10.3.1 onwards, setting ReceiveWindow to 0 selects an

automatic optimization algorithm. The result is that data throughput is significantly improved, compared

to previous versions of Monitor Master. This change is delivered by the software on the probe, so any

probes that have not been upgraded to 10.3.1 or beyond, such as X-series probes, will not be affected.

If you compare FTP download results with earlier versions of Monitor Master:

If your scripts use Performance Measuring Mode and set ReceiveWindow > 0: throughput is comparable

for 10.3.1 onwards, you don't need to make any changes

If your scripts use Performance Measuring mode and set ReceiveWindow = 0: throughput will be

enhanced for 10.3.1 onwards. If you want to produce comparable results, set ReceiveWindow = 64000 in

your scripts

If your scripts use Normal Mode: throughput is enhanced for 10.3.1 onwards but you don't need a

workaround as you don’t use Normal Mode to measure (or compare) throughput

For maximum throughput, we suggest you use Performance Measuring mode and set ReceiveWindow = 0

to allow the automatic optimization algorithm to set the buffer size for you.

Properties:

Actor


Authentication

Password - type the password to supply to the remote host, to access this file. Default: blank

User - type the username to use on the host. Default: blank

File

File - type the name of the file to download. Default: blank

Path - type the path of the file to get, on the host. Default: /

Performance

MeasurePerformance - choose False for Normal Mode; choose True to switch to Performance Measuring Mode

(see below). Default: False

ReceiveWindow - type the size (in bytes) of the input buffer to use in Performance Measuring Mode - or

leave it set to 0 to enable automatic optimization (see Changes in 10.3.1, above). Default: 0

This property is ignored in Normal Mode, which uses automatic optimization.

Hint: You can also set the Receive Window size by using the x-ubx-test-tcp-input-buffer-size control

header. See FTP Scripting in the Advanced Scripting Guide for details.

Server



Host - type the name of the host to get the file from. Default: blank

Port - type the port number to use. Default: 21

System


Transfer

Mode - select the server interaction mode from Active or Passive. Default: Active

Timeout- type the timeout for the transfer, in seconds or leave set to blank or 0 for no timeout. Default:

blank

TimeoutType - select the type of timeout to use. Choose Inactivity to timeout if the server does not respond

for the specified period at any time during the transfer; choose Absolute to timeout if the server does not

complete the transfer within the specified period. Default: Inactivity

TransferType - select the transfer type, from ASCII and binary. ASCII is only suitable for plain text, binary

is suitable for all data types. Default: ASCII

Routes:

OK - file has downloaded successfully

Failed to download FTP - download failed due to a service error

Failed to download FTP (system) - download failed due to a system error

Performance Measuring Mode

Using earlier versions of Monitor Master (before v9.0), the largest file that you can reliably download using FTP is

80MB (or 30MB if your script uses IP Trace or Radio Trace); the use of larger files reduces system stability. In

Monitor Master 9.0 we introduced Performance Measuring Mode, to support the download of much larger data

files and allow more representative testing of high-performance data networks such as LTE.

To enable Performance Measuring Mode simply set the MeasurePerformance property to True, in the Download

FTP scene. This has three main effects:

Maximum throughput is enhanced, as the probe does not have to write content to disk

The content downloaded by the scene is not stored - so content analysis is very limited

The receive window (input buffer size) can be set according to the scene's ReceiveWindow property, to

optimize throughput manually according to your network speed and latency.

For detailed information on configuring Performance Measuring Mode manually, see Data throughput

optimization in the Story Boarder User Guide. However, for Monitor Master 10.3.1 onwards, you can set

ReceiveWindow=0 to use the automatic optimization algorithm to set the buffer size for you.

The absence of downloaded content means that:

the content-length records are inaccurate. For an accurate result, use CDbl(ArgoScript.GetHeader("x-ubx-

test-ftp-transfer-bytes")) in an Advanced Script scene

any attempt at content analysis will be performed on empty content

Screening Room reports will report a blank indicative size for the test

However, the Record Content Metrics scene returns correct metrics for FTP download, even in Performance

Measuring Mode.



Additional metrics

Additional Metrics were added to this scene for Monitor Master v9.0 to more accurately measure the download

performance:

End to end payload duration

End to end payload data size

End to end payload transfer rate

End to end payload transfer rate (bits)

By default, these measurements use the FTPGetStart timing point as the start of the download for these metrics. If

you wish, you can chose a different starting point (from the list below), by adding it to the script, using the Internal

timing point scene:

FTPServer150RETR - when the client sends the request to the FTP server to send the contents of the file

FTPClientRETR - when the response from the FTP server to the above request is received; the very last

message sent before it starts sending the data

FTPGetStart - when the client sends the GET request to the FTP server



Upload FTP scene Purpose: Upload (send) a file to a specified location (URL) using the FTP protocol

Note: The largest file that we recommend using for FTP testing is 80MB. If your script uses IP Trace or Radio Trace,

the limit is 30MB. The use of larger files will reduce system stability.

Properties:

Actor


Authentication

Password - type the password to supply to the remote host, to access this file. Default: blank

User - type the username to use on the host. Default: blank

Destination

DestFile - type the name to give the uploaded file. Default: blank

DestPath - type the path to upload the file to, on the host. Default: /

Server

Host - type the name or address of the host to send the file to. Default: blank

Port - type the port number to use on the host. Default: 21

Source

LocalFile - type the name of the file to upload. Default: blank

LocalPath - type the path of the file to upload, on the local system. Default: /

System


Transfer

Mode - select the server interaction mode from Active or Passive. Default: Active

Timeout - type the timeout for the transfer, in seconds or leave set to blank or 0 for no timeout. Default:

blank

TimeoutType - select the type of timeout to use. Choose Inactivity to timeout if the server does not respond

for the specified period at any time during the transfer; choose Absolute to timeout if the server does not

complete the transfer within the specified period. Default: Inactivity

TransferType - select the transfer type, from ASCII and binary. ASCII is only suitable for plain text, binary

is suitable for all data types. Default: ASCII

Routes:

OK - file has downloaded successfully

Failed to download FTP - download failed due to a service error

Failed to download FTP (system) - download failed due to a system error

Additional metrics

Additional Metrics have been added to this scene for MM9.0 to more accurately measure the download

performance:







By default, these measurements use the FTPRequestStart timing point as the start of the upload for these metrics. If

you wish, you can chose a different starting point (from the list below), by adding it to the script by using the

Internal timing point scene:

FTPServer150STOR - when the client receives the response from the FTP server saying it is willing to store

the data

FTPClientSTOR - when the client sends the request to the FTP server to store the file

FTPUploadStart - when the client starts uploading the data to the FTP Server

FTPRequestStart - when the client starts the connection to the FTP server (to send user name and password)



Download HTTP scene Purpose: Download (get) a file from a specified location (URL) using the HTTP protocol

Note: If you wish to download files larger than 80MB (or 30MB if using IP Trace or Radio Trace) or change the

input buffer size, you must use Performance Measuring Mode.

Properties:

Actor


Data

Mode - browser mode, blank (default), IMAGE, MMS or VIDEO. Default: blank

URL - type the complete URL of the file to download. Default: http://

Performance

MeasurePerformance - choose True to switch to Performance Measuring Mode (see below). Default: False

ReceiveWindow - type the size (in bytes) of the input buffer to use in Performance Measuring Mode - or

leave it set to 0 for the default size (64,000 bytes). (This property is ignored if Performance Measuring Mode

is not selected, so the default buffer size will be used.) Default: 0

Hint: You can also set the Receive Window size by using the x-ubx-test-tcp-input-buffer-size control

header. See FTP Scripting in the Advanced Scripting Guide for details.

Note: The automatic optimization mode introduced in Monitor Master 10.3.1 for the Download FTP scene

does NOT apply to Download HTTP scene.

System


Routes:

OK - file has downloaded successfully and has been stored using the specified name

Failed to download HTTP - download failed due to a service error

Failed to download HTTP (system) - download failed due to a system error

Performance measuring mode

Using earlier versions of Monitor Master (before 9.0), the largest file that you can reliably download using HTTP is

80MB (or 30MB if your script uses PCAP or L3 Trace); the use of larger files reduces system stability. In Monitor

Master 9.0 we introduced Performance Measuring Mode, to support the download of much larger data files and

allow more representative testing of high-performance data networks such as LTE.

To enable Performance Measuring Mode simply set the MeasurePerformance option to True, in the Download

HTTP scene. This has two main effects:

The content downloaded by the scene is not stored - so content analysis is very limited

The receive window (input buffer size) is set according to the scene's ReceiveWindow property, which can

be used to optimize data throughput for your network speed and latency

The absence of downloaded content means that:

the content-length records are inaccurate. For an accurate result, use

CDbl(ArgoScript.GetControlHeader("x-ubx-test-transfer-bytes-read")) in an Advanced Script scene

any attempt at content analysis will be performed on empty content



sub-content will not be fetched

Screening Room reports will report a blank indicative size for the test

However, the Record Content Metrics scene returns correct metrics for HTTP download, even in Performance

Measuring Mode.

Additional metrics

Additional Metrics have been added to this scene for MM9.0 to more accurately measure the download

performance:







Ping scene Purpose: Ping an IP address (a basic test for a device's presence) and measure the time taken to reach it

Returns metrics for packet size, latency (average ping time for successes), number of failures, and the minimum

and maximum ping time.

Properties:

Actor

Connection - select the Connection resource to use to connect to the address

Data

Address - IP address or host name to ping. Default: blank

Count - type the number of packets to send. Default: 1

PacketSize - type the size of packet (bytes) to send. Default: 32

Timeout - type the number of seconds to wait for a packet before considering it lost. Default: 5

TimeToLive - type the packet TTL parameter (number of hops allowed). Default: 30

System


Routes:

OK - device at the specified address has responded at least once within the timeout period

Failed to ping - ping failed due to a service error

Failed to ping (system) - ping failed due to a system error



Video Ping scene Purpose: Ping an RTSP address (a basic test for its availability)

Properties:

Actor

Connection - select the Connection resource to use to connect to the address

Stream

Stream Duration - type the maximum number of seconds that the ping should stream for, or 0 to send just

the video preamble. Default: 0

Stream Latency - type the maximum time (seconds) to wait between stream packets, a number between 0

and StreamDuration. 0 means just check that at least one data packet is received. Default: 0

Timeout - type the number of seconds to wait for a response. Default: 60

URL - IP address or host name to ping. Default: blank

System


Routes:

OK - device at the specified address has stream the specified number of video packets within the timeout

period

Failed to ping - ping failed due to a service error

Failed to ping (system) - ping failed due to a system error



DNS Lookup scene Purpose: Performs a DNS lookup for the specified name, converting it to the corresponding IPv4 address or IPv6

address (Type 2 Modems only), using the specified or default DNS.


Added support for IPv6 lookups to Type 2 Modems

The DNS Resolution Duration metric has changed for Type 2 Modems because of the new method used to

perform the resolution

Using this scene

To specify the type of lookup to use, your system administrator sets the Operator's PDP_TYPE to IPv4 or IPv6 or

IPv4v6 as appropriate. (Operator definitions are stored centrally by QM and can only be edited by system

administrators.)

This scene should not be placed directly after the Make data connection scene for an IPv6 connection, you need to

add a wait of 2 seconds (using the Wait scene) between the scenes to allow the data connection to be ready.

Properties:

Actor

Connection - select the Connection resource to use to connect to the DNS

Data

Address - type the host name (e.g. www.tems.com) to look up. Default: blank

DNSServer - type the IP address of the Domain Name Server to use, or leave blank to use the default DNS

for this connection. (You can specify more than one server if using a Type 2 Modem, but must use advanced

scripting to create an Argo list and then assign it to this property - see the Advanced Scripting Guide for

details.) Default: blank

System


ResolvedIPv4Addresses - select a Props resource to store the list of IPv4 addresses that the name resolved

to. Default: blank

ResolvedIPv6Addresses - select a Props resource to store the list of IPv6 addresses that the name resolved

to. Default: blank

Result - select a Prop to store the resulting IP address in it (optional). Default: blank

Routes:

OK - DNS lookup suceeded

Failed to lookup DNS record - DNS lookup failed due to a service error

Failed to lookup DNS record (system) - DNS lookup failed due to a system error

Authentication scenes Use the scenes in the Network/Authentication Group to manage access authenticated by a RADIUS server:

Set RADIUS Details

Check RADIUS Access



Set RADIUS Details scene Purpose: Set a user's RADIUS details

Properties:

Data

CalledStationId - type the phone number that the user calls, using Dialed Number Identification (DNI) or

similar technology. Note that this may be different to the number that the call arrives on

CallingStationId - type the phone number that the call comes from, using Automatic Number Identification

(ANI) or similar technology.

IP - type the IP address to configure for the user

Nasid - type a string identifying the NAS originating the accounting request

Nasip - type the IP address of the NAS requesting authentication of the user

RadiusServer - type the name or IP address of the RADIUS server

SessionId - type a unique accounting ID used to help match start and stop records in a log file

SGSNAddress3GPP - type the SGSN IP address used by the GTP control plane to handle control messages.

It may be used to identify the PLMN to which the user is attached

SharedSecret - type the secret shared by the client and RADIUS server, used to authenticate transactions

StatusType - select whether the accounting request marks the start or end of the user service. Default: Start

Timeout - type the time (in seconds) to wait before timing out the connection if no response. Default 30

Username - type the name of the user to authenticate

System


Routes:

OK - you have set your RADIUS details

Failed to set RADIUS details - you have not set your RADIUS details due to a service error

Failed to set RADIUS details (system) - you have not set your RADIUS details due to a system error

Hint: See Using RADIUS in the Advanced Scripting Guide for more information.



Check RADIUS Access scene Purpose: Check whether specified user passes RADIUS access validation

Properties:

Data

CalledStationId - type the phone number that the user called, using Dialed Number Identification (DNI) or

similar technology. Note that this may be different to the number that the call arrives on

CallingStationId - type the phone number that the call came from, using Automatic Number Identification

(ANI) or similar technology.

Nasid - type a string identifying the NAS originating the access request

Nasip - type the IP address of the NAS requesting authentication of the user

Password - type the user's password

RadiusServer - type the name or IP address of the RADIUS server

SGSNAddress3GPP - type the SGSN IP address used by the GTP control plane to handle control messages.

It may be used to identify the PLMN to which the user is attached

SharedSecret - type the secret shared by the client and RADIUS server, used to authenticate transactions

Timeout - type the time (in seconds) to wait before timing out the connection if no response. Default 30

Username - type the name of the user to check

System


Routes:

OK - this user passed access validation by the RADIUS server

Failed to check RADIUS access - this user failed access validation by the RADIUS server or RADIUS access

validation failed due to a service error

Failed to check RADIUS access (system) - RADIUS access validation failed due to a system error

Hint: See Using RADIUS in the Advanced Scripting Guide for more information.

PCAP scenes Use the scenes in the Network/PCAP Group to trace and analyze network (TCP/IP) traffic:

Examine PCAP

PCAP Start

PCAP Stop

You can use IP Trace with most GSM, CDMA and TD-SCDMA modems (Type 1 Modems) as standard. To use IP

Trace with Type 2 Modems (most LTE modems) you must purchase an additional license: IP Trace for Type 2

Modems.

Also see:

PCAP Engineer resource

PCAP Examiner resource

PCAP Manager resource

VoIP PCAP resource



Major changes in v10.3.3

Up to version 10.3.0, Monitor Master used WinPCAP for Type 1 Modem and LAN connections, which supported

WinPCAP capture filters. It used a simpler implementation for Type 2 Modems, which did not support capture

filters.

Monitor Master 10.3.0 switched to using Microsoft Network Monitor (Netmon) for all connections on 10.3.0 probes,

which did not support capture filters. (Any legacy 10.2.0 probes continue to use the first implementation.)

Monitor Master 10.3.3 added support for Netmon capture filters (in the PCAP Start scene) for all connections and

support for Wireshark display filters (in the PCAP Stop scene). (Any legacy 10.2.0 probes continue to use the first

implementation.)

PCAP timeouts

If your script starts IP Trace but does not stop it, the capture file could continue to grow until it causes problems.

To reduce the risk of this happening, IP Trace is usually configured to stop automatically after 60 minutes' capture

(capture timeout) and delete the trace file. The system administrator can however change the timeout and deletion

strategy on a per-probe basis, as described in the Installing & Managing Monitor Master Guide. This mechanism

(introduced in Monitor Master 9.0) is not used by IP Trace for Type 2 Modems.

All IP Trace operations have a timeout, usually set to 60 seconds (increased from 6 seconds in Monitor Master

v9.1). You can change the length of this Operation Timeout for a script by using an Advanced Script to set a control

header. For example, to decrease the Operation Timeout to 30 seconds:

ArgoScript.SetControlHeader "x-pcap-command-timeout-ms", 30000



Examine PCAP scene Purpose: Creates an XML analysis of captured IP Trace data (current content or specified file)

Properties:

Analysis

AnalysisFilter - select the analysis filter to apply (which events to look for): NoFilter, Retransmission,

ChecksumErrors, DuplicateAck, or Custom (to use your own custom filter). Default: NoFilter

Note: Do not use the OutOfOrder or SynFinRst filters, they won't work. To achieve the same results, set

AnalysisFilter to Custom and set CustomAnalysisFilter to:

"tcp.analysis.out_of_order" ... to display out-of-order packets

"tcp.flags.syn==1 or tcp.flags.fin==1 or tcp.flags.reset==1" ... to display Syn, Fin

and Reset events

AnalysisLevel - select Full or Summary. Default: Full

CustomAnalysisFilter - type a custom analysis filter rule for tethereal. Default: blank

CustomProtocolFilter - type a custom protocol filter rule for tethereal. Default: blank

IPAddressFilter - type an IP address or select a Prop containing an IP address to use in an IP filter. Default:

blank

MultipleFilterLogic - choose how to combine the filters i.e. whether to and them (both must apply) or to or

them (either or both must apply). Default: and

ProtocolFilter - select the protocol to assume: NoFilter, WAP1, WAP2, HTTP, PPP, RTSP or Custom (to use

your own custom filter). Default: NoFilter

Examiner

PCAPExaminer - select the PCAP Examiner resource to use to configure this scene

PCAP

PCAPFilename - leave blank to analyze the current content; type a filename to analyze that capture file.

Default: blank

System


Routes:

OK - analysis has been performed

Failed to examine PCAP - analysis failed due to a service error

Failed to examine PCAP (system) - analysis failed due to a system error



PCAP Start scene Purpose: Start capturing IP Trace data on the specified connection, so you can analyze network traffic. Supports

Type 1 Modem, Type 2 Modem and LAN connections.

Hint: To collect IP Trace data for a specific scene, use a PCAP Engineer.

Note: This scene does not support VoIP. To collect IP Trace for a VoIP Client, use the VoIP PCAP resource.

Properties:

Actor

Connection - select the Connection resource to use. Default: first data connection

Capture

Filter - leave blank to capture all packets; type Netmon followed by a space and a Netmon filter string to

perform packet capture filtering. Default: blank

Hint: See Using PCAP in the Story Boarder User Guide for more on filtering.

Note: Filtering is not recommended if you are performing high throughput data transfers.

Promiscuous - select whether to use promiscuous mode on the network interface, True or False. Default:

False

System


Routes:

OK - analysis has been performed

Failed to start PCAP (system) - capture failed due to a system error



PCAP Stop scene Purpose: Stop capturing IP Trace data and start post-processing the captured data

Note: The probe may take a significant time to finish writing the IP Trace file, after stopping capture. For example:

downloading an 80MB file to an Agent RTU-5 over an 80 Mbit/s LTE connection will take around 10 seconds, but

writing the IP Trace file to disk might take another 90 seconds.

The captured data can be examined with the help of the Examine PCAP scene

Properties:

Actor

Connection - select the Connection resource you were capturing from. Default: first data connection

Data

PCAPFileName - select the Prop to store the name of the IP Trace file in. (A unique name is generated

automatically.) Default: Nothing

PostProcessFilter - type the Wireshark display filter to apply to the trace file (e.g. ip.addr == 192.168.128.3),

or leave blank for no filter. The filtered file replaces the original trace file. Default: blank

Hint: For details of display filters, check the Wireshark documentation (available from www.wireshark.org).

ReadPCAP - choose True to store the IP Trace data in the content table. The largest file that will be stored is

5MB; larger files (usually produced by a PCAP crash) will be ignored. Default: True

Error handling

ErrorIfNotStarted - choose True to report a service error if capture did not start. Default: True

System


Routes:

OK - IP Trace capture has stopped

Failed to stop PCAP (system) - failed due to a system error

Diagnostics scenes To use the scenes and resources described in this section, you will require the appropriate Radio Trace option

installed on the Agent for the SmartModem you are using. There are three versions of Radio Trace:

Radio Trace for Type 1 Modems

Radio Trace for Type 2 Modems

TRP Trace

See Using Radio Trace in the Story Boarder User Guide for more information on using Radio Trace.

Radio Trace for Type 1 Modems and Radio Trace for Type 2 Modems

These versions of Radio Trace are very similar and supported by a wide range of modems - see the modem's SPD

to check for support. They use the following scenes:

Resources - Diagnostics Writer and Diagnostics Reader

Diagnostics Trace Start

Diagnostics Trace Stop

Diagnostics Trace Reporter



Diagnostics Trace Available

The flow of diagnostics data from modem to Monitor Master, and the control you have over it can be summarized

thus:

These scenes create four temporary files:

QC Trace File - the raw diagnostics information read from the modem (created by the Diagnostics Trace

Start scene)

QMD Trace File - the raw diagnostics converted to a more convenient format for analysis (created by the

Diagnostics Trace Stop scene). Also known as an MDF File

Decode Log File - a record of the conversion process, for debugging purposes (created by the Diagnostics

Trace Stop scene)

Report XML File - the filtered diagnostics, one record for each, in XML (created by the Diagnostics Trace

Reporter scene)

All these files are deleted when the script ends. If you want to preserve the data for later use, the script should

copy the files to another location before it ends (e.g. by using the Upload File to Projector scene). For example the

QMD Trace (MDF) File can be analysed using other tools, such as TEMS Discovery.

TRP Trace

TRP Trace is currently only supported by the Ericsson F3607 SmartModem. It supports:

Resources - Diagnostics Writer and Diagnostics Reader

Diagnostics Trace Start

Diagnostics Trace Stop

Diagnostics Trace Available

The Diagnostics Trace Start scene creates a TRP for trace file which is closed by the Diagnostics Trace Stop scene.

The TRP Trace file can then be exported for external analysis (using, for example, TEMS Discovery). See Using the

F3607 Modem in the Story Boarder User Guide for more information.



resources: Diagnostics Writer resource Purpose: Defines the hardware to read Radio Trace diagnostic data from and provides services to the Diagnostics

scenes

Properties:

Configuration

Hardware - select the Hardware resource (SmartModem) to read diagnostic data from



resources: Diagnostics Reader resource Purpose: Provides services to the Diagnostics scenes

Properties:

This resource has no properties



Diagnostics Trace Start scene Purpose: To start a Radio Trace. This reads raw diagnostic data from the modem being used and stores it in a

temporary file.

Diagnostic data will be captured for subsequent scenes until either a Diagnostics Trace Stop scene is executed, or

the script (party) ends.

Note: The CDMA1X, GSM, UMTS and WCDMA options only apply to Type 1 Modems.

Properties:

Data

CDMA1X - choose True to log CDMA 1x and 1xEV diagnostics; choose False to ignore them. Default: False

GSM - choose True to log GSM trace diagnostics; choose False to ignore them. Default: True

UMTS - choose True to log UMTS trace diagnostics; choose False to ignore them. Default: True

WCDMA - choose True to log WCDMA trace diagnostics; choose False to ignore them. Default: True

System


Trace

DiagnosticsWriter - select the Diagnostics Writer resource to use.

Routes:

OK - you have started tracing the specified Radio Trace diagnostics

Failed to start trace route - you have not started the Radio Trace due to a service error

Failed to start trace route (system) - you have not started the Radio Trace due to a system error



Diagnostics Trace Stop scene Purpose: To stop a Radio Trace (started using the Diagnostics Trace Start scene).

For modems that produce QMD Trace (Radio Trace for Type 1 Modems and Radio Trace for Type 2 Modems), this

converts the raw diagnostics data in the QC Trace File into a QMD Trace File (also known as an MDF file).

For modems that produces TRP Trace (such as the F3607 modem), this closes the TRP Trace file - the scene

properties are used as described below.

QMD Trace

Properties:

File

DecodeLogFileName - select the Prop to store the Decode Log file's name in, or Nothing if you don't need

access. Default: Nothing

RawCaptureFileName - select the Prop to store the QC Trace file's name in, or Nothing if you don't need


TraceFileName - select the Prop to store the QMD Trace file's name in, or Nothing if you don't need access.

Default: Nothing

System


Trace


Routes:

OK - you have stopped the Radio Trace

Failed to stop trace -you have not stopped the Radio Trace due to a service error

Failed to stop trace (system) - you have not stopped the Radio Trace due to a system error

TRP Trace

Properties:

File

DecodeLogFileName - ignored. Default: Nothing

RawCaptureFileName - ignored. Default: Nothing

TraceFileName - select the Prop to store the TRP Trace file's name in. The filename is based on the probe

name, testrun id and datestamp to ensure uniqueness. Default: Nothing

System


Trace


Routes:

OK - you have stopped the Radio Trace

Failed to stop trace - you have not stopped the Radio Trace due to a service error



Failed to stop trace (system) - you have not stopped the Radio Trace due to a system error



Diagnostics Trace Reporter scene Purpose: To filter the QMD file created by the Diagnostics Trace Stop scene to choose the records of interest, create

the Report XML file, and then report each record as a Metric.

Note: The script can also post-process the Report XML file to extract other information. This file will be deleted

when the script ends, so if you want to access it later, the script must make a copy.

Note: This scene does not support the TRP format trace file created for a F3607 modem; it will report a system error

(with the message Diagnostic: Trace file format is not supported) if used with it.

Properties:

Data

ReportFilter - click the field, then click its button to view or edit the filters selected:

By default, only the GPRS Attachment Marker, GPRS PDP Context Marker and GSM Layer 3 Info are

included in the report.

Tick a checkbox to include that record type; clear a checkbox to remove it. Click OK to save the changes.

File

TraceFileName - select the Prop containing the name of the trace file to analyze, or Nothing if you don't

need access. Default: Nothing

ReportXMLFileName - select the Prop to store the XML Report filename in or Nothing if you don't need


Metrics

ReportMetrics - select whether to report metrics for each filtered trace record, True or False. Default: True

System


Note: Add a subroutine called ApplyUserFilter to the Engineer and it will be executed after the Report

Filter and output of the Report XML file. As its name implies, this subroutine can be used to apply an

additional User Filter to the diagnostics data, to reduce the number of metrics reported - see Using Radio

Trace Diagnostics in the Story Boarder User Guide for more information.

Trace

DiagnosticsReader - select the Diagnostics Reader resource to use.

Routes:

OK - you have reported on the Radio Trace



Failed to report trace - you have not reported on the Radio Trace due to a service error

Failed to report trace (system) - you have not reported on the Radio Trace due to a system error



Diagnostics Trace Available scene Purpose: To check that you are fully licensed and able to use the Radio Trace option. You can also (optionally)

check if the Trace has started.

Note: This scene checks that a Radio Trace license is installed on the probe. It does NOT check whether that license

covers the specific modem that the script is using. Radio Trace can be licensed per modem or per probe, and is

licensed separately for Type 1 Modems and Type 2 Modems. It is up to the customer to make sure that their

intended use complies with their licensing arrangements.

Properties:

System


Trace

CheckIfStarted - whether to check if the trace has started, True or False. Default: False


Routes:

OK - you can use Radio Trace, and (if CheckIfStarted=True) it has started

Trace not available (not licensed) - you cannot use Radio Trace; you have not got a license installed on the

Probe

Trace not available (no terminal capability) - you cannot use Radio Trace with this modem; use a

supported modem

Trace not available (not started) - Radio Trace has not started; use Diagnostics Trace Start to start it

Failed to check trace availability - you have not checked Radio Trace availability due to a service error

Failed to check trace availability (system) - you have not checked Radio Trace availability due to a system

error

When starting a trace, connect the OK and not started paths to the Diagnostics Trace Start scene; the other paths

should bypass the start scene.

When stopping a trace, connect the OK path to the Diagnostics Trace Stop scene; the other paths should bypass the

stop scene.


Chapter 13 - Supplementary Services scenes

Use the scenes from the Supplementary Services Group to test supplementary services:

Call Barring

Call Forwarding Service

CLIR

CLIP

Deprecated scenes



Call Barring scene Purpose: To enable or disable call barring

Properties:

Modem


Service

BarringPassword - type the password required to access this service. Default: blank

BearerService - select the bearer service to bar: All Services, Voice, Fax, SMS, All data, ASync data, Sync

data, PAD, Packet, All Sync, All Async, or All Bearer. Default: All Services

Operation - select Activate to bar the selected service, or Deactivate to cancel barring. Default: Activate

Service - select the service to bar: All Outgoing Calls, Outgoing International Calls, International Calls

(except to Home Country), All Incoming Calls, or Incoming Calls when Roaming. Default: All Outgoing

Calls

System


Routes:

OK - call barring set up (success)

Failed to set barring service - failed due to service error

Failed to set barring service (system) - failed due to system error



Call Forwarding Service scene Purpose: To control the Call Forwarding Service for GSM. This scene replaces the deprecated Call Forwarding

scene.

This scene enables call forwarding for a single reason; to enable call forwarding for n reasons, you will need n Call

Forwarding Service scenes.

Hint: On a CDMA network, use the CDMA Enable Call Forwarding scene (see Chapter 21, The CDMA Group).

Properties:

BearerClass

Data - select True to forward all Data services. Default: False

DataCircuitAsync - select True to forward this service. Default: False

DataCircuitSync - select True to forward this service. Default: False

DedicatedPacketAccess - select True to forward this service. Default: False

DedicatedPADAccess - select True to forward this service. Default: False

Fax - select True to forward this service. Default: False

SMS - select True to forward this service. Default: False

Voice - select True to forward all Voice services. Default: True

Modem


Service

Forward To - select the User resource that specifies the number to forward to. Note that this must specify

the APN in international format, beginning with a +. Default: the ForwardTo resource

Mode - select the forwarding service function to use. Default: Enable

Enable - enable call forwarding for the specified Reason and APN

Disable - disable call forwarding for the specified Reason

Query Status - check the status of call forwarding for the specified Reason

Register - register call forwarding for the specified Reason and APN

Unregister - unregister call forwarding for the specified Reason and APN

Reason - choose the condition the function applies to: Unconditional, Mobile Busy, No Reply, Not

Reachable, All Call Forwarding, All Conditional Call Forwarding. Default: Unconditional

Timeout - type the time to wait (seconds) before forwarding, in the No Reply mode. Default: 0

System


Routes:

OK - call forwarding set up (success)

Failed to set call forwarding service - failed due to service error

Failed to set call forwarding service (system) - failed due to system error



CLIR scene Purpose: To control Calling Line Identification Restriction

Properties:

Modem


Service

Operation - select the operation to perform on the service: Default, Activate, or Deactivate. Default:

Default

System


Routes:

OK - CLIR changed (success)

Failed to set CLIR - failed due to service error

Failed to set CLIR (system) - failed due to system error



CLIP scene Purpose: To control Calling Line Identification Presentation

Properties:

Modem


Service

Operation - select the operation to perform on the service: Activate, or Deactivate. Default: Activate

System


Routes:

OK - CLIP changed (success)

Failed to set CLIP - failed due to service error

Failed to set CLIR (system) - failed due to system error

Supplementary Services: Deprecated scenes These scenes are deprecated and should not be used:

Call Forwarding



Call Forwarding scene Note: This scene is deprecated and should not be used.

Purpose: To control Call Forwarding on a GSM network. This scene is deprecated. Use the Call Forwarding

Service scene instead.

Hint: On a CDMA network, use the CDMA Enable Call Forwarding scene (see Chapter 21, The CDMA Group).

Properties:

Modem


Service

BearerService - select the bearer service to forward: All Services, Voice, Fax, SMS, All data, ASync data,

Sync data, PAD, Packet, All Sync, All Async, or All Bearer. Default: All Services

Forward To - select the User resource to forward to. Note that the APN must be in international format,

beginning with a +.

Operation - select Activate to forward the selected service, or Deactivate to cancel forwarding. Default:

Activate

Service - select which service to apply: On Not Reachable, On Busy, or On No Reply. Default: On Not

Reachable

Timeout - type the time to wait (seconds) before forwarding, in On No Reply mode. Default: 0

System


Routes:

OK - call forwarding set up (success)

Failed to set call forwarding - failed due to service error

Failed to set call forwarding (system) - failed due to system error


Chapter 14 - Messaging scenes

Use the scenes in the Messaging Group to test Email, SMS, MMS, Instant Messaging and Visual Voicemail

services::

Email: POP3 scenes

Email: SMTP scenes

Email: IMAP scenes

Email: Security scenes

SMS scenes

MMS scenes

Instant Messaging: OMA IMPS scenes

Email Scenes: POP3 Use the scenes in the Messaging/Email/POP3 Group to receive emails from and manage emails on a POP3 server:

Receive Email

Clear POP3 Mailbox

Disconnect POP3



Receive Email scene Purpose: Fetch the oldest email message from a user's Inbox and return it as the current content

Hint: To fetch a specific email, use the List all IMAP emails and Receive IMAP email scenes.

Properties:

Actor


Data

Content - select the Prop resource to store the message in

DeleteEmail - whether to delete the fetched message from the mailbox, True or False. Default: True

SleepTime -

Timeout - type how long (seconds) to wait for a message, or 0 to return immediately if none is found.

Default: 0

System


Users

Recipient - select the User resource to receive the email from

Routes:

OK - an email has been received

Failed to receive email - an email has not been received, due to a service error (e.g. mailbox empty)

Failed to receive email (system) - an email has not been received, due to a system error



Clear POP3 Mailbox scene Purpose: Delete all messages from a user's POP3 mailbox - similar to the IMAP, SMS and MMS scenes.

Properties:

Actor

Connection - select the Connection resource to use (POP3 account to clear)

System


Users

Recipient - select the User resource to use

Routes:

OK - mailbox has been emptied (or was already empty)

Failed to clear mailbox - due to a service error

Failed to clear mailbox (system) - due to a system error



Disconnect POP3 scene Purpose: Disconnect from a POP3 server - similar to the IMAP and SMTP scenes.

Properties:

Actor


Email Account

EmailAccount - select the User resource to use (POP3 account to disconnect)

System


Routes:

OK - POP3 connection has been disconnected

Failed to disconnect POP3 session - due to a service error

Failed to disconnect POP3 session (system) - due to a system error

Email Scenes: SMTP Use the scenes in the Messaging/Email/SMTP Group to send emails and manage the connection to an SMTP

server:

Send Email

Disconnect SMTP



Send Email scene Purpose: Send an email message using SMTP

Note: This scenes reads the sender email address and SMTP server name from the specified Sender resource. If the

SMTP Server supports SMTP Authentication, you should also set the Sender's SMTPPassword and

SMTPUsername properties.

Properties:

Actor


Email Data

Attachment - type the pathname of a file to attach. Default: blank

Message - type the text to send in the body of the email. Default: blank

Subject - type the text to put on the email subject (title) line. Default: blank

System


Users

Recipient - select the User resource to send the email to

Sender - select the User resource to send the email from

Routes:

OK - email has been sent

Failed to send email - email has not been sent due to a service error

Failed to send email (system) - email has not been sent due to a system error



Disconnect SMTP scene Purpose: Disconnect from an SMTP server - similar to the IMAP and POP3 scenes.

Properties:

Actor


Email Account

EmailAccount - select the User resource to use (SMTP account to disconnect)

System


Routes:

OK - SMTP connection has been disconnected

Failed to disconnect SMTP session - due to a service error

Failed to disconnect SMTP session (system) - due to a system error

Email Scenes: IMAP Use the scenes in the Messaging/Email/IMAP Group to receive and manage emails on an IMAP server:

List Available IMAP Mailboxes

Count all IMAP Emails

List all IMAP Emails

Receive IMAP Email

Delete all IMAP Emails

Disconnect IMAP



List Available IMAP Mailboxes scene Purpose: List all mailboxes available on a given IMAP account

Properties:

Actor


Email Account

EmailAccount - select the Email Account to check. Default: blank

System


Routes:

OK - mailboxes listed

Failed to IMAP mailbox list - failed due to a service error

Failed to IMAP mailbox list (system) - failed due to a system error



Count all IMAP Emails scene Purpose: Count all emails in a given mailbox

Properties:

Actor


Email Account

EmailAccount - select the Email Account to use.

IMAP Actions

Mailbox - type the name of the mailbox to check. Default: INBOX

System


Routes:

OK - emails counted

Failed to IMAP count email - failed due to a service error

Failed to IMAP count email (system) - failed due to a system error



List all IMAP Emails scene Purpose: List details of all emails in a given mailbox

Properties:

Actor


Email Account

EmailAccount - select the Email Account to use.

IMAP Actions


System


Routes:

OK - emails listed

Failed to IMAP list email - failed due to a service error

Failed to IMAP list email (system) - failed due to a system error



Receive IMAP Email scene Purpose: Receive and optionally delete an email specified by its ID

Hint: Use the List all IMAP emails scene to get Message IDs and other details.

Message IDs are serial numbers (1, 2, 3 … n) with 1 being the oldest message in the mailbox and n the newest. If a

message is deleted, the ID of all later messages changes to fill the gap. For example, if you delete message #2, then

message #3 becomes message #2, message #4 becomes #3 and so on.

Properties:

Actor


Email Account

EmailAccount - select the Email Account to use

IMAP Actions

Delete Message - whether to delete the specified message after fetching it, True or False. default: False


MessageID - type the ID of the message to fetch. Default: 1

IMAP Waiting

Timeout - type the number of seconds to wait for the message. Default: 30

WaitType - select how to wait for a message:

Select RecentMessage (default) to poll the server until there is a message with specified id and

marked as "recent" to return

Select AnyMessage to poll the server until there is a message with the specified id and return it -

whether or not it is marked as "recent". (This supports services such as Gmail, that don't mark new

messages as "recent")

Idle is not currently supported

System


Routes:

OK - email received

Failed to IMAP receive email - failed due to a service error

Failed to IMAP receive email (system) - failed due to a system error



Delete all IMAP Emails scene Purpose: Delete all emails from a specified mailbox

Properties:

Actor


Email Account

EmailAccount - select the Email Account to use

IMAP Actions

Mailbox - type the name of the mailbox to clear. Default: blank

System


Routes:

OK - emails deleted

Failed to IMAP delete MailBox - failed due to a service error

Failed to IMAP delete MailBox (system) - failed due to a system error



Disconnect IMAP scene Purpose: Disconnect from an IMAP server - similar to the POP3 and SMTP scenes.

Properties:

Actor


Email Account

EmailAccount - select the User resource to use (IMAP account to disconnect)

System


Routes:

OK - POP3 connection has been disconnected

Failed to disconnect IMAP session - due to a service error

Failed to disconnect IMAP session (system) - due to a system error

Email Scenes: Security Use the scenes in the Messaging/Email/Security Group to control user email security:

Make Email Secure



Make Email Secure scene Purpose: Enable security for a specified user's email.

This scene should be used before attempting access to the secure server. The security must be configured correctly

in the specified User resource properies.

Properties:

Actor


System


Users

User - select the User resource to use (to enable security for)

Routes:

OK - user email has been secured

SMS scenes Use the scenes in the Messaging/SMS Group to send and receive SMS messages:

Clear SMS Inbox

Receive SMS

Receive SMS Notification

Send SMS

Send and Receive SMS (P2A2P)

Send and Receive SMS (P2P)

Send and Receive SMS (P2OP)



Clear SMS Inbox scene Purpose: Remove all messages from the SMS inbox - including any MMS notifications. You can choose which

Inbox to clear: modem, SIM, or SIM and modem

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the service

Data

MessageStore - which Inbox to clear: ME (modem), SM (SIM), or MT (modem and SIM) or blank (same as

ME ;i.e. modem only). Default: blank

Note: This option is not supported for Type 2 Modems.

System


Routes:

OK - specified inbox has been cleared

Failed to clear SMS inbox (system) - specified inbox has not been cleared, due to a system error



Receive SMS scene Purpose: Returns a matching SMS message from the Inbox, for Type 1 Modems. Deprecated for Type 2 Modems -

use the Receive SMS Notification scene instead.

This scene is similar to the Receive SMS Notification scene:

The Receive SMS scene checks the Inbox and returns a matching message if there is one, deleting it from the

Inbox. If there is more than one matching message it returns (and deletes) the oldest one. If there isn't a

matching message in the Inbox it polls the modem waiting for a matching message to arrive, up to the

specified timeout period.

The Receive SMS Notification scene waits for the modem to notify receipt of a new matching SMS message

and then returns it.

The Receive SMS scene supports receipt of multi-part messages; the Receive SMS Notification scene does

not.

The Receive SMS scene is deprecated for Type 2 Modems

Use with Type 2 Modems

There are issues with Type 2 Modems, so this scene is deprecated - use the Receive SMS Notification scene instead.

Properties marked with *** are ignored for Type 2 Modems such as the SW7700, SW7710 and VL600; the default

values are used for these modems.

This scene ignores the Inbox when used with Type 2 Modems; it can only receive an SMS from the network. This

means it can only receive a new message - not one that has already been received by the modem.

Properties:

Actor

Device - select the Device resource to use

Hardware - select the Hardware resource (terminal) that connects to the modem

Data

FilterBody - type a regular expression to look for messages with this specific content. Default: blank. For

example:

Test Message will match messages with the content "Test Message"

Test Message [0-9]{1,3} will match messages with the content "Test Message" followed by a space and

between 1 and 3 digits.


expression syntax.

FilterSender*** - type a number to look for messages from this phone number. Default: blank

FilterSMSC*** - look for messages from this SMSC. Default: blank

Timeout - type how long (in seconds) to wait for a matching message. Default: 30

System


Routes:

OK - a matching message has been received




Failed to receive SMS - a matching message has not been received within the timeout period, due to a

service error

Failed to receive SMS (system) - a matching message has not been received within the timeout period, due

to a system error



Receive SMS Notification scene Purpose: Waits for the arrival of a new matching SMS message, ignoring any messages already in the Inbox.

This scene is similar to the Receive SMS scene:

The Receive SMS Notification scene waits for the modem to notify receipt of a new matching SMS message

and then returns it - or times out if a matching message is not received. It does not look in the Inbox for

messages that have already been received.

The Receive SMS scene checks the Inbox and returns a matching message if there is one, deleting it from the

Inbox. If there is more than one matching message it returns (and deletes) the oldest one. If there isn't a

matching message in the Inbox it polls the modem waiting for a matching message to arrive, up to the

specified timeout period.

The Receive SMS scene supports receipt of multi-part messages; the Receive SMS Notification scene does

not.

The Receive SMS scene is deprecated for Type 2 Modems

Note: Properties marked with *** are ignored for Type 2 Modems such as the SW7700, SW7710 and VL600 LTE

modems; default values are used for these modems.

Properties:

Actor


Hardware - select the modem resource

Data


example:





expression syntax.

FilterSender*** - type a number to look for messages from this phone number

FilterSMSC*** - look for messages from this SMSC


System


Routes:


Failed to receive SMS notification - a matching message has not been received within the timeout period,

due to a service error

Failed to receive SMS notification (system) - a matching message has not been received within the timeout

period, due to a system error




Improved Metrics

For MM8.5, two new timing points were added to this scene, which can be used to produce more accurate results:

SMS Receive Notification Wait Start

SMS Receive Notification URC End

SMS Receive Notification Wait Start

This timing point should be used instead of the SMS Start timing point for this scene, which is calculated

incorrectly. (The new timing point is equivalent to the new FetchStart timing point for the

ArgoScript.DoSMSService function.)

SMS Receive Notification URC End

This timing point should be used instead of the SMSEnd, SMSResponseEnd or ResponseTime Metrics as they are

not accurate, because they include some post-processing steps. The new timing point is recorded when the URC

(Unsolicited Response Code) is received from the modem. It (The new timing point is equivalent to the new SMS

URC ResponseTime timing point for the ArgoScript.DoSMSService function.)



Send SMS scene Purpose: Send an SMS message

Note: Properties marked with *** are ignored for Type 2 Modems such as the SW7700, SW7710 and VL600 LTE

modems; default values are used for these modems.

Properties:

Actor


Hardware - select the Hardware resource (terminal) to use to send the SMS . Optional. Default: Nothing

Operator - select the Operator resource to use. Optional. Default: Nothing

Data

Alphabet*** - select from 7Bit, 8Bit, and UCS2. Default: 7Bit

Content - type the message to send. Default: blank

MessageClass*** - select the message class. 0 is as a message to display but not store; 1 is ME-specific but

typically interpreted as a message to display and then store in the Inbox; 2 is SIM-specific but typically

interpreted as a message to display and then store in Saved Items; 3 is TE-specific but typically interpreted

as a message to store in the Inbox without displaying it. Default: 1

SMSC - type the phone number of an SMSC to use it instead of the default SMSC. Default: blank

StatusReport*** - set to True to request a status report (delivery report). Default: False

StatusReportTimeout*** - the maximum time to wait (seconds) for a status report. Default: 0

SubmitTimeout - type the time to wait (seconds) for submission to be acknowledged before timing out and

reporting a service error. Default: 20

ValidityPeriod*** - type the TP-VP validity period, p, a number in the range 0..255 interpreted as below.

Default: 170 (4 days)p = 0..143: period is 5*(p+1) minutes

p = 144..167: period is 12+0.5*(p-143) hours

p = 168..196: period is p-166 days

p = 197..255: period is p-192 weeks

System


Users

Recipient - select the User resource to send the SMS to

Routes:

OK - SMS message has been sent

Failed to send SMS - SMS message has not been sent, due to a service error

Failed to send SMS (system) - SMS message has not been sent, due to a system error



Send and Receive SMS (P2A2P) scene Purpose: Send an SMS message to an application and receive the reply as the same User

Note:

1. This scene provides accurate timings, so can be used for monitoring, but it does not support multipart SMS.

2. This scene requires access to two modems - but QM assigns one modem per party; the second modem must

be managed manually. Or use the scene in Local Mode - and manage both modems manually

3. This scene does not support Type 2 Modems.

Properties:

Actor

Device - select the Device resource to send and receive the SMS

Hardware - select the Hardware resource (terminal) to send and receive the SMS from. Optional. Default:

Nothing


Data

Alphabet - select the data coding to use for text: 7Bit, 8Bit, UCS2. Default: 7Bit



example:





expression syntax.

FilterSender - type a number to look for messages from this number. Default: blank

FilterSMSC - look for messages from this SMSC. Default: blank

MessageClass - select the message class. 0 is as a message to display but not store; 1 is ME-specific but





StatusReport - set to True to request a status report. Default: False

StatusReportTimeout - the maximum time to wait (seconds) for a status report. Default: 0




ValidityPeriod - type the TP-VP validity period, p, a number in the range 0..255 interpreted as below.

Default: 170 (4 days)p= 0..143: period is 5*(p+1) minutes

p=144..167: period is 12+0.5*(p-143) hours




p=168..196: period is p-166 days

p=197..255: period is p-192 weeks

System


Users

Recipient - select the User resource to send the SMS to

Routes:

OK - SMS message has been sent and received

Failed to send and receive SMS (P2A2P) - SMS message has not been sent, or has not been received, due to

a service error

Failed to send and receive SMS (P2A2P) (system) - SMS message has not been sent, or has not been

received, due to a system error



Send and Receive SMS (P2P) scene Purpose: Send an SMS message and receive it as another User

Notes:

1. This scene supports multi-part SMS but the timings may be somewhat misleading. It is suitable for

functional testing but not for monitoring or performance testing.

2. This scene requires access to two modems, but QM assigns one modem per party; the second modem must

be managed manually. Or use the scene in Local Mode and manage both modems manually


Properties:

Actor



RXHardware - select the Hardware resource (terminal) to receive the SMS

TXHardware - select the Hardware resource (terminal) to send the SMS

Data




example:





expression syntax.


FilterSMSC - type the phone number of an SMSC to look for messages from this SMSC. Default: blank









Timeout - how long (in seconds) to wait for a matching message. Default: 30


Default: 170 (4 days)p = 0..143: period is 5*(p+1) minutes

p = 144..167: period is 12+0.5*(p-143) hours




p = 168..196: period is p-166 days

p = 197..255: period is p-192 weeks

System


Users

Recipient - select the User resource to send the message to

Routes:


Failed to send and receive SMS (P2P) - SMS message has not been sent, or has not been received, due to a

service error

Failed to send and receive SMS (P2P) (system) - SMS message has not been sent, or has not been received,

due to a system error



Send and Receive SMS (P2OP) scene Purpose: Send an SMS message and receive it as another User

Notes:

1. This scene provides accurate timings, so it can be used for monitoring, but it does not support multipart

SMS.

2. This scene requires access to two modems - but QM assigns one modem per party; the second modem must

be managed manually. Or use the scene in Local Mode and manage both modems manually.


Properties:

Actor



RXHardware - select the Hardware resource (terminal) to receive the SMS

TXHardware - select the Hardware resource (terminal) to send the SMS

Notice that this scene is intended for use with two modems.

Data




example:





expression syntax.


FilterSMSC - look for messages from this SMSC. Default: blank







StatusReportTimeout - the maximum time to wait (seconds) for a status report. Default: 0








Default: 170 (4 days)p= 0..143: period is 5*(p+1) minutes

p=144..167: period is 12+0.5*(p-143) hours

p=168..196: period is p-166 days

p=197..255: period is p-192 weeks

System


Users


Routes:


Failed to send and receive SMS (P2OP) - SMS message has not been sent, or has not been received, due to a

service error

Failed to send and receive SMS (P2OP) (system) - SMS message has not been sent, or has not been

received, due to a system error

MMS scenes Use the scenes in the Messaging/MMS Group to send and receive MMS messages:

Clear MMS Inbox

Clear MMS Local Inbox

Send MMS

Receive MMS

Receive MMS Notification

Receive MMS Delivery Report

Download MMS



Clear MMS Inbox scene Purpose: Remove all messages from a specified MMS inbox, by downloading all the MMS notifications from the

Operator and discarding them.

It does NOT clear the local (phone/modem) Inbox. If you want to do that, use the Clear local MMS inbox scene.

Properties:

Actor

Connection - select the Connection that connects to the inbox to clear

System


Routes:

OK - specified inbox has been cleared

Failed to clear MMS inbox - specified inbox has not been cleared, due to a service error

Failed to clear MMS inbox (system) - specified inbox has not been cleared, due to a system error



Clear MMS Local Inbox scene Purpose: Remove all MMS notifications from the phone/modem MMS inbox - including any SMS messages.

This may leave MMS content stranded on the MMSC.

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the Inbox to clear

System


Routes:

OK - specified local inbox has been cleared

Failed to clear MMS inbox (system) - specified local inbox has not been cleared, due to a system error



Send MMS scene Purpose: Send an MMS message

Properties:

Accounts

Destination - select the recipient's address type, Number or Email. Default: Number

Actor


Data

MMSFile - type the pathname of the file to send as content, e.g. c:\pictures\a.jpg

RequestDeliveryReport - whether to request a delivery report from the recipient, to confirm that they've

received the content. Default: No

Note: This option is not supported for Type 2 Modems.

Subject - type the subject (title) for the message. Note that the subject text is used to identify messages when

using the Receive MMS scene. Default: blank

System


Users

Recipient - select the User resource to send it to

Routes:

OK - MMS message has been sent

Failure - MMS message has not been sent, due to a service error

Failed to execute - a system error



Receive MMS scene Purpose: Receive an MMS message (receive an MMS Notification Message and then use the information it

provides to download the MMS)

This scene combines the functions of the Receive MMS Notification scene and the Download MMS scene.

1. It checks the SMS Inbox for notifications.

2. If it finds one it uses it;

3. If it finds more than one it uses the oldest;

4. If it finds none it keeps checking the network until a notification is received or the timeout expires

5. Once it has a notification it uses the information that contains to download the content from the MMSC

Note: This scene is not supported for Type 2 Modems - use the Receive MMS Notification and Download MMS

scenes.

Properties:

Actor


Data

AllowDeliveryReport - choose whether to allow delivery report to be sent to sender. Default: No

Content - select the Content resource to store the received content

MaxDeliveryTime - how long (in seconds) to wait for a matching message. Default: 1200

SubjectFilter - optionally type a text filter to match against the message subject. Default: blank

System


Routes:


Failure (Notify) - a matching notification message has not been received within the timeout period, due to a

service error

Failure (Download) - a matching data message has not been received within the timeout period, due to a

service error

Failed to execute - system error



Receive MMS Notification scene Purpose: Returns an MMS Notification (which indicates that an MMS message is available on the MMSC) from the

SMS Inbox if there is one. If there isn't one in the Inbox, it waits for an MMS Notification to arrive over the

network, then places it in the local SMS Inbox and returns it.

Note: For Type 2 Modems, this scene ignores the Inbox - it can only receive an MMS Notification from the network.

This means it can only receive a new notification - not one that has been received already.

(An MMS Notification is a special type of SMS message.)

Properties:

Data



MaxDeliveryTime - type how long (in seconds) to wait for a notification. Default: 1200 (20 minutes)


System


Routes:

OK - an MMS notification has been received

Failure (Notify) - a matching notification message has not been received within the timeout period, due to a

service error




Receive MMS Delivery Report scene Purpose: Wait for arrival of an MMS delivery report (if requested by a previous Send MMS scene, and supported

by the MMSC)

Note: This scene is not supported for Type 2 Modems.

Properties:

Actor


Data

MaxDeliveryTime - type how long (in seconds) to wait for the MMS delivery report. Default: 1200 (20

minutes)

System


Routes:

OK - an MMS delivery report has been received

Failure - a delivery report has not been received within the timeout period, due to a service error




Download MMS scene Purpose: To download an MMS by transaction ID

Properties:

Actor


Data

AllowDeliveryReport - choose Yes to allow the sending of a delivery report to the sender. Default: No

mmsLocation - type the location of the MMSC from which to download the MMS. Default: blank

mmsTransactionId - type the transaction ID of the MMS to download. Default: blank

Output

Content - select the Content resource to output the MMS to

System


Routes:

OK - MMS download has succeeded, MMS is stored in the specified Content resource

Failed to download MMS - MMS download has failed due to a service error

Failed to download MMS (system) - MMS download has failed due to a system error

Instant Messaging: OMA IMPS scenes Use the scenes in the Messaging/Instant Messaging/OMA IMPS Group to test instant messaging with this service:

Login to IM Service

Logout from IM Service

Send Instant Message

Receive Instant Message

Set IM Presence

Get IM Presence

OMA is the Open Mobile Alliance. IMPS is the Instant Messaging and Presencing System. This service is also

known as the Wireless Village Instant Messaging service



Login to IM Service scene Purpose: Login to instant messaging service

Properties:

Connection

ClientID - id uniquely identifying this user (see notes below). Default: WV://SEMC/NC/1.0


KeepAlive - leave blank unless you have a Keep Alive Time from an SMS Login (see notes below). Default:

blank

SessionID - leave blank unless you have a Session ID from an SMS Login (see notes below). Default: blank

System


Users

WVUser - select the User resource to use (to login to)

Routes:

OK - you have logged in to the IM Account

Failed to make IM connection - you have not logged in to the IM Account due to a service error

Failed to make IM connection (system) - you have not logged in to the IM Account due to a system error

Notes:

The KeepAlive and SessionID fields should be left blank unless the OMA IMPS service uses SMS, in which

case the SMS returned by the host during login will include the Keep Alive and Session ID values to use.

(For details, see WV-026 Client-Server Protocol SMS Binding Version 1.1, available from

www.openmobilealliance.org.)

The ClientID can be left to default unless the Operator tells you otherwise



Logout from IM Service scene Purpose: Logout from instant messaging service

Properties:

Connection


System


Routes:

OK - you have logged out from the IM Account

Failed to drop IM connection - you have not logged out from the IM Account, due to a service error

Failed to drop IM connection (system) - you have not logged out from the IM Account, due to a system

error



Send Instant Message scene Purpose: Send an instant message (IM) to a buddy

Data

Message - type the message text to send. Default: blank

System


Users


Routes:

OK - you have sent the message

Failed to send instant message - you have not sent the message due to a service error

Failed to send instant message (system) - you have not sent the message due to a system error



Receive Instant Message scene Purpose: Wait for arrival of an instant message from a specified buddy

Properties:

Data

Timeout - type how long (seconds) to wait for the message. Default: 30

System


Users

Sender - select the User resource to receive a message from

Routes:

OK - a message has been received from the specified user

Failed to receive instant message - a message has not been received from the specified user within the

timeout period, due to a service error (e.g. there was no message)

Failed to receive instant message (system) - a message has not been received from the specified user within

the timeout period, due to a system error



Set IM Presence scene Purpose: Set the IM presence information for the current IM login, so that other users know if you're ready for

instant messaging on this service

Properties:

Data

User Availability - choose from:

AVAILABLE

NOT_AVAILABLE

DISCREET

User Status - type additional text to describe the user's status to others. Default: blank

System


Routes:

OK - you have set your IM presence information

Failed to set IM presence - you have not set your IM presence information (service error)

Failed to set IM presence (system) - you have not set your IM presence information (system error)



Get IM Presence scene Purpose: Get presence information for a specified user, to check if they are present (logged in) and ready for

instant messaging on this service

Properties:

System


Users

WVUser - select the User resource to get presence information for

Routes:

Online Available - user is online and available for messaging

Online Not Available - user is online but not available for messaging

Online Discreet - user is online but has "discreet" availability

Offline - user is offline (not logged in)

Failed to get IM presence information - you have not got the IM presence information, due to a service

error

Failed to get IM presence information (system) - you have not got the IM presence information, due to a

system error


Chapter 15 - Browser scenes

Use the scenes in the Browser Group to browse WAP (Mobile) and Web (Internet) sites:

WAP/Web scenes - for browsing WAP and Web services and sites with the legacy Monitor Master Browser

or our new WebBrowser (but see note below)

IE scenes - for browsing WAP and Web services and sites with Internet Explorer

STK scenes - using the SIM Tool Kit

WebBrowser scenes - for controlling the new WebBrowser and its windows

Note that there are there are three different Browsers you can use: the legacy ArgoBrowser, Internet Explorer, and

the new WebBrowser. The WAP/Web scenes will normally use the legacy ArgoBrowser unless you specify the new

WebBrowser (by editing the Device resource's Browser property). The IE scenes always use Internet Explorer (the

version installed on the Agent running the test).

Each Browser can be configured by using the appropriate resource from the Resource/Browsers Group.

WAP/Web scenes Use the scenes in the Browser/WAP/Web Group to visit and explore WAP and WEB sites, using the legacy

ArgoBrowser or newer WebBrowser:

Visit Page

Autobrowse *

Choose Option

Select Form

Enter Data

Follow Link

Go Back

Navigate

Click Numbered Link

Visit Multipart Page *

Visit Video *

Browser GetCookies

Browser SetCookies

Browser ClearCookies

Browser ClearCache

Record Navigation *

Note: scenes marked with a * are not supported by WebBrowser.



Visit Page scene Purpose: Visit the specified page (URL)

Properties:

Actor


Data

URL - type the URL to visit, which must include the protocol, typically http://

System

Content - select a Prop resource to export the page to (optional)


Routes:

OK - the specified URL has been visited and is now the current page

Failed to visit page - the specified URL has not been found, the current page has not changed, due to a

service error

Failed to visit page (system) - the specified URL has not been found, the current page has not changed, due

to a system error



Autobrowse scene Purpose: Recurse (spider) through pages linked from the current (start) page

Note: The Script must set the current page before executing this scene e.g. by using the Visit page scene

Properties:

Actor


Data

Algorithm - select depth to perform a depth-first search (where autobrowse follows the first link on the first

page to the first link on the second page, to the first link on the third page, and so on - then backtracks);

select breadth to perform a breadth-first search (where autobrowse follows each of the links on the first

page, then each of the links on each of those pages, and so on). Default: depth (as used by previous versions

of Monitor Master)

Note: A breadth-first search is not practical for large web sites.

MaximumDepth - type how many links deep to travel from the start page. 1 means visit pages linked from

the start page but go no deeper, 2 means visit pages linked to from those pages, too. And so on. Default: 1

MaxURLs - type the maximum number of URLs to visit. 1 means visit just one URL; 100 would mean visit a

maximum of 100 URLs (pages). Default: 1

RegularExpression - type a regular expression that a linked URL must match to be visited. "." stands for this

folder, while "*" stands for anything, so ".*" restricts the links visited to URLs within this folder on the

server. Default: .*

System

Content - select a Prop resource to export the content to (optional)


Routes:

OK - autobrowse succeeded to specified depth

Failed to autobrowse - autobrowse to specified depth failed, due to a service error

Failed to autobrowse (system) - autobrowse to specified depth failed, due to a system error

The Autobrowse and Simple Autobrowse scenes

This scene is similar to the Simple Autobrowse scene in the WebBrowser Group, but there are significant

differences:

Blacklist: The Simple Autobrowse scene's blacklist is not available with the Autobrowse scene.



Form following: The Autobrowse scene will follow simple forms (when created in WML).

Content types: The Autobrowse scene supports WML as well as HTML; the Simple Autobrowse scene only

supports HTML.

Max Pages: The Autobrowse scene includes subcontent, such as images, in the count. The Simple

Autobrowse scene only counts the main pages.

Content: The Simple Autobrowse scene does not allow you to record the content to a prop.

External sites: The Autobrowse scene limits access to external sites by using the whitelist, as it does not have

this concept.

Browser support: The Autobrowse scene only works with the ArgoBrowser; the Simple Autobrowse scene

only works with the WebBrowser.



Choose Option scene Purpose: Choose an option from a list on a form

Properties:

Actor


Data

SelectedOption - type the name of the option to choose

System


Routes:

OK - the specified option has been chosen

Failed to choose option - the specified option has not been chosen, due to a service error

Failed to choose option (system) - the specified option has not been chosen, due to a system error



Select Form scene Purpose: Select a form on the current page to use in subsequent scenes

Properties:

Actor


Data

Form - type the name of the form to select; leave blank to use the default form. Default: blank

System



Routes:

OK - the specified form has been selected

Failed to select form - the specified form has not been selected, due to a service error

Failed to select form (system) - the specified form has not been selected, due to a system error



Enter Data scene Purpose: Enter (type) data into a field on a form on the current page

Properties:

Actor


Data

Name - type the name of the form variable to enter. Note that this is the variable name (set by its name

attribute in the page source), not its label (visible on the rendered page)

Value - type the data to "type" in the field. If there is already any data in the field, the new data will replace

it (not be added to it)

System


Routes:

OK - data has been entered into the form field

Failed to enter data (system) - data has not been entered into the form field, due to a system error



Follow Link scene Purpose: Visit the specified link on the current page

Properties:

Actor


Data

Link - type text that matches the text displayed on the page for the link to visit. For example, to visit a link

which is displayed as Home on the page, type Home; to click a text button displayed as OK, use OK. (A text

button's visible name is set by its value attribute, not its name attribute.)

System



Routes:

OK - a matching link has been visited and is now the current page

Failed to follow link - a matching link has not been visited, the current page has not changed, due to a

service error

Failed to follow link (system) - a matching link has not been visited, the current page has not changed, due

to a system error



Go Back scene Purpose: Go back to the previous page i.e. the page that was visited before the current page (equivalent to a

Browser's Back button)

Properties:

Actor


SkipRedirect - if True and the previous page was reached via a redirection (301, 302 or 307) will keep going

back until a non-redirecting page is found. If False, will go back to the previous page even if this is a

redirect. Default: True

System


Routes:

OK - have successfully returned to previous page

Failed to go back - return to previous page failed, current page unchanged, due to a service error

Failed to go back (system) - return to previous page failed, current page unchanged, due to a system error



Navigate scene Purpose: Navigate to another page or pages by following matching links, starting on the current page. (Also see

Record Navigation.)

Hint: Remember to set the current page before using this scene, for example by using Visit page.

Properties:

Actor


Browser behavior

ExploreMultipartDocument - True means recurse into each part of multi-part MIME documents; False

means get the first part only. Default is True

Data

LinkSequence - a collection defining the text of each link to navigate through. Click the button to

display or edit the list. Default: blank

StrictLinkMatch - select True and the link text must exactly match the LinkSequence text; select False and

the link text just needs to include the LinkSequence text. Note: Case is always significant - must match in

either case.

System


Routes:

OK - navigation to the specified links succeeded

Failed to navigate - a specified link was not found or a linked page did not load - a service error

Failed to navigate (system) - navigation failed for some other reasons - a system error



Click Numbered Link scene Purpose: Visit a link specified by position on the page

Properties:

Actor


Browser behavior

ExploreMultipartDocument - select True to recurse into multi-part MIME documents. Default: True

Data

LinkNumber - type the number of the link (link index) to "click". Monitor Master numbers all links from

start to end of the current page, starting at 1. Default: 1

Hint: One way to determine the link number is to visit the page with your web browser, click the top of the

page, then press Tab repeatedly until the link is selected. The link number is the number of times you

pressed Tab to select the link.

Routes:


Failed to navigate - the specified link has not been clicked, the current page has not changed, due to a

service error

Failed to navigate (system) - the specified link has not been clicked, the current page has not changed, due

to a system error



Visit Multipart Page scene Purpose: Visit the first document on a multi-part page

Properties:

Actor


Data

URL - type the URL to visit, which must include the protocol, typically http://

Routes:



service error

Failed to visit page (system) - the specified URL has not been found, the current page has not changed, due

to a system error



Visit Video scene Purpose: Stream video from the specified URL (using SPLAY)

Properties:

Actor


Data

URL - type the URL to visit, which must include the protocol, typically http://. Default: supplied by the

Operator

System

Content - select a Prop resource to export the page to (optional)


Routes:

OK - video has been streamed from the specified URL

Failed to visit video - the specified URL has not been found, or does not provide a compatible video stream

Failed to visit video (system) - the specified URL has not been found, or does not provide a compatible

video stream



Browser GetCookies scene Purpose: Get cookies for the current page for access as content and (optionally) store them in a Prop

Properties:

Actor


Data

CookieValue - select the Prop to store the cookies in (optional).

System


Routes:

OK - success, cookies have been fetched and are available as content

Failed to get cookies - failed due to a service error

Failed to get cookies (system) - failed due to a system error



Browser SetCookies scene Purpose: Set cookies for the current page

Properties:

Actor


Data

Cookies - select the Prop containing the cookies to set (usually set by using the Browser SetCookies scene)

System


Routes:

OK - success, cookies have been set

Failed to set cookies - failed due to a service error

Failed to set cookies (system) - failed due to a system error



Browser ClearCookies scene Purpose: Clear all cookies for the current page

Note: Not supported by the ArgoBrowser browser

Properties:

Actor


System


Routes:

OK - success, cookies have been cleared

Failed to clear cookies - failed due to a service error

Failed to clear cookies (system) - failed due to a system error



Browser ClearCache scene Purpose: Clear the browser cache

Properties:

Actor


System


Routes:

OK - success, cache has been cleared

Failed to clear cache - failed due to a service error

Failed to clear cache (system) - failed due to a system error



Record Navigation scene Purpose: Records a sequence of steps to navigate a WAP/Web site, which will be replayed when the scene is

executed. (Also see the Navigate scene.)

This scene runs the Record Navigation Wizard which uses the Agent's connection to connect to the start page and

record your navigation sequence. If Story Boarder is running on a separate PC to the Agent, the Agent must be

running the remote server service (enabled by choosing the Remote Connection feature). See Installing and

Managing Monitor Master for details.

If Story Boarder is running on the same PC as the Agent it will use the Agent's connections.

If Story Boarder is running on a separate PC to the Agent and the Agent is NOT running the remote server service,

Record navigation will use the local machine's connections, and will fail at design time if these are inadequate. It

will succeed if:

You are using an internet connection and your PC has internet connectivity

You are using an over-the-air connection and your PC has a suitable modem set up

Recording a navigation sequence

When you add a Record Navigation scene to your script, the Record Navigation Wizard runs the script up

to that point so it must be a valid (runnable) script.

If your script sets up a connection, it will use it - otherwise the Connection Wizard will run to set one up.

If your script visits a page (e.g. by using Visit Page) it will use it as the start page.

The Record Navigation Wizard will be displayed. If your script has not defined a start page, it will look

like this:

If your script has defined a start page, its address and contents will be shown on the right, like this:



This consists of five main components:

Three tabs on the left:

Existing - lists the recorded navigation sequence (initially blank)

Add - lists the actions you can choose on the current page. To add an action, select it and click the

large + (Add) button. This will add it to the navigation sequence and navigate the site

Checkpoint - lists the checkpoints you can choose on the current page. To add a checkpoint, select it

and click the large tick button

Two tabs on the right:

Page - displays the current page, once you've selected one. If your system supports ClickThrough, you

can use this just like a browser window, clicking controls on the page to add actions to the navigation

sequence i.e. to navigate the site.

Content - displays the current content once you've selected some i.e. the Request headers, Response

headers, Response binary and Response XML for the current page, like this:



To define the navigation sequence:

If your system supports ClickThrough you can click the link, button, or other control that you want to use, in

the browser window on the right.

Or you can select the Add tab to see the actions available on this page, select the action to take, and click the

large green + (Add) button. For example, add the Goto page action to define the start page.

The browser window will now update for the chosen action (e.g. display another page) the action you

selected will be added to the Existing tab, and the action list on the Add tab will be updated to reflect the

actions available on the new page:

The Page tab previews the new page, while the Content tab lists the new content - as described above.

Repeat the process to select each of the actions to take, in turn. You can use either technique (or a mixture of

both) if your system supports ClickThrough.

If you select an action that does not work (e.g. click a bad link) a diagnostic message will be displayed and

your choice will be rejected.

When you've created the navigation sequence you want, click OK to save it.

This will add a Recording scene to the script named after the first action:

You can of course rename it to something more helpful, if you wish.

Note: If a visited page includes a redirection command, Monitor Master turns it off (by replacing the command

with a null command), so you stay on the intended page. You can turn redirection on and off when viewing page

content in the Results Window (see The Results Window in the Story Boarder User Guide).

Properties and Routes

Properties:

Connectivity



Connection - select the Connection resource to use for the wizard and any navigation steps recorded by it.

Note that if you change this, you won't have any effect on the actions that have already been recorded - you

must edit the Actions list as described below to change them

Device, Hardware, Operator - details read from the selected Connection resource

Steps

Actions - a list of the actions you chose in the Record Navigation Wizard. To check or change these, click

the button. This will display the actions in a Collection Editor dialog - make any changes you require and

click OK to save them. (See Editing the navigation sequence, below)

You can add or edit actions by using the wizard: click the Invoke Wizard link in its properties dialog, then

click the action in the navigation sequence to continue from.

You can also extract one or more of the steps into separate scenes by using the Split scenes link. See Splitting

the sequence, below.

Routes:

OK - the recorded navigation succeeded

Service Error - the recorded navigation failed, due to a service error

System Error - the recorded navigation failed, due to a system error

Editing the navigation sequence

Hint: Editing a navigation sequence as described below can be quite awkward. You may find it simpler to start again, by

deleting the Record Navigation scene and adding it again.

To edit a recorded navigation sequence:

Display its properties dialog (e.g. double-click it)

Click the Actions field to display the button, then click it. This will display the recorded actions in the

Scenes Collection dialog:



To delete an action, select it from the list and click Remove.

To edit an action's properties, select it on the left, then edit the values on the right.

To change the order of actions, select one and use the buttons to move it up or down the list.

To add an action, click the button on the Add button and choose the action:

Visit page

Autobrowse

Choose option

Select form

Enter data

Follow link

Click numbered link

Go back

Navigate

Send SMS

Send MMS

Receive SMS

Receive MMS

Launch SIM toolkit application

Drop data connection

Match textual content

Then complete the properties for the new action, on the right. (For detailed information, see the description

of the scene with the same name as the action you're adding.)

When you've finished editing, click OK to save the changes and return to the properties dialog.

Splitting the sequence

To split some or all of the steps in a Record Navigation scene into separate scenes:

Display the scene's properties dialog and click the Split scenes link. This will list each recorded step in the

Split Wizard:



Click each of the steps that you want to break out, to highlight them. (Click a highlighted step to unselect

it.)

Click OK to split the sequence into separate scenes and return to the properties dialog.

Use the scenes in the Browser/IE Group to test Web sites by using the Agent's Internet Explorer as browser and the

Agent's Internet connection as the connection. A typical strategy is to use Browse to page to set the start page, then

use the other IE scenes to select options from it.

Note: These scenes use the version of Internet Explorer installed on the Agent. Their behavior will be affected by

how Internet Explorer is installed and configured on the Agent, as well as by the properties of the Internet

Explorer resource in the script.

IE will usually run in "background" mode, without displaying itself or any content. However, we recommend that

you login on the Agent to develop IE test scripts, and enable display of the browser so you can check operation and

see any error messages or prompts. The procedure for enabling browser display is included in the Internet

Explorer resource description (see Visibility).

Browse to Page *

Click Button

Click Image

Click Index

Click Input

Click Name

Enable Checkbox

Enter Text

Select Option

Select Form (IE)

Select Frame

Record Frame Content *

Click JS Entity

* These scenes can also be used with the newer WebBrowser.



Browse to Page scene Purpose: Visit the specified page (URL)

Properties:

Actor

Browser - select the Browser resource to use

Data

URL - type the URL to visit, which must include the protocol, typically http://. Default: blank

System


Routes:


Failed to browse to page - the specified URL has not been found, the current page has not changed, due to

a service error

Failed to browse to page (system) - the specified URL has not been found, the current page has not

changed, due to a system error



Click Button scene Purpose: Click a button specified by button text or name

Properties:

Actor


IE

Name - type the button text or button name to use to select it, according to the NameType selected. Default:

blank

NameType - select ButtonText to select by the text on the button (its value attribute) or NameAttribute to

select by the button name (its name attribute). Default: ButtonText

System


Routes:

OK - the specified button has been clicked

Failed to click button - the specified button has not been clicked, due to a service error

Failed to click button (system) - the specified button has not been clicked, due to a system error



Click Image scene Purpose: Click the specified named image

Properties:

Actor


Data

Name - type the name of the image to click. Default: blank

Xloc - type the X co-ordinate of the point to click on the image. The left-hand edge of the image has a X co-

ordinate of 0. Default: 0

Yloc - type the Y co-ordinate of the point to click on the image. The bottom edge of the image has a Y co-

ordinate of 0. Default: 0

IE

ClickType - select Html or Javascript. Html will produce the action specified by the HTML associated with

the image; Javascript will execute the associated Javascript. Note that for Javascript, XLoc and YLoc are

ignored. Default: Html.

System


Routes:

OK - the specified image has been clicked

Failed to click image - the specified image has not been clicked, due to a service error

Failed to click image (system) - the specified image has not been clicked, due to a system error



Click Index scene Purpose: Click a link specified by its index (its position in the sequence of links in the page source)

Properties:

Actor


Data

Index - type the index number of the link to click (e.g. if there are three links on the page, 0 is clicks the

browser's GO button, 1 selects the first one, 2 selects the second and 3 selects the last). Default: 0

Hint: One way to determine the link's index number is to visit the page with your web browser, click the top

of the page, then press Tab repeatedly until the link is selected. The link number is the number of times you

pressed Tab to select the link.

System


Routes:

OK - the specified link has been clicked

Failed to click link - the specified link has not been clicked, due to a service error

Failed to click link (system) - the specified link has not been clicked, due to a system error



Click Input scene Purpose: Click an input field specified by its name. You can use this to select a text input field (and then type text

into it by using Enter Text), or to toggle a checkbox.

Properties:

Actor


Data

Name - type the name of the input field to click. Input fields include: text entry fields, checkboxes and radio

buttons. (The name is set by the name attribute in the INPUT tag)

System


Routes:

OK - the specified field has been clicked

Failed to click input - the specified input field has not been clicked, due to a service error

Failed to click input (system) - the specified input field has not been clicked, due to a system error



Click Name scene Purpose: Click a link specified by its name

Properties:

Actor


Data

Name - type the name of the link to click - the hyperlinked (e.g. underlined) text displayed on the page

System


Routes:

OK - the specified link has been clicked

Failed to click link - the specified link has not been clicked, due to a service error

Failed to click link (system) - the specified link has not been clicked, due to a system error



Enable Checkbox scene Purpose: Set a specified control (checkbox or radio button)

Properties:

Actor


Data

Checked - select True to check (tick) the control, False to uncheck (clear) it. Default: True

Name - the name of the control to set. Default: blank

UseValue - select True to compare the control's value attribute and only set it if the current value matches

the Value specified below. This is required when setting a radio button, as each member of a group of

alternatives has the same name. Select False to set the control regardless of its value. Default: False

Value - the value to compare with the control's value, if UseValue is True. Default: blank

System


Routes:

OK - the specified control has been set

Failed to enable checkbox - the specified control has not been set, due to a service error

Failed to enable checkbox (system) - the specified control has not been set, due to a system error



Enter Text scene Purpose: Type text in a text field selected by its current value or name.

Properties:

Actor


Data

ReplacesValue - if you are using the ReplacesValue method (see the ReplacesValueType setting, below)

type the exact text that is currently in the input field. If you are using the NameAttribute method, type the

name of the input field to select (specified by its Name attribute). Note that the value or name you type must

exactly match the field's value or name (including case) or a system error will result. Default: blank

TextValue - type the text to enter in the selected field. Default: blank

WidgetType - select the text field type: single-line (an <INPUT> field), multi-line (a <TEXTAREA> field) or

either (will attempt single-line then multi-line if necessary). Default: single-line

IE

ReplacesValueType - select ReplacesValue to replace the text specified by ReplaceValue; select

NameAttribute to type the text in the field with the name specified by ReplaceValue. Default:

ReplacesValue

System


Routes:

OK - the specified text has been entered

Failed to enter text - the specified text has not been entered, due to a service error

Failed to enter text (system) - the specified text has not been entered, due to a system error (typically,

specified field not found)



Select Option scene Purpose: Select an option from a dropdown list, by name, value, or position

Properties:

Actor


Data

Name - type the name of the <SELECT> group (set by its name attribute). Default: blank

Value - type the value to use to select the option - interpreted as specified by ValueType (below). Default:

blank

ValueType - select one of the following:

Number - type the option number in Value (1 selects the first option, 2 the second, and so on)

TextValue - type the option text in Value i.e. the text displayed on the page

TextValueNotByName - type the option text in Name i.e. the text displayed on the page. This will select the

first match on the page, for any <SELECT> group; the Value setting is ignored

Value - type the option value in Value i.e. as set by the option's value attribute

Default: Number

System


Routes:


Failed to select option - the specified option has not been chosen, due to a service error

Failed to select option (system) - the specified option has not been chosen, due to a system error

Example:

If the page contained this HTML:

<select name="pet"> <option value="D">Dog</option> <option value="C">Cat</option> <option value="F">Fish</option> </select>

To select the second option, Cat, you could use any of these:

Name=pet, ValueType=Number, Value=2

Name=pet, ValueType=TextValue, Value=Cat

Name=Cat, ValueType=TextValueNotByName, Value is ignored

Name=pet, ValueType=Value, Value=C



Select Form (IE) scene Purpose: Select a form by name, action, or position

Properties:

Actor


Data

FormID - type the form's name, action, or number (depending on the NameType selected below). Default:

blank

NameType - select Name to specify the form by its name attribute; select Action to specify the form by its

action attribute; select Number to specify the form by its position on the page (first form's number is 1,

second form's number is 2 and so on). Default: Name

System


Routes:


Failed to select form - the specified form has not been selected, due to a service error

Failed to select form (system) - the specified form has not been selected, due to a system error



Select Frame scene Purpose: Select the frame to access, from the current frameset

Properties:

Actor


Data

Number - type the frame number to select: 0 means top (the page that specified the frameset), frames are

numbered 1, 2, 3 etc. Default: 0

System


Routes:


Failed to select frame - the specified frame has not been selected, due to a service error

Failed to select frame (system) - the specified frame has not been selected, due to a system error



Record Frame Content Purpose: Record the content from the specified frame. Note that content recording is usually turned off while

browing a frameset as tracking all the frames is impractical. Use this scene to capture the content of a specific

frame.

Visiting a new page or setting the frame number to 0 re-enables content recording.

Properties:

Actor


Data

Number - type the frame number to record: 0 means top (select the parent page), frames are numbered 1, 2,

3 etc. Default: 0

System


Routes:


Failed to record frame content - the specified frame content has not been recorded, due to a service error

Failed to record frame content (system) - the specified frame content has not been recorded, due to a system

error

Notes:

You cannot capture content from a frame containing content on a different domain.

This scene cannot detect when frame content changes. If the content in the selected frame changes, you

must select the frame again to capture it.



Click JS Entity scene Purpose: To click a JavaScript entity specified by its element name and (optionally) attributes

Properties:

Actor


Attributes

AltAttribute - type the value of the alt attribute to match, or leave blank to ignore this attribute. Default:

blank

ClassAttribute - type the value of the class attribute to match, or leave blank to ignore this attribute.

Default: blank

HrefAttribute - type the value of the href attribute to match, or leave blank to ignore this attribute. Default:

blank

IdAttribute - type the value of the id attribute to match, or leave blank to ignore this attribute. Default:

blank

NameAttribute - type the value of the name attribute to match, or leave blank to ignore this attribute.

Default: blank

SrcAttribute - type the value of the src attribute to match, or leave blank to ignore this attribute. Default:

blank

TypeAttribute - type the value of the type attribute to match, or leave blank to ignore this attribute. Default:

blank

ValueAttribute - type the value of the alt attribute to match, or leave blank to ignore this attribute. Default:

blank

Element

ElementName - type the element name to match. Required. Default: blank

IE

RecordDiagnostics - whether to record diagnostic information, True or False. Default: False

Match Type

Case Insensitive - whether to ignore the case when matching, True or False. Default: True

Count - which of the matching items to click; 1 means the first, 2 means the second, and so on. Default: 1

Use Partial Attributes - whether to allow partial attribute matches, True or False. Default: False

System


Routes:

OK - connection has been made

Service error - SIM Toolkit Application has not been launched, due to a service error

System error - SIM Toolkit Application has not been launched, due to a system error



STK scenes Use the scenes in the Browser/STK Group to access a SIM Toolkit:

Launch SIM Toolkit Application

The SIM Toolkit (STK) is a menu interface that can be used to run applications on a SIM. These applications are

supplied by your operator and vary greatly, but typically provide access to simple information or recreation

facilities such as "find restaurant".



Launch SIM Toolkit Application scene Purpose: Execute the SIM Toolkit Application (application menu) on a supported Real Device

Hint: This scene only activates the the SIM Toolkit Application menu. To choose an application, you must navigate

the menu using the Follow link or Click numbered link scenes - the simplest way to do this is to use the Record

Navigation scene for the entire process.

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the modem

System


Routes:


Service error - SIM Toolkit Application has not been launched, due to a service error

System error - SIM Toolkit Application has not been launched, due to a system error

WebBrowser scenes Use the scenes in the Browser/WebBrowser Group to use our newer JavaScript-enabled WebBrowser. This

Browser is configured by adding the WebBrowser resource to your script.

The scenes are organised into three Groups:

Control scenes - controlling the Browser:

Take Snapshot

Windows scenes - using the Browser Windows:

Open New Window

Select Window

Close Window

Enable Multiple Windows

Navigation scenes - navigating a site using the Browser:

Simple Autobrowse

Note: These scenes can only be used with the new WebBrowser.

You can use most of the WAP/Web and IE scenes with WebBrowser, as well as the WebBrowser-specific scenes

listed above. For details, see:

WAP/Web scenes

IE scenes

Using WebBrowser, in Chapter 6 of the Story Boarder User Guide

Notes:

WebBrowser does not record timings for the download of individual pieces of content.

Any timings recorded using WebBrowser are indicative only and should not be used as performance

Metrics.

WebBrowser timings are not directly comparable with the timings recorded using the other Browsers.

WebBrowser does not support Java Applets or Java Plugins.



The Story Boarder User Guide includes a section on using WebBrowser, with a summary of its limitations.



Take Snapshot scene Purpose: To capture the current browser window contents. The scene waits for window updates to stop before

taking the snapshot (until the window is considered is idle - see below)

Note: This is useful for capturing dynamic windows i.e. windows whose contents change over time

Properties:

Actor


Content

RecordContent - select what page contents to capture while browsing: None, TopLevel (the markup

document only) or All (markup document, images, etc.) Default: All

RecordMetaContent - select what meta content types to capture. Click the field then click its button

Tick Compressed to capture any compressed content

Tick Document to capture the main document

Tick Screenshot to capture a screenshot (default)

Data

ActiveDelay - type the length of time (seconds) during which no new content has arrived to consider the

window inactive. Default: 1.5

IdleDelay - type the length of time (seconds) during which no new content has arrived to consider the

window idle. Default: 0.3

Timeout - type the maximum time to wait (seconds) before taking a snapshot. Default: 10

System


Routes:

OK - snapshot has been taken

Failed to take snapshot - snapshot has not been taken, due to a service error

Failed to take snapshot (system) - snapshot has not been taken, due to a system error



Open New Window scene Purpose: To open a new window for the WebBrowser to use

Note: You must use the Enable Multiple Windows scene first, before using this scene.

Use the Select window scene to use a new window.

Properties:

Actor


System


Routes:

OK - new window has been opened

Failed to open new window - new window has not been opened, due to a service error

Failed to open new window (system) - new window has not been opened, due to a system error



Select Window scene Purpose: To select the window for the WebBrowser to use

WebBrowser launches with a single window, window 0 (the primary window) and uses that by default. If you open

new windows, they are numbered 1, 2, 3, etc. Use the Select window scene and the window number to switch to

using one of these windows.

Properties:

Actor


System


Window

Window - type the window number to select; 0 selects the primary window. Default: 0

Routes:

OK - window has been selected

Failed to select window - window has not been selected, due to a service error

Failed to select window (system) - window has not been selected, due to a system error



Close Window scene Purpose: To close the current WebBrowser window

Note: Use the Select window scene to make a window current.

Properties:

Actor


System


Routes:

OK - new window has been opened

Failed to open new window - new window has not been opened, due to a service error

Failed to open new window (system) - new window has not been opened, due to a system error



Enable Multiple Windows scene Purpose: To select enable the use of multiple windows with WebBrowser

WebBrowser launches with a single window, window 0 (the primary window) and uses that by default. Use this

scene to enable support for multiple windows - then you can use the Open new window scene to create them and

the Select window scene to switch between them.

Properties:

Actor


System


Window

Enable - select True to enable support for multiple windwos or False to disable support. Default: True

Routes:

OK - multiple windows support has been enabled or disabled as requested

Failed to enable multiple windows - multiple windows support has not been enabled or disabled, due to a

service error

Failed to enable multiple windows (system) - multiple windows support has not been enabled or disabled,




Simple Autobrowse scene Purpose: Recurse (spider) through pages linked from the current (start) page

Also see the Autobrowse scene.

Note: The Script must set the current page before executing this scene e.g. by using the Visit page scene. This scene

must be used with the new WebBrowser resource.

Properties:

Actor


Data

Algorithm - select depth to perform a depth-first search (where autobrowse follows the first link on the first

page to the first link on the second page, to the first link on the third page, and so on - then backtracks);

select breadth to perform a breadth-first search (where autobrowse follows each of the links on the first

page, then each of the links on each of those pages, and so on). Default: depth (as used by previous versions

of Monitor Master)

Note: A breadth-first search is not practical for large web sites.

Simple Autobrowse will only follow a link if it:

is inside an <a href> element

the href attribute is an http:// or https:// URL

HaltOnFirstError - select True to stop the autobrowse as soon as it encounters any service error; select False

to continue the autobrowse even if there are service errors. And so on. Default: False

System


URL Limiting

Blacklist1 - type a regular expression that a link must not match to be visited. Optional. Default: blank

Blacklist2-5 - type a regular expression that a link must not match to be visited. Optional. Default: blank

MaxDepth - type how many links deep to travel from the start page. 1 means visit pages linked from the

start page but go no deeper, 2 means visit pages linked to from those pages, too. And so on. Default: 1

MaxPages - type the maximum number of pages to visit. 1 means visit just one page; 100 means visit a

maximum of 100 pages. Default: 1



VisitExternalSitesOnce - select True and a link to another site that is allowed by the blacklists and whitelist

will be visited, but links from that page will not be followed. Select False and links from that page will be

followed. Default: False

Whitelist - type a regular expression that a link must match to be visited. "." stands for this folder, while "*"

stands for anything, so ".*" restricts the links visited to URLs within this folder on this server. Default: .*

Routes:

OK - autobrowse succeeded to specified depth

Failed to perform simple autobrowse - autobrowse to specified depth failed, due to a service error

Failed to perform simple autobrowse (system) - autobrowse to specified depth failed, due to a system

error

The Autobrowse and Simple Autobrowse scenes

This scene is similar to the Autobrowse scene in the WAP/Web Group, but there are significant differences:

Blacklist: The Simple Autobrowse scene's blacklist is not available with the Autobrowse scene.

Form following: The Autobrowse scene will follow simple forms (when created in WML).

Content types: The Autobrowse scene supports WML as well as HTML; the Simple Autobrowse scene only

supports HTML.

Max Pages: The Autobrowse scene includes subcontent, such as images, in the count. The Simple

Autobrowse scene only counts the main pages.

Content: The Simple Autobrowse scene does not allow you to record the content to a prop.

External sites: The Autobrowse scene does not have this concept.

Browser support: The Autobrowse scene only works with the ArgoBrowser; the Simple Autobrowse scene

only works with the WebBrowser.



Chapter 16 - Real Devices scenes

The scenes in the Real Devices Group are for use with specific supported Real Devices. They are organized by

phone type:

S60 scenes - for supported Nokia Series 60 Symbian-based phones

SE scenes - for supported Sony Ericsson phones

Android scenes - for supported Android-based phones and EMUs

S60 and SE Real Devices are not a standard Monitor Master option, but a Monitor Master Element that requires

effort from TEMS Professional Services to implement. Contact your TEMS sales representative for more

information.

S60 scenes Use the scenes in the Real Devices/S60 Group to use Nokia Series 60 Symbian-based phones:

Make Tethered MA Connection S60

Drop Tethered MA Connection

Press Tethered MA Key S60

Enter Tethered MA Text S60

Match Yethered MA Screen

Capture Tethered MA Screen

Clear Tethered MA Inbox S60

Send Tethered MA SMS S60

Send Tethered MA MMS S60

Receive Tethered MA SMS S60

Receive Tethered MA MMS S60

Visit Tethered MA Page S60

The scenes with S60 in their name are specific to Nokia Series 60 devices; the others are common to all supported

Real Devices.

Note: Be careful to use the appropriate scenes for the type of Real Device.



Make Tethered MA Connection S60 scene Purpose: Create a connection to an S60 device

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the S60 device

System


Routes:


Failed - connection has not been made, due to a system error



Drop Tethered MA Connection scene Purpose: Drop connection to a Real Device.

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the device

System


Routes:

OK - connection has been dropped

Failed - connection has not been dropped, due to a system error



Press Tethered MA Key S60 scene Purpose: Simulate pressing a key on an S60 device's keypad

Properties:

Actor


Data

Duration - how long to "press" the key for (milliseconds). 0 is appropriate for normal typing. Default: 0

KeyPress - select the key to press (Call key, End key, Pencil/ABC key, etc). Keycodes are specific to the

mobile device's operating system-specific. For a list, see the Appendix A.

PauseAfter - how long to wait after "pressing" the key (milliseconds). 0 is appropriate for normal typing.

Default: 0

System


Routes:

OK - key has been "pressed"

Failed to press key (system) - key has not been "pressed", due to a system error



Enter Tethered MA Text S60 scene Purpose: Simulate typing text on an S60 device's keypad

Properties:

Actor


Data

Duration - type how long to "press" each key for (milliseconds). 0 is appropriate for normal typing. Default:

0

PauseAfter - how long to wait after "pressing" each key (milliseconds). 0 is appropriate for normal typing.

Default: 0

Text - type the string of characters to "type"

System


Routes:

OK - key or string has been "typed"

Failed to press text (system) - text has not been "typed", due to a system error



Match Tethered MA Screen scene Purpose: Read a Real Device's screen and compare it with a reference image

Warning: This scene may take a significant time (up to 60 seconds) to execute.

Properties:

Actor


Data

ReferenceImage - type the pathname of the image file to compare the screen with or click the button to

browse to it. The image must be the same dimensions as the area of the screen specified by the next four

properties

ScreenRegionBottom - bottom pixel of screen to compare. Default: 0

ScreenRegionLeft - left pixel of screen to compare. Default: 0

ScreenRegionRight - right pixel of screen to compare. Default: 0

ScreenRegionTop - top pixel of screen to compare. Default: 0

TolerancePixels - number of pixels that can differ for the screen to still match. Default: 0

System


Routes:

OK - screen matches the reference image, within specified tolerances

Failed to match image - screen does not match the reference image

System error - screen match failed, due to a system error



Capture Tethered MA Screen scene Purpose: Capture a Real Device's screen for use as content


Properties:

Actor


System


Routes:

OK - screen captured, can be accessed as content

Failed to capture tethered MA screen - screen capture failed, because of a service error

Failed to capture tethered MA screen (system) - screen capture failed, because of a system error



Clear Tethered MA Inbox S60 scene Purpose: Clear an S60 device's inbox

Properties:

Actor


System


Routes:

OK - inbox has been cleared

Failed to clear inbox - inbox has not been cleared, due to a service error

Failed to clear inbox (system) - inbox has not been cleared, due to a system error



Send Tethered MA SMS S60 scene Purpose: Send an SMS message via an S60 device

Properties:

Actor


Data

Content - type the message to send

Timeout - type how long (in seconds) to try to send a message. Default: 30

System


Users


Routes:






Send Tethered MA MMS S60 scene Purpose: Send an MMS message via an S60 device

Properties:

Accounts

Destination - select the recipient's address type: Number or Email. Default: Number

Actor


Data

Content - type the pathname of the content to send. Default: blank

Subject - type the subject (title) for the message. Default: blank

Timeout - type how long (in seconds) to wait to send the message. Default: 30

System


Users


Routes:


Failed to send MMS - MMS message has not been sent, due to a service error

Failed to send MMS (system) - MMS message has not been sent, due to a system error



Receive Tethered MA SMS S60 scene Purpose: Receive an SMS message on an S60 device

Properties:

Actor


Data

Delete - select True to delete the message from the device once received; select False to keep the message.

Default: True

Timeout - type how long (in seconds) to wait for a message. Default: 30

System


Routes:

OK - a message has been received

Failed to receive SMS - a message has not been received within the timeout period (service error)

Failed to receive SMS (system) - a message has not been received within the timeout period (system error)



Receive Tethered MA MMS S60 scene Purpose: Receive an MMS message on an S60 device

Properties:

Actor


Data


Default: True


System


Routes:


Failed to receive MMS - a message has not been received within the timeout period, due to a service error

Failed to receive MMS (system) - a message has not been received within the timeout period, due to a

system error



Visit Tethered MA Page S60 scene Purpose: Visit the specified page (URL) via an S60 device

Properties:

Actor


Data

URL - type the URL to visit

System


Routes:



service error

Failed to visit page (system) - the specified URL has not been found, the current page has not changed,


SE scenes Use the scenes in the Real Devices/SE Group to use supported Sony Ericsson phones:

Make Tethered MA Connection SE


Press Tethered MA Key SE

Enter Tethered MA Text SE

Match Tethered MA Screen


Capture Tethered MA Text SE

Scenes with SE in their name are specific to Sony Ericsson devices; the others are common to all supported Real

Devices.




Make Tethered MA Connection SE scene Purpose: Create a connection to an SE device.

Properties:

Actor

Hardware - select the Hardware resource (terminal) that connects to the SE device

Data

Baud Rate - type the Baud Rate to use to connect to the device. Default: 57600

System


Routes:






Properties:

Actor


System


Routes:





Press Tethered MA Key SE scene Purpose: Simulate pressing a key on an SE device's keypad.

Properties:

Actor


Data





Default: 0

System


Routes:





Enter Tethered MA Text SE scene Purpose: Simulate typing text on an SE device's keypad.

Properties:

Actor


Data


0


Default: 0


System


Routes:





Match Tethered MA Screen scene Purpose: Read a Real Devices's screen and compare it with a reference image


Properties:

Actor


Data



properties






System


Routes:








Properties:

Actor


System


Routes:






Capture Tethered MA Text SE scene Purpose: Capture text from an SE device's screen for use as content

Properties:

Actor


System


Routes:


Failed to capture tethered SE MA text - capture failed, because of a service error

Failed to capture tethered SE MA text (system) - capture failed, because of a system error

Android scenes WARNING: These are powerful low-level tools, which must be used with care. For advanced developers with

Android experience, only!

Use the scenes in the Real Devices/Android Group for low-level access to Android-based phones (listed below) via

the ADB, the Android Debug Bridge:

ADB Get Property

ADB Input Events

ADB resource

ADB Set Property

ADB Start Activity

Supported phones

These scenes are supported by all our Android-based EMUs, including:

the Samsung Galaxy S6 and S7 EMUs

the Samsung Galaxy Note 4 EMUs



ADB Get Property scene Purpose: Read the value of an ADB property from the specified handset

Properties:

Configurations

ADB - select the ADB resource to use. Default: ADB

Data

PropName - type the name of the property to get from the handset. Default: blank

Output

Result - select the name of the Prop to store the value in (so you can use it subsequently). Default: (Nothing)

System


Routes:

OK - property has been read from the handset

Failed to get property - attempt failed due to a service error

Failed to get property (system) - attempt failed due to a system error



ADB Input Events scene Purpose: Execute a list of input ADB shell commands on the specified handset. The supported commands are

listed below.

Properties:

Configurations


Data

EventList - select the Props resource containing the list of input events to execute (see below). Default:

EventList

Sleep - type the number of seconds to sleep between each input event command. Default: 0

System


Routes:

OK - input events have been sent to the handset

Failed to input events - attempt failed due to a service error

Failed to input events (system) - attempt failed due to a system error

The Event List

You define the input events to execute by storing each one as a separate string in the StringList of the Props

resource specified by the scene's EventList parameter. Each input event is executed in sequence, starting from

member 0, with the handset sleeping between each one for the time specified by the Sleep parameter.

For example, this StringList:

Would be executed as:



1. Bring up the menu

2. Sleep for 5 seconds

3. Tap the dialer


5. Enter the number 1234567 into the dialer

Supported commands

You can use the following commands with this scene:

text text

Calls the adb shell input text command.

Used to input text to the active application on the device. For example: to input a telephone number to the

dialer, or text for an SMS. The text must not contain any spaces; to specify a space, type %s.

Example: text hello%sworld will enter "hello world" on the device.

tap x y

Calls the adb shell input tap command.

Used to tap the screen at the specified x and y co-ordinates.

Example: tap 500 500 will tap the screen 500 pixels to the right and down from the top left pixel.

key event

Calls the adb shell input keyevent command.

Used to enter a key event, where event is a supported event code (see below).

Example: key 6 will trigger the EndCall event.

sleep time

Calls the adb shell sleep command.

Used to make the shell sleep for the number of seconds specified by time. Note: The Sleep time set by the

scene's Sleep parameter will be ignored for this command.

Example: sleep 5 will make the shell sleep for 5 seconds before continuing to the next command.

send devicename type code value

Calls the adb shell sendevent command.

Can be used, for example, to execute gestures on the handset screen.

The devicename for the Lucid2 touchscreen is /dev/input/event1. To determine the touchscreen name on

other handsets, and for an explanation of the other parameters, visit:

http://ktnr74.blogspot.ch/2013/06/emulating-touchscreen-interaction-with.html

To capture a touchscreen event, run adb shell getevent touchscreenname from a command prompt on the

phone and perform the gesture on the screen. This will output the codes for the events triggered by the

gesture. The event codes are output as hexadecimal values, convert them to decimal for use with the send

command.

Supported key events

For a list of supported key events codes, visit:

http://developer.android.com/reference/android/view/KeyEvent.html





ADB resource Purpose: Defines the hardware (handset) that the ADB scenes will interact with

Properties:

Configurations

Hardware - select the Hardware resource (Android handset) to use. Default: Hardware



ADB Set Property scene Purpose: Set the value of an ADB property on the specified handset

Properties:

Configurations


Data

PropName - type the name of the property to set on the handset. Default: blank

PropValue - type the value to set the property to, on the handset. Note: Supports the empty string, "".

Default: blank

SuperUser - select True to set the property as the handset root user; select False to set the property as an

ordinary user. Default: True

System


Routes:

OK - property has been set on the handset

Failed to set property - attempt failed due to a service error

Failed to set property (system) - attempt failed due to a system error



ADB Start Activity scene Purpose: Start an Activity on an Android handset by using an Intent Object

Properties:

Configurations


Command

Action - type the name of the action to start on the handset. Default: blank

Component - type the name of the target component, which takes the form package/.runner-class. Default:

blank

System


If you do not specify a Component or an Action, the call will fail.

If you specify an Action but no Component, this is an Implicit Intent, which allows any component on the handset

to execute it. Use with care:

If no component can execute this action, the call will fail.

If one component can execute this action, the call will succeed.

If more than one component can execute this action, the handset will prompt the user to choose one - which

will hang the test!

If you specify a Component but no Action this is an Explicit Intent, which executes the specified component on the

handset.

If you specify an Action and a Component, this is an Explicit Intent - the specified component will execute it, as

long as it's installed and capable of doing so.

For example, to start the unlocker app:

Set Action to android.intent.action.MAIN

Set Component to com.tems.android.control/.UnlockerActivity

Routes:

OK - activity has been started on the handset

Failed to start activity - attempt failed due to a service error

Failed to start activity (system) - attempt failed due to a system error


Chapter 17 - Content Inspection scenes

Use the scenes in the Content Inspection Group to analyze the current content or service performance and branch

accordingly:

Protocol scenes

Content scenes

Images scenes

Audio scenes

Video scenes

Protocol scenes Use the scenes in the Content Inspection/Protocol Group to analyse the protocol headers in the current content:

Match Protocol Headers



Match Protocol Headers scene Purpose: Search the meta data (content headers and response codes) for a matching value.

Properties:

Applied query

Header - type the name of the header to search. You can also specify "Response code" or "Status text" to

match an HTTP response code or the status that was returned. Default: blank

MatchType - choose whether to test for the presence of matching content (match present) or its absence

(match absent). Default: match present

SearchType - choose whether text must match exactly (equals) or must be contained in the header

(contains). Default: equals

Text - type the text to match. Default: blank

System


For example, to check for image content:

Header = "content-type"

MatchType = "match present"

SearchType = "contains"

Text = "image"

Routes:

Content OK - a match was found in the meta data

Content bad match - a match was not found in the meta data

Unable to compare content - attempt failed

Content Scenes Use the scenes in the Content Inspection/Content Group to analyze content and branch accordingly:

Match Textual Content

Basic Content Tests

mobileOK

Start Content Tests

Stop Content Tests

Check Device Hurdle

Record Content Metrics

XPath Query



Match Textual Content scene Purpose: Search the current content for a word, phrase, or pattern. For example: check if the captured content

includes the phrase "page not found".

Note: This scene does not search Content Groups (see Start Content Tests), it searches the current content.

Properties:

Applied query

Genre - choose the type of match from:

Basic text (default)

Basic XML

Complex text

Complex XML

MatchType - choose whether to test for the presence of matching content (match present) or its absence

(match absent). Default: match present

QueryOutput - optionally select the Prop resource to store the results of the query in (most useful for

complex queries)

BasicText

BasicText - type the keyword to seek in the textual parts of the content

CaseInsensitive - select True to make the match case-insensitive. Default: False

ConvertWhiteSpace - select True to convert any white space sequence (spaces, tabs, CRs), to a single space

for the match. Default: False

BasicXML

BasicXML - select the search to be made, from:

1. Content contains text p1

2. Content contains <p1>

3. Content contains <p1> containing text p2

4. Content contains <p1> containing <p2>

5. Content contains <p1> with attribute p2

6. Content contains <p1> with attribute p2 = p3

7. Content contains <p1> with attribute p2 longer than p3 characters

8. Content contains <p1> more than p2 times

9. Content does not contain text p1

10. Content does not contain <p1>

11. Content does not contain <p1> containing text p2

12. Content does not contain <p1> containing <p2>

13. Content does not contain <p1> with attribute p2

14. Content does not contain <p1> with attribute p2 = p3

15. Content does not contain <p1> with attribute p2 longer than p3 characters

16. Content contains <p1> less than p2 times

BasicXMLp1 - parameter <p1> for use in the search



Complex text



ComplexText - a regular expression to seek in the textual parts of the content

Complex XML

ComplexXML - an XPath query that will be executed against the XML structure of the content

ComplexXMLNamespace - an optional XML namespace in which to execute the query

System


Routes:

Content OK - a match was found in the current content

Content bad match - a match was NOT found in the current content

Unable to compare content - the match failed due to a system error



Basic Content Tests scene Purpose: Check all Content Groups (captured using Start Content Tests and Stop Content Tests scenes) by

applying up to 5 checks (described below) and branch accordingly. For example: check1 might look for an image in

paragraph 2, while check2 might look for a specific URL anywhere on the page. The outcome will only be OK if the

captured content passes all the checks.

Note: If you have captured multiple Content Groups, they will be analyzed as if captured together.

Properties:

Check 1 - specify the first check to perform

Check1Check - choose the type of check from:

Ignore (default) - ignore this entire check

PartialLinkURLPresent - check if the specified check text is included in a link URL

PartialLinkNamePresent - check if the specified check text is included in a link name

FullLinkURLPresent - check if the specified check text is included as a link URL

FullLinkNamePresent - check if the specified check text is included as a link URL

TextPresent - check if the specified check text is included

TextNotPresent - check if the specified check text is not included

ImagePresent - check if an image is present

Check1CheckText - type the link URL, link name, or text to check for. Default: blank

Check1Paragraph - type the paragraph number n to check, if Check1Position=FromStart or FromEnd.

Default: 1

Check1Position - select the paragraph to check: AnywhereOnPage means check all paragraphs; FromStart

means check the nth paragraph from the start (numbered 1, 2, 3…); FromEnd means check the nth

paragraph from the end (numbered …3, 2, 1). Default: AnywhereOnPage

Check2, Check3, Check4, Check5

As for Check1, but specify additional checks, all of which must be passed. If you don't want a check, leave

ChecknCheck set to Ignore.

System


TestContent - select the Test Content resource to use

Routes:

Content OK - the content passed the check(s)

Service did not conform to basic content - the content failed the check(s)

Unable to check content - the check(s) failed due to a system error



mobileOK scene Purpose: Validate the content in all Content Groups (captured using Start Content Tests and Stop Content Tests

scenes) against level 1 checks from the draft W3C MobileOK scheme. The content passes only if it passes all

selected tests.

Note: If you have captured multiple Content Groups, they will be analysed as if captured together.

Note: The Image Formats plugin must be enabled (in the Start scene's properties) or this scene will not work.

For further information on MobileOK, visit http://www.w3.org/TR/mobileOK/

Properties:

Level1: Content/Encoding tests

CharacterEncodingSupport - whether to enable the Level 1 CHARACTER_ENCODING_SUPPORT check.

(Passes if content specifies UTF-8 character encoding.) Default: True

CharacterEncodingUse - whether to enable the Level 1 CHARACTER_ENCODING_USE check. (Passes if

all linked resources specify UTF-8 character encoding in their response.) Default: True

ContentFormatSupport - whether to enable the Level 1 CONTENT_FORMAT_SUPPORT check. (Passes if

the document MIME type is application/vnd.wap.xhtml+xml or application/xhtml+wml and all linked

resources respond with a MIME type of text/css, image/png or image/gif.) Default: True

ValidMarkup - whether to enable the Level 1 VALID_MARKUP check. (Passes if document validates to its

doctype and/or XSD schema.) Default: True

Level1: Embedded content tests

NoFrames - whether to enable the Level 1 NO_FRAMES check. (Passes if contains no frame tags.) Default:

True

ObjectsOrScript - whether to enable the Level 1 OBJECTS_OR_SCRIPT check. (Passes if contains no script,

object, or applet tags.) Default: True

PopUps - whether to enable the Level 1 POP_UPS check. (Passes if none of the "a" tags have target

attributes.) Default: True

Level1: Graphics tests

GraphicsForSpacing - whether to enable the Level 1 GRAPHICS_FOR_SPACING check. (Passes if there are

no transparent images of 2x2 pixels or less.) Default: True

ImageMaps - whether to enable the Level 1 IMAGE_MAPS check. (Passes if contains no map or area tags.)

Default: True

ImagesResizing - whether to enable the Level 1 IMAGES_RESIZING check. (Passes if all img height and

width attributes match the image height and width.) Default: True

ImagesSpecifySize - whether to enable the Level 1 IMAGES_SPECIFY_SIZE check. (Passes if all img tags

have height and width attributes.) Default: True

NonTextAlternatives - whether to enable the Level 1 NON-TEXT_ALTERNATIVES check. (Passes if all img

tags have an alt attribute.) Default: True

Level1: Input tests

DefaultInputMode - whether to enable the Level 1 DEFAULT_INPUT_MODE check. (Passes if all text and

textarea input tags have an inputmode attribute.) Default: True

ProvideDefaults - whether to enable the Level 1 DEFAULT_INPUT_MODE check. (Passes if all radio

buttons and select groups have a default option defined.) Default: True

http://www.w3.org/TR/mobileOK/



Level1: Page tests

PageSizeLimit - whether to enable the Level 1 PAGE_SIZE_LIMIT check. (Passes if page size 10 KB or less.)

Default: True

PageTitle - whether to enable the Level 1 PAGE_TITLE check. (Passes if page has a title.) Default: True

Level1: Redirection tests

AutoRefresh - whether to enable the Level 1 AUTO_REFRESH check. (Passes if page does not include a

refresh meta tag for the same page.) Default: True

Redirection - whether to enable the Level 1 REDIRECTION check. (Passes if page does not include a refresh

meta tag for another page.) Default: True

Level1: Style sheet tests

Measures - whether to enable the Level 1 MEASURES check. (Passes if page style tags and CSS styles only

use relative units - not px, pt, pc, in, cm, or mm.) Default: True

StyleSheetsSize - whether to enable the Level 1 STYLE_SHEETS_SIZE check. (Passes if external stylesheet

specified by page does not exceed 5 KB.) Default: True

StyleSheetsUse - whether to enable the Level 1 STYLE_SHEETS_USE check. (Passes if page includes a style

tag.) Default: True

Level1: Tables tests

TablesLayout - whether to enable the Level 1 TABLES_LAYOUT check. (Passes if none of the td tags are

empty or contains a 1x1 pixel image.) Default: True

TablesNested - whether to enable the Level 1 TABLES_NESTED check. (Passes if no table tags are found

within other tables.) Default: True

TablesSupport - whether to enable the Level 1 TABLES_SUPPORT check. (Passes if page does no use any

table tags.) Default: True

System


MobileOK - select the MobileOK resource to use

Routes:

Content OK - content is mobileOK compliant (for all specified tests)

Service is not mobileOK compliant - content has failed one or more of the specified tests

Unable to check content - content has not been checked, due to a service error

The result for each piece of content is indicated in the content listing reports, in 5 additional columns:

OK: content analysis overview:

red means the item has failed (includes errors or failures);

green means it has passed (includes passes but no failures or errors);

yellow means the contents passed but there were device/compliance errors, OR there were content analysis

warnings but no errors or passes;

white means it has not been analysed (does not include any passes or failures) - typically because there was

no content to analyse

CAP: the number of Content Analysis Passes for this item

CAF: the number of Content Analysis Failures for this item

DE: the number of Device Errors for this item



CE: the number of Content Errors for this item

For more information, see the The content list report, in the Story Boarder User Guide.



Start Content Tests scene Purpose: Start capturing content for use by the Record Content Metrics, Basic Content Tests and mobileOK scenes.

Content will be captured from subsequent scenes until a Stop content tests scene is executed i.e. you bracket the

scenes to capture content from with a Start Content Tests scene and a Stop content tests scene and then you can

analyse the content.

Content can be collected from different parts of the script and stored in named Content Groups by using multiple

Start Content Tests and Stop Content Tests scenes, with different group names. Content in each group can then be

analysed separately, by the Record Content Metrics scene; the other scenes analyse all the Content Groups

together.

Note: You must add these Internal Timing Points to the script to use this scene properly:

HTTPRequestStart

HTTPResponseEnd

DNSStart

DNSEnd

WSPRequestStart

WSPResponseEnd

FTPRequestStart

FTPResponseEnd

The easiest way to add them is to use the Internal Timing Point scene (from the Reporting Group).

Properties:

Misc

Group - type a Group Name to capture content in that Group, or leave blank for the default Group Name,

"enabled". Default: blank.

System


Routes:

Normal - content capture has started



Stop Content Tests scene Purpose: Stop capturing content for testing. Use with the Start Content Tests scene to bracket the scenes whose

content you want to test. Testing is performed subsequently, by using the Basic Content Tests, MobileOK and

Record Content Metrics scenes.

Properties:

System


Routes:

Normal - content capture has finished



Check Device Hurdle scene Purpose: Get information about a device, by reading the answer for a specific hurdle (testcase) from its device

profile. The answer is reported as a Diagnostic message; you can also use the answer to branch the script logic and

store it in a Prop for use within the script

Properties:

Data

Device - select the Device resource to check

Hurdle - type the formal name of the Hurdle to check, for example

com.argogroup.images.gif.animationsupported. Its case (capitalisation) is ignored. For a list of hurdles, their

formal names and data types, see Appendix D in hte Advanced Scripting Guide.

System


Prop - select the Prop resource to store the answer in. Optional

Routes:

Hurdle True - answer is True (non-zero)

Hurdle False - answer is False (zero)

Device Hurdle not available - hurdle exists but there is no answer recorded in this device profile (answer is

unknown)

Unable to find Device Hurdle (system) - hurdle does not exist. Check your typing

The Hurdle Answer is converted to a route as follows:

Answer Type True route False route Unknown route

Boolean = True = False Unknown

Numeric = not 0 = 0 Unknown

String = not blank = blank Unknown



Record Content Metrics scene Purpose: Extract data from a Content Group (captured by using the Start content tests and Stop content tests

scenes) and return it as metrics, timings, and (optionally) content.

You can either specify the Content Group to report on (by specifying the Group Name) or report on all Content

Groups (by leaving the Group Name blank).

Properties:

Application Layer

RecordEndToEndMetric - choose True to record the overall duration as an "End to end" metric. Default:

True

RecordProtocols - choose True to add the protocols used (FTP, HTTP, WSP or DNS) as Application Layer

meta-tags. Default: True

Group

Group - type the name of the Content Group to report metrics for, or leave blank to report metrics from all

Content Groups. Default: blank.

Misc

ContentRecord - select True to write the metrics to a content record. Default: False.

Summary

Summary - click the button to choose the types of summary metric to record against the main

transaction:

Content timings - this records (as metrics) the time taken to fetch content, subcontent, redirected

content and DNS resolution times

Domain names - this records (as messages) the domain names fetched in the content

Overal response code count - this records (as metrics) the number of each response code as returned by

all the destination servers

Per-domain response code count - this records (as metrics) the number of each response code for each

domain name

Transaction - click the button to choose the types of metric to record for each transaction. The choices are

similar to those for the summary, but the metrics and messages are recorded for each transaction. If a

transaction does not fetch any content, no additional metrics will be recorded for that transaction.



System


MetricCalculator - select the Metric Calculator resource to use

Routes:

OK - metrics recorded as requested

Failed to record content metrics - due to a service failure

Failed to record content metrics (system) - due to a system failure

Metrics recorded - HTTP

For HTTP content, the following will be recorded:

The number of HTTP requests made

The number of successful HTTP requests made

The number of unsuccessful HTTP requests made

The time to fetch the main page

The time to fetch all the subcontents (elapsed time)

DNS resolution time (if not using a proxy or IP address)

The time taken to perform redirections

The elapsed time for the page fetch (start of first request to end of last request)

The percentage of successful HTTP requests (0 = no successful requests, 100 = all requests were successful)

The end-to-end data size (request headers plus response headers plus response data)

The end-to-end payload size (response data)

The end-to-end duration (from request start to response end)

Metrics recorded - HTTP with subcontent

If a page includes subcontent (such as the images on a page):

Each piece of content has its own duration, data size, payloaf duration and payload size

The main page duration and size are the patent page's duration and size

The end-to-end duration is calculated from the request start for the main page to the last response end time

for the last piece of subcontent for the page

The end-to-end size is the sum of the data sizes for the main page and all subcontent



The end-to-end payload duration is calculated from the response start for the main page to the last response

end time for the last piece of subcontent for the page

The end-to-end payload size is the sum of payload sizes for the main page and all subcontent

HTTP with chunked transfer

HTTP chunked transfers include data in the transfer to say how big the next chunk will be. This additional data is

not recorded as part of the content so the data transfer size will be smaller than expected. Chunked transfer is

normally used when servers are heavily loaded and may therefore give misleading results - it is not recommended

for throughput measurement.

Metrics recorded - WSP

For WSP content, the following will be recorded:

The number of WSP requests made

The number of successful WSP requests made

The number of unsuccessful WSP requests made

The time to fetch the main page

The time to fetch all the subcontent (elapsed time)

The time to fetch any immediately preceding redirection

The percentage of successful WSP requests (0 = no successful requests, 100 = all requests were successful)

Metrics recorded - FTP

For FTP content, the following will be recorded:

The number of FTP transfers made (should be 1)

The number of successful FTP transfers made

The number of unsuccessful FTP transfers made

The time taken by the FTP transfer

DNS resolution time (if not using an IP address)

The percentage of successful FTP requests (0 = no successful requests, 100 = all requests were successful)

The end-to-end data size (the transferred data only - the login and command processing is not included)

The end-to-end payload size (the transferred data)

The end-to-end duration (from login to end of data transfer)

The end-to-end payload duration (from the opened socket to the end of data transfer)

Metrics recorded - Other

For other content types:

Nothing

If the content does not contain any FTP, HTTP or WSP timings, then no additional metrics will be recorded



Multiple scenes

If the Content Group includes multiple scenes, or you are agggregating multiple Content Groups, each total end-

to-end metric is the sum of the end-to-end metric for each scene.

Failed transfers

If a transfer fails, metrics will not be reported for it - any data would be misleading.



XPath Query scene Purpose: Perform an XPath query on XML content or an XML file and return the first or last element matching the

query. Can also be used to branch depending on whether a value is found.


Properties:

Applied query

ListElementToOutput - select whether to output the first or last matching element. Default: First

QueryOutput - select the Prop to store the result of the query in. Default: Nothing

Complex XML

XMLNameSpace - type the XML namespace to execute query in. Optional. Default: blank

XPathString1 - type (or select a Prop containing) the first part of the XPath query, which will be

concatenated with the other parts. Default: False

XPathString2 - type (or select a Prop containing) the second part of the XPath query, which will be


XPathString3 - type (or select a Prop containing) the third part of the XPath query, which will be


Note: the resulting XPath query must return a text value, not a node. If the query matches multiple values,

the first or last will be returned as specified by the ListElementToOutput property.

Input File

XMLFileName - type the name of a saved XML file to query this file rather than the current content. Leave

blank to query the current content. Default: blank

System


Routes:

OK - the query has returned a value to the specified Prop

OK XPath did not return any values - the query has not returned a value

XPath Query failed (system) - the query has not returned a value, because of a system error

Examples

Assuming the content contains this XML:

<?xml version="1.0"?> <a> <b agent="agent1" server="qmserver1"> Agent 1, located in Elstead </b> <b agent="agent2" server="qmserver1"> Agent 2, located in Elstead </b> <b agent="agent3" server="qmserver2"> Agent 3, located in Eningen </b> <b agent="agent4" server="qmserver2"> Agent 4, located in Solothurn </b>



<b agent="agent5" server="qmserver3> Agent 5, located in Atlanta </b> </a>

Example 1

Set XpathString1 to /a/b to match all the "b" nodes and set XpathString2 to /@agent to extract the agent names

from those nodes:

agent1

agent2

agent3

agent4

agent5

Set ListElementToOutput to First to return agent1; Set ListElementToOutput to Last to return agent5.

Example 2

Set XpathString1 to /a/b to match all the "b" nodes and set XpathString2 to /@server to extract the server names

from those nodes:

qmserver1

qmserver1

qmserver2

qmserver2

qmserver3

Set ListElementToOutput to return the first or last name.

Example 3

Set XpathString1 to /a/b to match all the "b" nodes and set XpathString2 to /text() to extract the descriptions:



Agent 3, located in Eningen

Agent 4, located in Solothurn

Agent 5, located in Atlanta

Set ListElementToOutput to return the first or last name.

Example 4

Set XpathString1 to /a/b/server="qmserver1" to match all the "b" nodes with server set to "qmserver1". Set

XpathString2 to ./text() to extract the descriptions:



If you specified a value for server that was not in the content, the scene would return nothing - and execute the OK

XPath did not return any values outcome.

Images scenes Use the scenes in the Content Inspection/Images Group to compare images with a reference image and branch

accordingly:

Match Image

Match Image on Page

mailto:./@server





Match Image scene Purpose: Search the current content for a match with a reference image.

Properties:

Applied query

MatchType - choose whether to test for the presence of a matching image (Match present) or its absence

(Match absent). Default: Match present

Data

ReferenceImage - type the pathname of the image file to compare the content with or click the button to

browse to it. The file must have an extension of .bmp, gif, .jpg, .jpeg or .wmp and be in the format indicated

by the extension. The image in the content must be in the same format for the comparison to produce a

match.

ScreenRegionBottom - the y co-ordinate of the bottom left pixel of the reference image to compare. Default:

0

ScreenRegionLeft - the x co-ordinate of the bottom left pixel of the reference image to compare. Default: 0

ScreenRegionRight - the x co-ordinate of the top right pixel of the reference image to compare. Default: 0

ScreenRegionTop - the y co-ordinate of the top right pixel of the reference image to compare. Default: 0

Co-ordinates are numbered from 0. For example, if the reference image is 40x40 pixels but you only want to

match the top right 20x20 pixels, set the parameters as follows:

ScreenRegionBottom = 19

ScreenRegionLeft = 19

ScreenRegionRight = 39

ScreenRegionTop = 39

TolerancePixels - the number of pixels that can differ for the images still to be reported as a match. Default:

0

System


Routes:






Match Image on Page scene Purpose: Compare an image on the current page with a reference image.

Properties:

Applied query

MatchType - choose whether to test for the presence of a matching image (Match present) or its absence

(Match absent). Default: Match present

Content

ImageNumber - type the number of the image to check on the page. (Images are numbered starting from 1,

in the order in which they appear in the page HTML.) Default: 1

RevisitContent - whether to revisit the original URL. Default: False

Data

ReferenceImage - type the pathname of the image file to compare the content with or click the button to

browse to it. The file must have an extension of .bmp, gif, .jpg, .jpeg or .wmp and be in the format indicated

by the extension. The image in the content must be in the same format for the comparison to produce a

match.

ScreenRegionBottom - the y co-ordinate of the bottom left pixel of the reference image to compare. Default:

0

ScreenRegionLeft - the x co-ordinate of the bottom left pixel of the reference image to compare. Default: 0

ScreenRegionRight - the x co-ordinate of the top right pixel of the reference image to compare. Default: 0

ScreenRegionTop - the y co-ordinate of the top right pixel of the reference image to compare. Default: 0

Co-ordinates are numbered from 0. For example, if the reference image is 40x40 pixels but you only want to

match the top right 20x20 pixels, set the parameters as follows:

ScreenRegionBottom = 19

ScreenRegionLeft = 19

ScreenRegionRight = 39

ScreenRegionTop = 39

TolerancePixels - the number of pixels that can differ for the images still to be reported as a match. Default:

0

System


Routes:






Audio scenes Use the scenes in the Content Inspection/Audio Group to analyse audio and branch accordingly:

Audio Analysis - perform frequency analysis

Detect-mWatt - detect mWatt tone

Detect-Fax - detect fax tone



Audio Analysis scene Purpose: Record audio, analyse its frequency distribution, and optionally match the audio.

Properties:

Basic

Duration - type the time (seconds) to record from the selected source. Default: 30

Hardware - select the Hardware resource (terminal) to record from, which should specify a SmartModem.

Audio will be recorded from its audio output and analyzed

Filters

DTMF Sequence - optional. Type a DTMF sequence (e.g. dialed number) to match for a successful outcome.

Default: blank

Threshold - type the percentage of the frequency distribution peak to treat as noise. Default: 10

Recording

AnalysisFile - optional. Type a filename to save the audio analysis to it (see example below). Default: blank

- not saved

AudioFile - optional. Type a filename to save the audio stream to it, as a WAV file. Default: blank- not

saved

System


Routes:

OK - analysis complete, stream matched DTMF sequence (if supplied)

Failed to analyse audio stream - analysis failed due to a service failure, or stream didn't match the specified

DTMF sequence

Failed to analyse audio stream (system) - analysis failed due to a system failure

Example audio analysis (Audio Analysis scene)



Detect-mWatt scene Purpose: Record and analyze audio to detect the mWatt tone (1003Hz).

Properties:

Basic




Filters


Recording

AnalysisFile - optional. Type a filename to save the frequency analysis to it (see example below). Default:

blank - not saved

AudioFile - optional. Type a filename to save the audio stream to it, as a WAV file. Default: blank - not

saved

System


Routes:

OK - analysis complete, mWatt tone detected

Failed to analyse audio stream - analysis failed due to a service failure, or mWatt tone not detected


Example audio analysis (Detect-mWatt scene)



Detect-fax scene Purpose: Record and analyze audio to detect if it's a fax transmission (listen for the 2105 Hz fax tone).

Properties:

Basic




Filters


Recording

AnalysisFile- optional. Type a filename to save the audio analysis to it. Default: blank- not saved

AudioFile - optional. Type a filename to save the audio stream to it, as a WAV file. Default: blank- not

saved

System


Routes:

OK - analysis complete, fax tone detected

Failed to analyse audio stream - analysis failed due to a service failure, or fax tone not detected


Example audio analysis (Detect-Fax scene)

Video scenes Use the scenes in the Content Inspection/Video Group to analyze video content:

Generate Video MOS Score



Generate Video MOS Score scene Purpose: Perform Mean Opinion Scoring on a media stream. The stream must be compatible with Real Video 8-10.

Note: Requires the optional Genista license.

Properties:

Actor


Stream

Timeout - type the timeout to use, in seconds. Default: 60

URL - a URL specifying the video item or stream to score. If blank, the last stream URL detected during

navigation will be scored.

Stream Advanced

AnalysisModeOverride - select auto to autodetect the stream type or select a format from QuickTime,

RealMedia, WindowsMedia, DirectShow, MPEG-4, 3GPP, and SDP. Default: auto

OverrunTime - type the overrun time (in seconds) that the scene should tolerate (e.g. to allow for initial

buffering). Default: 0

System


VideoMOSEngine - select the Video MOS Engine resource to use

Routes:

OK - analysis complete, video has been scored

Failed to analyse stream MOS - analysis failed due to a service failure

Failed to analyse stream MOS (system) - analysis failed due to a system failure



The scenes in the Real Devices Group are for use with specific supported Real Devices. They are organized by

phone type:

S60 scenes - for supported Nokia Series 60 Symbian-based phones

SE scenes - for supported Sony Ericsson phones

Android scenes - for supported Android-based phones and EMUs

S60 and SE Real Devices are not a standard Monitor Master option, but a Monitor Master Element that requires

effort from TEMS Professional Services to implement. Contact your TEMS sales representative for more

information.

S60 scenes Use the scenes in the Real Devices/S60 Group to use Nokia Series 60 Symbian-based phones:

Make Tethered MA Connection S60


Press Tethered MA Key S60

Enter Tethered MA Text S60

Match Yethered MA Screen


Clear Tethered MA Inbox S60

Send Tethered MA SMS S60

Send Tethered MA MMS S60

Receive Tethered MA SMS S60

Receive Tethered MA MMS S60

Visit Tethered MA Page S60

The scenes with S60 in their name are specific to Nokia Series 60 devices; the others are common to all supported

Real Devices.




Make Tethered MA Connection S60 scene Purpose: Create a connection to an S60 device

Properties:

Actor


System


Routes:






Properties:

Actor


System


Routes:





Press Tethered MA Key S60 scene Purpose: Simulate pressing a key on an S60 device's keypad

Properties:

Actor


Data





Default: 0

System


Routes:





Enter Tethered MA Text S60 scene Purpose: Simulate typing text on an S60 device's keypad

Properties:

Actor


Data


0


Default: 0


System


Routes:





Match Tethered MA Screen scene Purpose: Read a Real Device's screen and compare it with a reference image


Properties:

Actor


Data



properties






System


Routes:








Properties:

Actor


System


Routes:






Clear Tethered MA Inbox S60 scene Purpose: Clear an S60 device's inbox

Properties:

Actor


System


Routes:

OK - inbox has been cleared

Failed to clear inbox - inbox has not been cleared, due to a service error

Failed to clear inbox (system) - inbox has not been cleared, due to a system error



Send Tethered MA SMS S60 scene Purpose: Send an SMS message via an S60 device

Properties:

Actor


Data

Content - type the message to send

Timeout - type how long (in seconds) to try to send a message. Default: 30

System


Users


Routes:






Send Tethered MA MMS S60 scene Purpose: Send an MMS message via an S60 device

Properties:

Accounts

Destination - select the recipient's address type: Number or Email. Default: Number

Actor


Data

Content - type the pathname of the content to send. Default: blank

Subject - type the subject (title) for the message. Default: blank

Timeout - type how long (in seconds) to wait to send the message. Default: 30

System


Users


Routes:


Failed to send MMS - MMS message has not been sent, due to a service error

Failed to send MMS (system) - MMS message has not been sent, due to a system error



Receive Tethered MA SMS S60 scene Purpose: Receive an SMS message on an S60 device

Properties:

Actor


Data


Default: True


System


Routes:


Failed to receive SMS - a message has not been received within the timeout period (service error)

Failed to receive SMS (system) - a message has not been received within the timeout period (system error)



Receive Tethered MA MMS S60 scene Purpose: Receive an MMS message on an S60 device

Properties:

Actor


Data


Default: True


System


Routes:


Failed to receive MMS - a message has not been received within the timeout period, due to a service error

Failed to receive MMS (system) - a message has not been received within the timeout period, due to a

system error



Visit Tethered MA Page S60 scene Purpose: Visit the specified page (URL) via an S60 device

Properties:

Actor


Data

URL - type the URL to visit

System


Routes:



service error

Failed to visit page (system) - the specified URL has not been found, the current page has not changed,


SE scenes Use the scenes in the Real Devices/SE Group to use supported Sony Ericsson phones:

Make Tethered MA Connection SE


Press Tethered MA Key SE

Enter Tethered MA Text SE

Match Tethered MA Screen


Capture Tethered MA Text SE

Scenes with SE in their name are specific to Sony Ericsson devices; the others are common to all supported Real

Devices.




Make Tethered MA Connection SE scene Purpose: Create a connection to an SE device.

Properties:

Actor


Data

Baud Rate - type the Baud Rate to use to connect to the device. Default: 57600

System


Routes:






Properties:

Actor


System


Routes:





Press Tethered MA Key SE scene Purpose: Simulate pressing a key on an SE device's keypad.

Properties:

Actor


Data





Default: 0

System


Routes:





Enter Tethered MA Text SE scene Purpose: Simulate typing text on an SE device's keypad.

Properties:

Actor


Data


0


Default: 0


System


Routes:





Match Tethered MA Screen scene Purpose: Read a Real Devices's screen and compare it with a reference image


Properties:

Actor


Data



properties






System


Routes:








Properties:

Actor


System


Routes:






Capture Tethered MA Text SE scene Purpose: Capture text from an SE device's screen for use as content

Properties:

Actor


System


Routes:


Failed to capture tethered SE MA text - capture failed, because of a service error

Failed to capture tethered SE MA text (system) - capture failed, because of a system error

Android scenes WARNING: These are powerful low-level tools, which must be used with care. For advanced developers with

Android experience, only!

Use the scenes in the Real Devices/Android Group for low-level access to Android-based phones (listed below) via

the ADB, the Android Debug Bridge:

ADB Get Property

ADB Input Events

ADB resource

ADB Set Property

ADB Start Activity

Supported phones

These scenes are supported by all our Android-based EMUs, including:

the Samsung Galaxy S6 and S7 EMUs

the Samsung Galaxy Note 4 EMUs



ADB Get Property scene Purpose: Read the value of an ADB property from the specified handset

Properties:

Configurations


Data

PropName - type the name of the property to get from the handset. Default: blank

Output

Result - select the name of the Prop to store the value in (so you can use it subsequently). Default: (Nothing)

System


Routes:

OK - property has been read from the handset

Failed to get property - attempt failed due to a service error

Failed to get property (system) - attempt failed due to a system error



ADB Input Events scene Purpose: Execute a list of input ADB shell commands on the specified handset. The supported commands are

listed below.

Properties:

Configurations


Data

EventList - select the Props resource containing the list of input events to execute (see below). Default:

EventList

Sleep - type the number of seconds to sleep between each input event command. Default: 0

System


Routes:

OK - input events have been sent to the handset

Failed to input events - attempt failed due to a service error

Failed to input events (system) - attempt failed due to a system error

The Event List

You define the input events to execute by storing each one as a separate string in the StringList of the Props

resource specified by the scene's EventList parameter. Each input event is executed in sequence, starting from

member 0, with the handset sleeping between each one for the time specified by the Sleep parameter.

For example, this StringList:

Would be executed as:



1. Bring up the menu


3. Tap the dialer


5. Enter the number 1234567 into the dialer

Supported commands

You can use the following commands with this scene:

text text

Calls the adb shell input text command.

Used to input text to the active application on the device. For example: to input a telephone number to the

dialer, or text for an SMS. The text must not contain any spaces; to specify a space, type %s.

Example: text hello%sworld will enter "hello world" on the device.

tap x y

Calls the adb shell input tap command.

Used to tap the screen at the specified x and y co-ordinates.

Example: tap 500 500 will tap the screen 500 pixels to the right and down from the top left pixel.

key event

Calls the adb shell input keyevent command.

Used to enter a key event, where event is a supported event code (see below).

Example: key 6 will trigger the EndCall event.

sleep time

Calls the adb shell sleep command.

Used to make the shell sleep for the number of seconds specified by time. Note: The Sleep time set by the

scene's Sleep parameter will be ignored for this command.

Example: sleep 5 will make the shell sleep for 5 seconds before continuing to the next command.

send devicename type code value

Calls the adb shell sendevent command.

Can be used, for example, to execute gestures on the handset screen.

The devicename for the Lucid2 touchscreen is /dev/input/event1. To determine the touchscreen name on

other handsets, and for an explanation of the other parameters, visit:


To capture a touchscreen event, run adb shell getevent touchscreenname from a command prompt on the

phone and perform the gesture on the screen. This will output the codes for the events triggered by the

gesture. The event codes are output as hexadecimal values, convert them to decimal for use with the send

command.

Supported key events

For a list of supported key events codes, visit:






ADB resource Purpose: Defines the hardware (handset) that the ADB scenes will interact with

Properties:

Configurations

Hardware - select the Hardware resource (Android handset) to use. Default: Hardware



ADB Set Property scene Purpose: Set the value of an ADB property on the specified handset

Properties:

Configurations


Data

PropName - type the name of the property to set on the handset. Default: blank

PropValue - type the value to set the property to, on the handset. Note: Supports the empty string, "".

Default: blank

SuperUser - select True to set the property as the handset root user; select False to set the property as an

ordinary user. Default: True

System


Routes:

OK - property has been set on the handset

Failed to set property - attempt failed due to a service error

Failed to set property (system) - attempt failed due to a system error



ADB Start Activity scene Purpose: Start an Activity on an Android handset by using an Intent Object

Properties:

Configurations


Command

Action - type the name of the action to start on the handset. Default: blank

Component - type the name of the target component, which takes the form package/.runner-class. Default:

blank

System


If you do not specify a Component or an Action, the call will fail.

If you specify an Action but no Component, this is an Implicit Intent, which allows any component on the handset

to execute it. Use with care:

If no component can execute this action, the call will fail.

If one component can execute this action, the call will succeed.

If more than one component can execute this action, the handset will prompt the user to choose one - which

will hang the test!

If you specify a Component but no Action this is an Explicit Intent, which executes the specified component on the

handset.

If you specify an Action and a Component, this is an Explicit Intent - the specified component will execute it, as

long as it's installed and capable of doing so.

For example, to start the unlocker app:

Set Action to android.intent.action.MAIN

Set Component to com.tems.android.control/.UnlockerActivity

Routes:

OK - activity has been started on the handset

Failed to start activity - attempt failed due to a service error

Failed to start activity (system) - attempt failed due to a system error


Chapter 18 - Alarming scenes

Use the scenes in the Alarming Group to produce Agent SNMP Alarms from your scripts:

Check thresholds

Raise SNMP Trap

Raise ARF Trap

We recommend you ignore Agent SNMP Alarms and use Projector SNMP Alarms instead for system-wide and

enterprise-wide solutions. See the Installing & Managing SNMP Alarms guide for detailed information on SNMP

Alarms, MIBs, OIDs, and the MIB Toolkit.

Hint: For help with managing MIBs, install the MIB Toolkit which is available on request from our Support

Department.



Check Thresholds scene Purpose: Check a timing or metric KPI against specified threshold values and branch accordingly

Properties:

KPI

KPIType - whether the threshold applies to a timing or metric KPI. Default: Timing

Name - type the name of the KPI. Default: ResponseDelay

Transaction - type the name of the Transaction that the KPI was raised in (to check the value from that

Transaction), or leave it set to main to examine the value in all Transactions (see Aggregation). Default:

main

Processing

Aggregation - select how to aggregate the KPI if there are multiple values: Average, Maximum or

Minimum. Default: Maximum

ThresholdDirection - select the direction in which the threshold applies. Upwards means low values are

green, mid values are orange and high values are red. Downwards means high values are green, mid values

are orange and low values are red. Default: Upwards

ThresholdValue1 - type the first threshold value. This can be the high or the low value. Default: 50

ThresholdValue2 - type the other threshold value (low or high). Default: 80

Settings

Database - type the connection string for the database that the KPI is read from. You should not change this

from the default unless the server has a non-standard DBConnectString setting. Default: "Driver = MySQL

ODBC 3.51 Driver; Server = 127.0.0.1; Database = monitormaster; UID = root; Pwd=; Option = 131328;"

System


Routes:

KPI in green zone - the monitored value is below the lower threshold (if Threshold Direction is Upwards)

or above the higher threshold (if Threshold Direction is Downwards)

KPI in orange zone - the monitored value is between the two thresholds

KPI in red zone - the monitored value is above the upper threshold (if Threshold Direction is Upwards) or

below the lower threshold (if Threshold Direction is Downwards)

KPI in unknown zone - system error



Raise SNMP Trap scene Purpose: Raise an SNMP trap ("alarm")

Properties:

Data

Community - type a string, the community name used to authenticate SNMP packets. Default: public

ObjId - an array of object IDs encoded as strings

ObjType - select the data type of the objects. Choose from:

Integer (default)

OctetString

Null

ObjectID

IP Address

Counter32

Gauge32

Time ticks

Opaque

NSAP

Counter64

UnsignedInteger32

Note that all objects sent by the trap (in the ObjValue array) must be of the same data type. If you need to

send a trap with objects of different data types, use the SNMPSendTrap function in an Advanced Script

scene. See the Advanced Scripting Guide for details of this function.

ObjValue - an array of object values

RemoteHost - IP address of the remote host. If set to 255.255.255.255, the packet is broadcast on the local

subnet. Default: 255.255.255.255

SNMPVersion - version of SNMP used for outgoing packets. Choose One or Two. Default: One

TrapAgentAddress - IP address of the object generating the trap (typically the Monitor Master Agent).

Blank is interpreted as localhost

TrapEnterprise - for SNMP v2, leave blank. For SNMP v1, if TrapGenericType is EnterpriseSpecific then

type the Object ID of the object generating the trap. (The Argogroup trap OIDs are defined in the ARGO-

ARF-MIB file.) Leave blank if TrapGenericType is not EnterpriseSpecific

TrapGenericType - for SNMP v2, leave blank. For SNMP v1, choose the type of trap being sent, from:

Coldstart (default)

WarmStart

Link Down

Link Up

Authentication Failure

EGPNeighborLoss

Enterprise Specific

TrapSpecificType - for SNMP v2, leave blank. For SNMP v1, if TrapGenericType is EnterpriseSpecific then

type the last part of the OID of the trap that occurred. (The Argogroup trap OIDs are defined in the ARGO-

ARF-MIB file.) Leave blank if TrapGenericType is not EnterpriseSpecific.

System




Routes:

OK - SNMP trap has been raised

Failed to raise an SNMP trap (system) - SNMP trap has not been raised, due to a system error



Raise ARF Trap scene Purpose: Raise an ARF (Application Registration File) trap ("alarm")

Properties:

Address of Manager

RemoteHost - type the IP address of the remote host. If set to 255.255.255.255, the packet is broadcast on the

local subnet. Default: 255.255.255.255

Authentication

Community - type a string, the community name used to authenticate ARF PACKETS. DEFAULT: public

Data

MeasureName - type the name of the measure triggering the alarm

MeasureType - select the type of measure triggering the alarm: metric, message or success. Default: metric

MeasureValue - type the value of the measure triggering the alarm

MetricUnit - if the measure type is metric, type the unit it is measuring

ProblemText - type any additional text to associate with the problem

RepairAction - type the suggested repair action for this problem, if any

SpecificProblem - type a description of the reason for this problem

Source Object Details

SourceObjectDescr - type a description of the Object ID (OID) of the cause of this trap (e.g. the KPI being

monitored)

SourceObjectID - type the object ID (OID) of the cause of this trap. You must use one of the standard or

custom Source Object IDs defined in the MIBs for your monitoring solution. See the Installing & Managing

SNMP Alarms Guide for details.

System


X733 Parameters

EventTypeAndCause - select the type of problem that caused the trap from a list. Default: other

Severity - select the severity of the problem, from:

Indeterminate (default)

Critical

Major

Minor

Warning

Cleared

Trend - select the direction of change, from:

NoChange (default)

MoreSevere

LessSevere

Routes:

OK - ARF trap has been raised



Failed to raise ARF trap (system) - ARF trap has not been raised, due to a system error


Chapter 19 - Reporting scenes

Use the scenes in the Reporting Group to supplement the built-in reporting by adding user-specified data (KPIs) to

the results which are then output and analyzed just like the built-in metrics, messages and timings.

Record Message

Record Metric

Record Timing

Record Meta Tag

Record Service Type

Get GPS Location

Random

Internal Timing Point

Scale Metric

Report Hardware Platform

Data scenes

Party resources

Collector scenes

ETSI scenes

CDR scenes

Hint: To see a list of the KPIs already reported in your results, run the Screening Room or Projection Room and

select a metrics, timings or message type report from the Dimensions screen.



Record Message scene Purpose: Record a message (message type and text) in the results

Properties:

Message

MessageType - type the type of message to report, a short string. Standard types include "Error Message",

"Outcome" and "Diagnostic", but you are free to use new ones, to identify new types of message. The

message type is output before the message text in reports and can also be used to filter results when

reporting, so should be chosen with care and used consistently

Hint: To list all message types used on an Agent, run Screening Room and select Message Types from the

Dimensions reports (see the Screening Room User Guide).

Text - type the text of the message to output

System


Routes:

OK - the message has been recorded

Hint: Each distinct message you record is stored separately in the results database, which can be inefficient. If a

message includes a variable part, store it as a metric (with the Record Metric scene); that's far more efficient.



Record Metric scene Purpose: Record a metric (name, value, and units) in the results

Properties:

Metric

Name - type the name to use for the metric, a short string. Standard metrics include "User Time", "System

Availability" and "Payload TxRd Sum Bytes" but you are free to use new ones. The metric name is output

before the metric value (and units) in reports and can also be used to filter results, so should be chosen with

care and used consistently

Units - type the units the value is measured in. Standard units include "ms" (milliseconds), "s" (seconds),

"bytes", "bytes/s" and "count". Set to blank if the metric does not need units. Default: ms

Value - type the numeric value to record. Default: 0

System


Routes:

OK - the metric has been recorded

Hint: Each distinct message you record with Record Message is stored separately in the results database, which can

be inefficient. If a message includes a variable part, use Record Metric to store it as a metric, it's much more

efficient.



Record Timing scene Purpose: Record a timing (name and value) in the results

Properties:

Timing

Name - type the name to use for the timing, a short string. Monitor Master records a number of standard

timings, including "User Time", but you are free to use new ones. The timing name is output before the

timing value (and units) and can also be used to filter results, so should be chosen with care and used

consistently

Value - type the timing value to record, the number of milliseconds (or select the name of a Prop to use data

produced at runtime). Default: 0

System


Routes:

OK - the timing has been recorded

Hint: To time steps within the storyboard, consider using the Timelines Window to add Custom Timings or

Custom Transactions; see the Story Boarder User Guide for details.



Record Meta Tag scene Purpose: Record a meta tag (genre, name, and value) in the results

Properties:

Metadata

Genre - type the genre of the meta tag to record. Default: blank

Name - type the name to use for the meta tag, a short string. Default: blank

Value - type the value to record. Default: blank

System


Routes:

OK - the meta tag has been recorded



Record Service Type scene Purpose: Record a set of meta tags to help you record the service type and other aspects of the script in a consistent

manner.

Meta tags are data about data. They are used within Monitor Master to add information to help categorize results

data so it can be processed more meaningfully.

Hint: The widespread use of consistent meta tags is one way to make your results data much more useful, as you

can use them in filters and pivots in your reports.

It also generates an hash code from the script and records it (as the Script MD5 metric), so you can check if any

changes have been made to the script since you delivered it.. (This hash code is a bit like a numeric fingerprint for

the script - if anyone changes anything about the script, it will generate a different hash code.)

Properties:

Additional details

AdditionalDetail - type any additional details for the service type. For example, if you're testing an Email

service on an IMAP server, you could set ServiceType to Email and AdditionalDetail to IMAP; if you're

testing a POP3 server, you could set ServiceType to Email and AdditionalDetail to POP3. Default: blank

Combined

CombinedServiceType - select True to report a combined service type meta-tag, derived from ServiceType

and AdditionalDetail. Default: False

ServiceType

ServiceType - select the service type: DNS, Email, FTP, GPRS, MMS, Ping, SMS, Video, Voice, WAP, Web or

User. Default: DNS

UserServiceType - if you want to create your own service type, type it here and set ServiceType to User.

Default: blank

System


Version

ScriptVersion - optionally type the script's version number. Default: 4800

Routes:

OK - the meta tags have been recorded.



Get GPS Location scene Purpose: Get the current location from the Agent's GPS receiver and optionally report it in the results

Properties:

Location

Name - type a description for the location. Default: GPS-derived location

ReportAsMessage - set to True to write a GPS message to the results. Default: False

ReportAsMetric - set to True to write a GPS metric to the results. Default: False

Receiver

BaudRate - type the Baud rate to use to connect to the GPS receiver. Default: 4800

Port - type the name of the port to use to connect to the GPS receiver. Default: COM1

Timeout - type how long to wait for the GPS data before timing out, in milliseconds. Default: 10000 (10

seconds)

System


Routes:

OK - the GPS location has been obtained

Failed to get GPS location - the GPS location has not been obtained, due to a service error

Failed to get GPS location (system) - the GPS location has not been obtained, due to a system error



Random scene Purpose: Generate a (pseudo)random whole number between specified bounds

Properties:

Data

Lowerbound - type the lowest value of the range, 0 or a positive whole number. Default: 0

Upperbound - type the upper value of the range to return, a positive whole number greater than

Lowerbound. Default: 1

Data

Result - select the name of the Prop resource to write the random number to.

System


Routes:

OK - the random number has been generated



Internal timing point scene Purpose: Activate additional timing points so they will be recorded as metrics and available to the Record Content

Metrics scene

Note: For a list of timing names, see the TraceTiming function description in the Advanced Scripting Guide.

Properties:

Data

TimingPoint - type * to activate all optional timing points, or type a comma-separated list of timing point

names to activate them. Default: *

For example: FetchStart, FetchEnd, ResponseDelay

System


Routes:

OK - the timing points specified have been activated



Scale Metric scene Purpose: Re-report a metric, with options to change the name, transaction, units, and value (by multiplying it by a

scale factor)

Hint: This can be very useful for converting units, e.g. from milliseconds to seconds.

Properties:

From metric

InTransaction - type the name of the Transaction (scene) reporting the source metric, or leave blank to use

any Transaction. Default: blank

Name - type the name of the (source) metric to re-report. Default: blank

NotFoundError - select System Error to report a system error if the source metric is not found; select No

Error to carry on without error. Default: System Error

System


To metric

AsName - type the name to use for the new metric. Default: blank

Multiplier - type the number to multiply the source value by, before reporting it; type 1 to report the value

unchanged. Default: 0.001

Transaction - type the name of the Transaction to report the metric from, or leave blank to report it from this

Transaction (scene). Default: blank

Units - type the units to report the new metric in. Default: s

Routes:

OK - the metric has been re-reported successfully, or the operation has failed but NotFoundError is set to

No Error

Cannot find original metric - the source metric was not found and NotFoundError is set to System Error



Report Hardware Platform scene Purpose: Report details of the probe hardware.

The information includes:

the probe firmware version number

the probe firmware datestamp

the probe hardware version number

the bootstrap version number

the CNS Object version number

the modem's Electronic Serial Number

the PRL version number

the call duration

the hardware temperature

Also see the Checks scenes.

Properties:

Message

MissingIsFailure - select True to report an error if the version number cannot be found select false to not

error an error. Default: False

System


Routes:

OK - the hardware version has been reported successfully, or the operation has failed but MissingIsFailure

is set to False

Not a probe - the test environment is not a Monitor Master probe

Not a probe (system) - the test environment is not a Monitor Master probe

Data Scenes Use the scenes in the Reporting/Data Group to manipulate data files:

Upload File to Projector



Upload File to Projector scene Purpose: Stores one or more data files on a Projector so they can be accessed later (e.g. after the testrun has

finished) by using FTP.

You can only use this scene if your system administrator has set up an FTP Server on the Projector. Check

availability with your system administrator - as well as the user name, password, port and path (or site

configuration file) to use.

Hint: If you want to delete the files after uploading them, use the Delete File scene.

Note: You will usually want to send the file over the LAN, rather than a data connection. However, if a data

connection is open, it will use that instead:

If a data connection is open but you want to send the file over the LAN, close the data connection (by using

Drop Data Connection) before using this scene

If a data connection is not open but you want to use one to send the file, open the connection (using Make

Data Connection) before using this scene

Properties:

Authentication

Password - type the password to use to FTP the Projector. May be overriden (see XMLFile). Default: blank

User - type the username to use to FTP the Projector. May be overriden (see XMLFile). Default: blank

Completion

ErrorIfFileNotFound - set to True to report a system error if the local file could not be found; set to False to

report no error. Default: True

ErrorIfUploadFailed - set to True to report a system error if the upload failed; set to False to report no error.

Default: True

MessageType - type the Message Type to use to report a successful upload. The message will include the

filename. Default: blank

Configuration

SaveContent - set this to False if you do not want to save a new content record once the file has been

uploaded. Default: True

XMLFile - leave set to nothing to use this scene's settings to configure FTP; select an XML File resource to

override the Password, User, DestPath, Port and Projector settings with values from the Site Configuration

File selected by the resource. Default: nothing

If a Site Configuration File has been created and deployed by your system administrator (as described in

Installing & Managing Monitor Master), it should provide the correct settings to use your FTP Server - to save

you entering them manually.

Note: If the specified Site Configuration File is not found, the scene will use its own default settings. It will

not report an error.

Destination

AgentTestPrefix - select True to prefix the uploaded filename with the Agent name and testrun sequence

number; select False to add no prefix. This is useful when uploading IP Trace files, as it produces a unique

filename to avoid overwriting previous results. Default: False

DestPath - type the pathname of the folder on the FTP server where you want to put the file. May be

overriden (see XMLFile). Default: "./" which means used the user's home directory.



Port - the port number to use for the FTP server. May be overriden (see XMLFile). Default: 21, the port

normally used by FTP servers. You should only change this if you know the Projector's FTP server has been

configured to be on a different port.

Projector - type the Projector's IP address or host name, or leave blank to use the currently configured

Projector. May be overriden (see XMLFile.) Default: blank

RemoveExtension - select True to remove the extension (e.g. .mp3) from the filename on destination system,

or False to keep it. Default: False

Suffix - type text to add as an extension to the uploaded file name. Use this to add an extension if the local

file name has none (for example: to upload IP Trace files, type the ".pcap" extension) or to change the

extension (by setting RemoveExtension to True). Leave blank if the local filename already has the correct

extension. Default: blank

Source

LocalFile - type the pathname of the local file to upload, or use a Prop resource with the pathname in it. For

example, select a Prop that has been filled with the name of the Diagnostics Trace file.

LocalFiles - select a Props resource containing the pathname of each local file to upload. For example, select

a Props resource that has been filled with the names of degraded files by the Measure Voice Quality scene.

Note: If you specify a file with LocalFile and a set of files with LocalFiles, then all these files will be

uploaded. If you don't set either property, this scene has no effect

The pathname used on the FTP server (for the uploaded copy) is DestPath plus the local file's name (from

LocalFile or LocalFiles) plus Suffix. For example, if DestPath is /UploadedFiles, LocalFile is

D:\temp\FileToUpload.tmp, and Suffix is blank, the file will be uploaded to

/UploadedFiles/FileToUpload.tmp

If AgentTestPrefix is True, the Agent name and testrun sequence number will be added to the start of the

local file name.

System


Transfer

Mode - choose whether to use Active or Passive FTP mode. Default: Active

Timeout - how long (seconds) to allow for the FTP transfer before timing out. This should be adjusted for

large files and slow connections. Default: 60

Routes:

OK - the file or files have been uploaded to the Projector

Failed to upload file to Projector (system) - the upload could not complete. Possible reasons include:

Projector address is incorrect, or blank and Agent is not configured to connect to an Projector

Projector port number is incorrect

Projector is protected by a firewall

Projector is not configured for FTP

User credentials (user name or password) are incorrect

Upload path is not available

Not enough disk space for the file

The error code for each reason depends on the configuration of the FTP server.



Party resources Use the resources in the Reporting/Party Group in the Data party of a multi-party script, to export results to the

Collector party for it to use:

Propagate Metrics

Propagate Messages

Propagate Timings



Propagate Metrics resource Purpose: Copies Metrics from this party to the Collector in a multi-party script, so the Collector can access them.

The Collector can access propagated Metrics by using the Rereport Metrics scene or Aggregate Metrics scene. If

you are using the Reporting Framework, you can use the Rereport Testcase Metrics scene to export them to your

Reporting Framework Dashboards.

You can also use an Advanced Script - see Creating Multi-party Scripts, in Chapter 4 of the Advanced Scripting Guide.

Properties:

Data

ApplyFilter - whether to apply the MetricNames and TransactionNames filters, True or False. If False, all

this party's Metrics will be propagated. Default: True

MetricNames - a list of strings, the names of the Metrics to propagate. Click the button to display the List

of Strings dialog, to define the names.

TransactionNames - a list of strings, the names of the Transactions to propagate from. Click the button to

display the List of Strings dialog, to define the names.

If ApplyFilter is True, a Metric will propagate if it is named in MetricNames and output by a Transaction named in

TransactionNames.



Propagate Messages resource Purpose: Copies Messages from this party to the Collector in a multi-party script, so the Collector can access them.

The Collector can access propagated Messages by using the Rereport Messages scene or Rereport a Message scene.

If you are using the Reporting Framework, you can use the Rereport Testcase Messages scene to export them to

your Reporting Framework Dashboards.


Properties:

Data

ApplyFilter - whether to apply the MessageNames and TransactionNames filters, True or False. If False, all

this party's Messages will be propagated. Default: True

MessageNames - a list of strings, the names of the Messages to propagate. Click the button to display the

List of Strings dialog, to define the names.

TransactionNames - a list of strings, the names of the Transactions to propagate from. Click the button to

display the List of Strings dialog, to define the names.

Note: If ApplyFilter is True, a Message will only propagate if named in MessageNames and output by a

Transaction named in TransactionNames.



Propagate Timings resource Purpose: Copies Timings from this party to the Collector in a multi-party script, so the Collector can access them.

The Collector can access propagated Timings by using the Rereport Metrics scene or Aggregate Timings scene. If

you are using the Reporting Framework, you can use the Rereport Testcase Metrics scene to export them to your

Reporting Framework Dashboards.


Properties:

Data

ApplyFilter - whether to apply the TimingNames and TransactionNames filters, True or False. If False, all

this party's Timings will be propagated. Default: True

TimingNames - a list of strings, the names of the Timings to propagate. Click the button to display the

List of Strings dialog, to define the names.

TransactionNames - a list of strings, the names of the Transactions to propagate Timings from. Click the

button to display the List of Strings dialog, to define the names.

Note: If ApplyFilter is True, a Timing will only propagate if named in TimingNames and output by a Transaction

named in TransactionNames.

Collector scenes Use the scenes in the Reporting/Collector Group in the Collector party of a multi-party script, to collect results

exported from the Data parties:

Combine Availabilities

Aggregate Metrics

Rereport Metrics

Aggregate Timings

Rereport Messages

Rereport a Message

See Party resources for information on exporting results from Data parties.



Combine Availabilities scene Purpose: Combines system and service availabilities from all parties to produce a single result for each, which will

be returned as the Collector's availabilities.

The availability is returned as failure if any of the parties fail

Note: Should be used in the Collector script of a multi-party script.

Properties:

Collector

Ignore Service Unknown - whether to ignore availabilities returned as "unknown" (treat them as "success"):

True or False. Default: False

System


Routes:

OK - the availabilities have been combined

Failed to combine availabilities - the action failed, due to a service error

Failed to combine availabilities (system) - the action failed, due to a system error



Aggregate Metrics scene Purpose: Combines Metrics propagated from other parties.

Note: Should be used in the Collector script of a multi-party script. The Metrics must have been propagated with

the Propagate Metrics scene.

Properties:

Collector

Aggregation Mode - select how to combine the metrics: Delta (return the difference between them). Default:

blank

Metrics- the list of metrics to aggregate. Click the button to display the List of Strings dialog, to define

the names. For a Delta aggregation, select two metrics. Default: blank

Type a Metric name in the format party/transaction/name. For example, to specify the UserTime metric from

the main transaction in the Sender party, type Sender/main/UserTime

Output

Metric Name - the name to use to report the result. Default: blank

Result - the Prop to store the result in, optional. Default: (Nothing)

Resource

Collector - the Collector resource to use. Default: blank

System


Routes:

OK - the metrics have been aggregated

Failed to aggregate metrics (system) - the action failed, due to a system error



Rereport Metrics scene Purpose: Re-report Metrics propagated from other parties.

Note: Should be used in the Collector script of a multi-party script. The Metrics must have been propagated with

the Propagate Metrics scene.

Properties:

Collector

Metrics- the list of metrics to report. Click the button to display the List of Strings dialog, to define the

names. Default: blank

Type a Metric name in the format party/transaction/name. For example, to specify the UserTime metric from

the main transaction in the Sender party, type Sender/main/UserTime

NotFoundError - select whether to return an error if any of the specified metrics does not exist. Default:

system error

Output

MetricName - type a new name to rename a single metric. Leave blank to use the original name. Leave

blank if re-reporting more than one metric, or all the metrics will have the same name! (You can add a

prefix or suffix to the names to distinguish them from the original metrics by using the next two

properties.) Default: blank

MetricNamePrefix - type text to add to the start of the metric name(s). Optional. Default: blank

MetricNameSuffix - type text to add to the end of the metric name(s). Optional. Default: blank

Resource


System


Routes:

OK - the metrics have been re-reported

Failed to re-report metrics (system) - the action failed, due to a system error



Aggregate Timings scene Purpose: Calculates the difference between two Timings propagated from other parties.

Note: Should be used in the Collector party of a multi-party script. The Timings must have been propagated with

the Propagate Timings scene and must both be intervals or timestamps.

Properties:

Collector

AllowTwoTimings - set to True to allow two timings from the same scene with the same name; leave set to

False to report this as an error. Default: False for new scripts but True for old (pre-8.5) scripts

There are occasions where a scene can legitimately record two timings with the same name (as in some of

the Standard Scripts). Three or more timings from the same scene with the same name will always be

treated as an error.

EndTiming - type the name of the end timing point. Default: blank

NotFoundError - select the error path to take if either timing point (StartTiming or EndTiming) is not

found: SystemError or NoError. Default: SystemError

StartTiming - type the name of the start timing point. Default: blank

Type a Timing point name in the format party/transaction/name. For example, to specify the Start time for the

Make Voice Call transaction in the Caller party, type Caller/Make Voice Call/Start

Output

MetricName - the name to use to report the result. Default: blank


Resource


System


Routes:

OK - the timings have been aggregated

Failed to aggregate metrics (system) - the action failed, due to a system error



Rereport Messages scene Purpose: Reports Messages propagated from other parties.

Note: Should be used in the Collector script of a multi-party script. The Messages must have been propagated with

the Propagate Messages scene.

By specifying the message name (type) to re-report you can, for example, output all Error messages from all the

parties in a complex script in one place in the collector, for your convenience.

Properties:

Collector

Messages - the list of messages to re-report. Click the button to display the List of Strings dialog, and

add the names. Default: blank

Type Message names in the format party/transaction/type. For example, to re-report all Info messages from

the Sender party, type Sender//Info or, to re-report all Info messages, type //Info

Output

Message Name - type a new name (type) for the messages (optional) or leave blank to use the current

name. Default: blank


Resource


System


Routes:

OK - the messages have been aggregated

Failed to aggregate messages (system) - the action failed, due to a system error



Rereport a Message scene Purpose: Reports a Message propagated from another party.

Note: Should be used in the Collector script of a multi-party script. The Message must have been propagated with

the Propagate Messages scene.

Properties:

Collector

Message - type the message to re-report. Default: blank

Type the Message name in the format party/transaction/type. For example, to re-report the Info message from

the Sender party, type Sender//Info or, to re-report the Info message from the Sender party's Script

transaction, type Sender/Script/Info

Output

Message Name - type a new name (type) for the message (optional) or leave blank to use the current



Resource


System


Routes:

OK - the messages have been aggregated

Failed to aggregate messages (system) - the action failed, due to a system error

ETSI scenes Use the scenes in the Reporting/ETSI Group to calculate ETSI-compliant metrics. These scenes were developed for

use in the Standard Scripts and will probably be of interest only if adapting these Standard Scripts:

ETSI KPI Reporter

ETSI Network Non-Accessibility

ETSI Generic KPI Calculator resource

ETSI HTTP KPI Calculator resource

ETSI FTP-DL KPI Calculator resource

ETSI FTP-UL KPI Calculator resource

ETSI SMS KPI Calculator resource

ETSI GPRS Attach KPI Calculator resource

ETSI PDP Context Activation KPI Calculator resource

ETSI Voice KPI Calculator resource

ETSI WAP KPI Calculator resource

ETSI DNS KPI Calculator resource

ETSI Ping KPI Calculator resource

The ETSI KPI Calculator resources are used to configure how various ETSI KPIs should be calculated.



ETSI KPI Reporter scene Purpose: Reports ETSI KPIs from the specified scene The KPIs output depend which KPI Calculator the

ETSIApplicationKPICalculator property is set to.

Properties:

Application

Applicationscene - type the name of the scene reporting the KPI. Default: blank

ETSIApplicationKPICalculator - select the ETSI Application KPI Calculator resource to use - this dictates

which set of KPIs is reported. Default: Nothing

Generic/Data

ClientIPAddress - the IP address of the modem/client to use to filter the IP Trace. Select the Prop containing

the IP address written by the Make Data Connection scene. Default: blank

DataConnectionscene - select the scene that made the data connection. Default: Make data connection

DiagnosticsTraceReporterscene - select the scene to use for the Diagnostics Trace. Default: Diagnostics

Trace Reporter

ETSIGenericKPICalculator - select the ETSI Generic KPI Calculator resource to use. Default: Nothing

PPPAddress - select the Prop containing the PPP address to use to filter the IP Trace to calculate aproximate

PDP Context Activation Times (if Radio Trace is not available). Default: (Nothing)

Layer3

Layer3ReportXMLFileName - type the name of the Layer 3 Report file. Default: blank

System


Routes:

OK - the KPIs have been generated

Failed to generate KPIs - the KPIs have not been generated, due to a service error

Failed to generate KPIs (system) - the KPIs have not been generated, due to a system error



ETSI Network Non-Accessibility scene Purpose: Report the ETSI Non-accessibility KPI (for the home network) and other network metrics

Note: This scene is not reported by the F3607 modem and will report a system error if used with it.

Properties:

Actor

Modem - select the Modem resource to use

Generic/Data

ETSIGenericKPICalculator - select the ETSI Generic KPI Calculator resource to use. Default:

ETSIGenericKPICalculator

Reporting

ReportBearer - select True to report the bearer. Default: False

ReportSignalStrengthdBm - select True to report the signal strength in dBm (from -113dBm to -51dBm).

Default: False

ReportSignalStrengthdPercentage - select True to report the signal strength as a percentage (0 to 100%).

Default: False

ReportSignalStrengthRSSI - select True to report the signal strength in RSSI (0 to 31). Default: True

Roaming

AllowRoamingRegistration - select True to allow the modem to register on another network (for roaming

tests). Default: False

System


Routes:

OK - the KPIs have been generated

Failed to register on home network - the KPIs have not been generated, the modem has failed to register on

its network

Failed to generate KPIs (system) - the KPIs have not been generated, due to a system error



ETSI Generic KPI Calculator resource Purpose: Configures the ETSI Generic KPI Calculator, which is used by the ETSI Network Non-Accessibility and

ETSI KPI Reporter scenes.

Properties:

Timeouts

DNSResolutionTimeout - type the time (in seconds) to wait for DNS lookup to succeed. Default: 30

GPRSAttachTimeout - type the time (in seconds) to wait for GPRS Attach to succeed. Default: 75

PDPContextActivationTimeout - type the time (in seconds) to wait for PDP Context Activation to succeed.

Default: 150



ETSI HTTP KPI Calculator resource Purpose: Configures the ETSI HTTP KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

KPI Method

KPIMethodDefault - select the HTTP KPI method to use: A or B. Method A uses reception of first packet

containing content; method B uses sending of first GET request. Default: A

KPIMethodOverrideProp - select the name of a Prop which can be used to override the default KPI

Method. This Prop must contain "methoda" or "methodb". Optional. Default: Nothing

Metrics

ReportApplicationLayerMetrics - select True to report application layer (ETSI-approximate) metrics even

if more accurate Radio Trace (ETSI) metrics are available. Should be left set to False unless debugging.

Default: False

Timeouts

HTTPDataTransferTimeout - type the time (in seconds) to wait for HTTP data transfer to succeed. Default:

34

HTTPServiceAccessTimeout - type the time (in seconds) to wait for HTTP IP service access and HTTP IP

service setup to succeed. Default: 30

HTTPServiceAccessibilityTimeout - type the time (in seconds) to wait for HTTP service access and HTTP

setup to succeed. Default: 180



ETSI FTP-DL KPI Calculator resource Purpose: Configures the ETSI FTP Download KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

KPI Method

KPIMethodDefault - select the HTTP KPI method to use: A uses reception of first packet containing

content; B uses sending of first GET request. Default: A



Metrics



Default: False

Timeouts

FTPDataTransferTimeout - type the time (in seconds) to wait for FTP data transfer to succeed. Default: 82

FTPDataTransferTimeoutOverrideProp - select the name of a Prop which can be used to override the

default FTP Data Transfer Timeout. This Prop must contain the timeout in seconds". Optional. Default:

Nothing

FTPServiceAccessTimeout - type the time (in seconds) to wait for FTP IP service access and FTP IP service


FTPServiceAccessibilityTimeout - type the time (in seconds) to wait for FTP service access and FTP setup

to succeed. Default: 180



ETSI FTP-UL KPI Calculator resource Purpose: Configures the ETSI FTP Upload KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

KPI Method

KPIMethodDefault - select the HTTP KPI method to use: A uses reception of first packet containing

content; B uses sending of first GET request. Default: A



Metrics



Default: False

Timeouts

FTPDataTransferTimeout - type the time (in seconds) to wait for FTP data transfer to succeed. Default: 82

FTPDataTransferTimeoutOverrideProp - select the name of a Prop which can be used to override the

default FTP Data Transfer Timeout. This Prop must contain the timeout in seconds". Optional. Default:

Nothing

FTPServiceAccessTimeout - type the time (in seconds) to wait for FTP IP service access and FTP IP service


FTPServiceAccessibilityTimeout - type the time (in seconds) to wait for FTP service access and FTP setup

to succeed. Default: 180



ETSI SMS KPI Calculator resource Purpose: Configures the ETSI SMS KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False

Party

PartyType - select the party type so the metrics can be calculated correctly. Select MO if the message

originator, select MT if the message receiver; select Collector if the collector. Default: MO

Resource

Collector - select the Collector resource to use. Default: Nothing

SMS Contents

SMSContents - select the name of a Prop containing the SMS Contents to match on. Only used for MT KPIs.

Optional. Default: 82

Timeouts

SMSEndtoEndDeliveryTimeout - type the time (in seconds) to wait from sending the SMS to its receipt.

Default: 175

SMSServiceAccessibilityTimeout - type the time (in seconds) to set the Service Accessibility SMS MO and

Access Delay SMS MO timeouts to. Default: 65



ETSI GPRS Attach KPI Calculator resource Purpose: Configures the ETSI GPRS Attach KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False



ETSI PDP Context Activation KPI Calculator resource Purpose: Configures the ETSI PDP Context Activation KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False



ETSI Voice KPI Calculator resource Purpose: Configures the ETSI Voice KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False

Party

PartyType - select the party type so the metrics can be calculated correctly. Select MO if the message

originator, select MT if the message receiver; select Collector if the collector. Default: MO

Resource

Collector - select the Collector resource to use. Default: Nothing

Timeouts

VoiceServiceAccessibilityTimeout - type the time (in seconds) to wait for voice service access to succeed.

Default: 20

VoiceServiceAccessibilityTimeoutOverrideProp - select the name of a Prop which can be used to override

the default Voice Service Accessibility Timeout. This Prop must contain the timeout in seconds. Optional.

Default: Nothing



ETSI WAP KPI Calculator resource Purpose: Configures the ETSI WAP KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False

Timeouts

WAPActivationTimeout - WAP 1.x only. Type the time (in seconds) to use for the WAP Activation Failure

Ratio and WAP Activation Timeouts. Default: 30

WAPDataTransferTimeout - type the time (in seconds) to wait for WAP data transfer to succeed. Default:

60

WAPIPAccessTimeout - WAP 2.x only. Type the time (in seconds) to use for the WAP IP Access Failure

Ratio and WAP IP Access Setup timeouts. Default: 30

WAPServiceAccessibilityTimeout - type the time (in seconds) to wait for HTTP service access and HTTP




ETSI DNS KPI Calculator resource Purpose: Configures the ETSI DNS KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False



ETSI Ping KPI Calculator resource Purpose: Configures the ETSI Ping KPI Calculator, used by the ETSI KPI Reporter scene

Properties:

Metrics



Default: False

CDR scenes Use the scenes in the Reporting/CDR Group to create and report Call Data Records:

CDR Reporter

CDR Calculator resource



CDR Reporter scene Purpose: Reports CDRs (Call Data Records) from the specified scenes.

Properties:

CDR Calculator resource

CDRCalculator - select the CDR Calculator resource to use. Default: CDR Calculator

CDR Metric Names

CDRMetricNameSuffix - type text to add after the name of each CDR Metric. Useful to distinguish the

metrics from each CDR Reporter scenes when using more than one in a party. Optional. Default: blank

Data

ClientIPAddress - if you're only interested in the data sent to/from a specific client, type its IP address here

to filter the data. Default: blank

Reporting

ReportCDRFilter - a filter to select which CDRs to report, displayed as (StringBoolList). To see the list, click

(StringBoolList) to display a button, then click the button:

Tick the information you want to include, then click OK to return to the main properties window.

Scene Names

AnswerVoiceCallscene - type the name of the scene used to answer the voice call. Default: Answer voice

call

MakeDataConnectionscene - type the name of the scene used to make the data connection. Default: Make

data connection

MakeVoiceCallscene - type the name of the scene used to make the voice call. Default: Make Voice Call

ReceiveMMSNotificationscene - type the name of the scene used to receive the MMS notification. Default:

Receive MMS Notification

ReceiveSMSscene - type the name of the scene used to receive the SMS message. Default: Receive SMS

SendSMSscene - type the name of the scene used to send the SMS message. Default: Send SMS

System


Routes:



OK - the CDRs have been generated

Failed to generate CDRs - the CDRs have not been generated, due to a service error

Failed to generate CDRs (system) - the CDRs have not been generated, due to a system error



CDR Calculator resource Purpose: Added automatically when you add the CDR Reporter scene, this resource provides code to support that

scene.

Properties:

This resource has no configuration properties


Chapter 20 - Integration scenes

Use the scenes in the Integration Group to integrate Monitor Master scripts with external systems:

Run Local Command

Access a Database

Chapter 20 - Integration scenes


Run Local Command scene Purpose: Run a console (DOS shell) command on the Agent

Properties:

Command

Command - type the console command to execute. Default: blank

Timeout - type the time (in seconds) to wait for the command to complete, providing some simple error-

detection for the command. Default: 60

Result

Keyword - type an optional keyword to search the command output. A different route will then be taken

depending on whether or not the keyword was matched, providing simple error-detection or output

matching for the command. Default: blank

OutputAsContent - choose True to treat the command output as (text) content. Default: False

System


Routes:

OK - the console command executed and the output contained the specified keyword (or the keyword was

blank).

Output did not contain keyword - the console command executed but its output did not include the

specified keyword

Command timed out - the console command did not complete within the specified timeout period

Failed to run command - the console command did not run



Access a Database scene Purpose: Run a database query or command

Properties:

Query

Database - type the connection string for the database to connect to, as either a fully qualified ODBC

connection string, or a pre-defined ODBC DSN (such as an MySQL, SQL Server, or Excel file). Default:

"Driver = MySQL ODBC 3.51 Driver ; Server = 127.0.0.1; Database = monitormaster; UID= root; Pwd=;

Option = 131328;" (the correct ODBC connection string for this Agent)

Query - type the database query or command that you wish to execute. For details, refer to your database

user documentation. Default: "SELECT * FROM DatabaseSchema;"

RowLimit - type the maximum number of rows to retrieve from the database. Default: 20

Timeout - type the time (in seconds) to wait for the query to complete, providing some simple error-

detection for the command. Default: 60

Result

Keyword - type an optional keyword to search the query output for. A different route will then be taken

depending on whether or not the keyword was matched, providing simple error-detection. Default: blank

OutputAsContent - choose True to treat the query output as a piece of report-style XML or text content.

Default: False

System


Routes:

OK - the query executed and the output contained the specified keyword (or the keyword was blank).

Output did not contain keyword - the query executed but its output did not include the specified keyword

Query timed out - the query did not complete within the specified timeout period

Failed to run query - the query did not run


Chapter 21 - CDMA scenes

Use the scenes and resources in the CDMA Group to test a CDMA network, using a CDMA SmartModem. These

scenes should not be used on a GSM network!

Note: The MC5728V (SW5728V) CDMA modem can be ordered in a custom configuration, as a Type 2 Modem. In

this configuration, you must use the standard scenes and resource - not the CDMA ones listed in this chapter.

Many other scenes and resources can be used with CDMA networks; see Appendix C for a table summarising

compatibility. For an overview of writing test scripts for a CDMA network, see Appendix B.

Resources:

MDNCSVList

Scenes:

CDMA Setup Modem

CDMA Report Party

CDMA Report Byte Count

CDMA Report Hardware

CDMA Report Network Info

CDMA Report Voice TimeStamps

CDMA Make Voice Call

CDMA Receive Voice Call

CDMA Drop Voice Call

CDMA Enable Call-forwarding

CDMA Disable Call-forwarding

CDMA Send DTMF Tone

CDMA Send DTMF Sequence

CDMA MDN CSV List Get First

CDMA MDN CSV List Get Next

CDMA Set Mobile Id

CDMA Set Network

CDMA Set Active NAM

CDMA Write PRL File

CDMA Set CDMA Mode

CDMA Set Akey

CDMA Reset Modem

CDMA Enable Notifications

CDMA Report Notifications

CDMA Receive MMS DM



MDNCSVList resource Note: For use on CDMA networks only.

Purpose: Defines the location of a MDN list in CSV format, for use by the MDN CSV List Get First and MDN

CSV List Get Next scenes

Properties:

CSV_File - type a fully qualified filename for the CSV file containing the MDNs to process, relative to the

Agent that will execute the script. Default: blank.

File format

The first row contains column headers (ESN, MSL, MDN and MSID - in any order). Subsequent rows each

correspond to a separate MDN, providing the values for these four fields:

ESN - Electronic Serial Number (identifies the modem), in hexadecimal

MSL - Master Subsidy Lock (also called "lock code", "activation code", "service provisioning lock" or "one

time subsidy lock")

MDN - Mobile Directory Number, can contain hyphens ("phone number")

MSID - Mobile Station ID, can contain hyphens (also called "MIN", may be the same as the MDN)

For example:

MDN,MSID,ESN,MSL 104-108-0031,104-108-0031,80318785,126658 506-100-0016,506-302-0624,80318785,126658 592-127-2464,592-127-2464,80318785,126658 710-159-6790,710-159-6790,80318785,126658 726-782-1718,726-320-3214,80318785,126658 106-913-6734,106-913-6734,80318785,126658 404-459-6718,404-557-0301,80318785,126658 510-138-6718,510-310-0851,80318785,126658 801-329-6739,801-705-0998,80318785,126658 940-363-6821,801-705-9475,80318785,126658 510-158-0158,510-158-0158,80318785,126658 530-321-6718,530-494-0790,80318785,126658 104-309-6716,104-309-6716,80318785,126658 506-169-0078,506-169-0078,80318785,126658

For information on testing CDMA networks, see the CDMA scenes, Appendix B and Appendix C.



CDMA Setup Modem scene Purpose: To force programming of a CDMA modem, in Central Mode. Not generally needed, as the modem is

programmed automatically with the appropriate Subscriber details when the script is run (as specified by the

CDMA Hardware resource settings).

Note: Ths scene is ignored in Local Mode.

Properties:

Notes:

1. These settings are ignored in Local Mode.

2. The Subscriber details must include the appropriate MIN and MSL to enable NAM programming.

Hardware

CDMAHardware - select the CDMA Hardware resource to use

System


Routes:

OK - the modem has been set up

Failed to setup modem - failed due to a service failure

Failed to setup modem (system) - failed due to a system failure



CDMA Report Party scene Purpose: To report phone identity during a CDMA voice call. Deprecated

This function is no longer needed to set up a call.

Properties:

Hardware


Party Name

PartyName - type the name to assign to a communicator in the call (this mobile station). Default: Party A

Reporting Options

Network - whether to report details of the network attachment of this mobile station, True or False. Default:

True

Signal - whether to report details of the signal experience of this mobile station, True or False. Default: True

System


Routes:

OK - success, the report has been made

Failed to report CDMA Party - the report failed due to service failure.

Failed to report CDMA Party (system) - the report failed due to system failure



CDMA Report Byte Counters scene Purpose: To report byte counts during or after a CDMA data call.

Properties:

Hardware


Reporting Options

CurrentRxBytes - whether to report the number of bytes received so far during a data call, True or False.

Default: True

CurrentTxBytes - whether to report the number of bytes sent so far during a data call, True or False.

Default: True

TotalRxBytes - whether to report the total number of bytes received since the counter was reset, True or

False. Default: True

TotalRxBytes - whether to report the total number of bytes received since the counter was reset, True or

False. Default: True

System


Routes:


Failed to report byte counters - the report failed due to service failure.

Failed to report byte counters (system) - the report failed due to system failure



CDMA Report Hardware Info scene Warning: This scene must not be used during a data call.

Purpose: To report hardware details for a CDMA modem.

Properties:

Hardware


Reporting Options

Whether to report the following facts about the modem, True or False. Default: True for all

BootVer - the modem bootstrap/loader version

CnsObjVer - the level of the CnS interface supported by the modem

CumulativeCallDur - the total length (minutes) of all calls made by the modem

ESN - the modem ESN

FirmwareDate - the date the modem firmware was built

FirmwareVer - the version number of the modem application firmware

HardwareVer - the revision level of the modem hardware

PRLVer - the version number of the modem's Preferred Roaming List (PRL)

Temp - the temperature of the modem's radio (degrees Centigrade)

System


Routes:


Failed to report hardware info - the report failed due to service failure.

Failed to report hardware info (system) - the report failed due to system failure



CDMA Report Network Info scene Warning: This scene must not be used during a data call.

Purpose: To report network details for a CDMA modem.

Properties:

Hardware


Reporting Options

Whether to report the following facts about the modem, True or False. Default: True for all except

FrameErrorRate (False)

BandClass - the modem's current band class

BSLoc - the location of the network base station that the modem is communicating with

CDMATime - the system time in the CDMA network

ChannelNo - the current 1xRTT active channel number (0 if digital service not available)

ChannelState - the current 1xRTT channel acquisition state for the modem

CurrentNID - the Network Identifier of the network providing service

CurrentSID - the System Identifier of the network providing service

FrameErrorRate - frame count and number of bad frames (only available for IS-95 data calls)

HDRRoamState - the roam state for the HDR service

ProtocolRev - the Protocol Revision Number reported by the base station that the modem is communicating

with

RoamState - whether roaming is available, and if so, whether SIDs are guaranteed valid

RSSIEcIo - the RSSI and Ec/Io values for both CDMA and HDR services

ServiceInd - the type of network service currently available to the modem

System


Routes:


Failed to report Network info - the report failed due to service failure.

Failed to report Network info (system) - the report failed due to system failure



CDMA Report Voice TimeStamps scene Purpose: To report the voice call timestamps for all events during the current or most recent CDMA voice call.

Hardware


System


Routes:


Failed to report voice timestamps - report failed due to service failure.

Failed to report voice timestamps (system) - report failed due to system failure



CDMA Make Voice Call scene Purpose: To make a CDMA voice call or wait for an event.

Properties:

Basic

Recipient - select the User resource to call. Default: blank

Timeout - select the time to wait before timing out, from 5 to 65535 seconds. Default: 30

Call Control

Mode - select the kind of call to make or event to wait for: WaitConnecting, WaitConnected, AsFlashCall,

or MergeFlashCall. Default: WaitConnected

Hardware


System


Routes:


Failed to make voice call - call failed due to service failure




CDMA Receive voice call scene Purpose: To answer a voice call on a CDMA modem.

Properties:

Call Control

Caller - select a User resource to answer calls from this user only; set to (Nothing) to answer any call.

Default: (Nothing)

Mode - select the kind of call or event to wait for from: Ringing (call is waiting), Accept (incoming call is

automatically accepted), Connect (autoaccept and wait for the traffic channel to establish itself).

FlashCallRinging (ringing while on another call) FlashCallAccept (auto-accept call while on another call).

Default: Ringing

Timeout - select the time to wait before timing out, from 5 to 65535 seconds. Default: 60

Hardware


System


Routes:

OK - call has been received

Failed to receive voice call - attempt to receive call failed due to a service error

Failed to receive voice call (system) - attempt to receive call failed due to a system error



CDMA Drop Voice Call scene Purpose: To end some or all CDMA voice calls.

Properties:

Call Control

Mode - select the kinds of call to disconnect: DisconnectAll (statefully disconnect all calls), DisconnectFlash

(statefully disconnect third party calls), or ForcedDisconnectAll (drop all calls, regardless of state). Default:

DisconnectAll

Hardware


System


Routes:

OK - success, the specified voice calls have been dropped

Failed to drop voice calls - call drop attempt failed due to service failure.

Failed to drop voice calls (system) - call drop attempt failed due to system failure



CDMA Enable Call-Forwarding scene Purpose: To enable call forwarding on a CDMA modem.

Properties:

Basic

DialString - type the string to dial to enable Call Forwarding on this network; *72 is used by Sprint and

Verizon. Default: *72

Recipient - select the User resource to receive the forwarded call. Default:

Timeout - select the time (seconds) to wait before timing out the redirection command. Default: 30

Hardware


System


Routes:

OK - call-forwarding has been enabled

Failed to enable call-forwarding - call forwarding has not been enabled failed due to a service error

Failed to enable call-forwarding (system) - call forwarding has not been enabled due to a system error



CDMA Disable Call-Forwarding scene Purpose: To disable call forwarding on a CDMA modem.

Properties:

Basic

DialString - type the string to dial to disable Call Forwarding on this network; *720 is used by Sprint and

Verizon. Default: *720

Timeout - select the time (seconds) to wait before timing out the redirection command. Default: 30

Hardware


System


Routes:

OK - call-forwarding has been disabled

Failed to disable call-forwarding - call forwarding has not been disabled due to a service error

Failed to disable call-forwarding (system) - call forwarding has not been disabled due to a system error



CDMA Send DTMF Tone scene Purpose: To send a single DTMF tone (Key press) on a CDMA modem.

Properties:

Hardware


Misc

Key - type a single key character to "press": * # 0 1 2 3 4 5 6 7 8 or 9. Default: blank

System


Routes:

OK - tone has been sent

Failed to send a DTMF Key press - tone has not been sent due to a service error

Failed to send a DTMF Key press (system) - tone has not been sent due to a system error



CDMA Send DTMF Sequence scene Purpose: To send a sequence of DTMF tones (Key presses) on a CDMA modem.

Properties:

Hardware


Misc

Key - type the sequence of key presses to send, using: * # 0 1 2 3 4 5 6 7 8 and 9. Default: blank

System


Routes:

OK - key sequence has been sent

Failed to send a DTMF Key sequence - key sequence has not been sent due to a service error

Failed to send a DTMF Key sequence (system) - key sequence has not been sent due to a system error



CDMA MDN CSV List Get First scene Purpose: To get the first MDN from a CSV List resource for use on a CDMA modem.

Use this scene to open a list of MDNs stored in a CSV format file. See the MDNCSVList resource for details.

Properties:

Data

MDNEntry - select the PropStore resource to receive the MDN object (consisting of ESN, MSL, MDN and

MSID).

System

MDNCSVList - select the MDNCSVList resource to read the MDN from.

Routes:

OK - first MDN has been fetched

Failed to find first MDN CSV entry - first MDN has not been fetched due to a system error



CDMA MDN CSV List Get Next scene Purpose: To get the next MDN from a CSV List resource for use on a CDMA modem.

Use this scene to loop through a list of MDNs stored in a CSV format file. See the MDNCSVList resource for

details.

Properties:

Data

MDNEntry - select the PropStore resource to receive the MDN object (consisting of ESN, MSL, MDN and

MSID).

System

MDNCSVList - select the MDNCSVList resource to read the next MDN from.

Routes:

Values remaining - MDN has been fetched and there are more to fetch

No values remaining - MDN and there are no more to fetch



CDMA Set Mobile Id scene Purpose: To change the MDN and/or MSID of a CDMA modem, to use a different account. The changes will

remain until the modem is reprogrammed again (by this scene or use with another MSN/MSID in Central Mode).

Note: This is a slow process, typically taking 30 seconds or more.

Hint: To loop through a number of MDN/MSID changes, use the MDN CSV List resource and scenes.

Properties:

Hardware


Control Set

NAM - type 0 or 1 to specify the NAM to modify. Default: 0

Numbers

MDN - type the MDN to assign to the NAM, or leave blank to leave the MDN unchanged. Default: blank

MSID - type the MSID to assign to the NAM, or leave blank to leave the MSID unchanged. Default: blank

Security

MSL - type the Master Subscriber Lock code for this modem. Default: 000000

System


Routes:

OK - MDN and MSID have been changed

Failed to change MDN and MSID - failed due to a service error

Failed to change MDN and MSID (system) - failed due to a system error



CDMA Set Network scene Purpose: To change the SID and NID of a CDMA modem, to use a different network. The changes will remain

until the modem is reprogrammed again (by this scene or use with another SID/NID in Central Mode).

Note: This is a slow process, typically taking 30 seconds or more.

Properties:

Hardware


Control Set


Numbers

Index - type the index (0-19) of the SID/NID pair within the chosen NAM to change. Default: 0

NID - type the Network ID (NID) to assign. Default: 65535

SID - type the System ID (SID) to assign. Default: 0

System


Routes:

OK - NID and SID have been changed

Failed to set network - failed due to a service error

Failed to set network (system) - failed due to a system error



CDMA Set Active NAM scene Purpose: To change the active NAM, to use its alternative telephone and serial numbers

Properties:

Control Set

NAM - type 0 or 1 to specify the NAM to activate. Default: 0

Hardware


System


Routes:

OK - active NAM has been changed

Failed to change active NAM - failed due to a service error

Failed to change active NAM (system) - failed due to a system error



CDMA Write PRL File scene Purpose: To write a Prefered Roaming List (PRL) file to a CDMA modem.

Properties:

Hardware


Control Set


Data

PRLFileURL - type the URL of the PRL file to write to the modem. Default: blank

Security

MSL - type the Master Subscriber Lock code for this modem. Default: 000000

System


Routes:

OK - modem has been changed

Failed to write prl - operation failed due to a service error

Failed to write prl (system) - operation failed due to a system error



CDMA Set CDMA Mode scene Purpose: To set the CDMA modem mode.

Properties:

Control

Mode - select the CDMA mode to lock onto: 1xRTT (operate in 1xRTT mode only), EVDO (operate in EVDO

mode only), or Auto (choose a mode to match the service). Default: Auto

Timeout - type the timeout (seconds) for modem interactions. Default: 10

Hardware


System


Routes:

OK - mode has been set

Failed to set CDMA Mode - operation failed due to a service error

Failed to set CDMA Mode (system) - operation failed due to a system error



CDMA Set Akey scene Purpose: To set the Authentication key (A-key) of the CDMA device.

Properties:

Control

Timeout - type the timeout (seconds) for modem interactions. Default: 10

Hardware


Misc

Akey - type the Akey to set. Default: blank

Checksum - type the checksum for the Akey, to validate it. Default: 0

System


Routes:

OK - Akey has been set

Failed to set Akey - operation failed due to a service error

Failed to set Akey (system) - operation failed due to system error



CDMA Reset Modem scene Purpose: To reset a CDMA modem, to return it to a known state.

Properties:

Hardware


System


Routes:

OK - modem has been reset

Failed to reset Modem - operation failed



CDMA Enable Notifications scene Purpose: To configure the CDMA notifications you require. Notice that, by default, all notifications are enabled.

Note: To report the notifications, use the CDMA Report Notifications scene.

Properties:

Call Notification Options

CallConnected - Whether to listen for Call Connected (ID 0x300A) notifications from the modem. Default:

True

CallConnecting - Whether to listen for Call Connecting (ID 0x3011) notifications from the modem. Default:

True

CallDisconnected - Whether to listen for Call Disconnected (ID 0x300C) notifications from the modem.

Default: True

CallDormant - Whether to listen for Call Dormant (ID 0x3012) notifications from the modem. Default: True

CallerId - Whether to listen for Caller ID Information Received (ID 0x3006) notifications from the modem.

Default: True

CallError - Whether to listen for Connection Error (ID 0x300E) notifications from the modem. Default: True

CallOTASPProgress - Whether to listen for Over The Air Service Provisioning Status (ID 0x3014)

notifications from the modem. Default: True

ExtendedCallerId - Whether to listen for Extended Caller ID Information Received (ID 0x3009) notifications

from the modem. Default: True

IncomingCallNotify - Whether to listen for Incoming Call (ID 0x3004) notifications from the modem.

Default: True

General Notifications

BSLocation - Whether to enable and listen for Base Station Location Information (ID 0x4003) notifications


CallPrivacy - Whether to enable and listen for Call Privacy Status (ID 0x3013) notifications from the modem.

Default: True

ChannelState - Whether to enable and listen for Current 1xRTT Channel Acquisition State (ID 0x1005)


CurrentBandClass - Whether to enable and listen for Current Band Class (ID 0x4008) notifications from the

modem. Default: True

DataCallByteCounter - Whether to enable and listen for Data Call Bytes Sent and Received (ID 0x3001)


FrameErrorRate - Whether to enable and listen for IS-95 Data Frame Error Rate (ID 0x4005) notifications


Heartbeat - Whether to enable and listen for Heartbeat (ID 0x0000) notifications from the modem. Default:

True

IOTAStatus - Whether to enable and listen for Embedded IOTA Session Status (ID 0x7002) notifications


NID - Whether to enable and listen for NID Update (ID 0x4002) notifications from the modem. Default:

True



ProtocolRev - Whether to enable and listen for Protocol Revision Number (ID 0x101C) notifications from the


RoamingStatus - Whether to enable and listen for Roaming Status (ID 0x1007) notifications from the


RSSI - Whether to enable and listen for Received Signal Strength Indicator (ID 0x1001) notifications from the


ServiceIndication - Whether to enable and listen for Service Indication (ID 0x1006) notifications from the


SID - Whether to enable and listen for SID Update (ID 0x4001) notifications from the modem. Default: True

SMSReceivedMsgStatus - Whether to enable and listen for SMS Received Status (ID 0x2000) notifications


SMSSendStatus - Whether to enable and listen for SMS Sent Status (ID 0x2005) notifications from the


Hardware


HDR Misc Notifications

DDTMPref - Whether to enable and listen for HDR Data Dedicated Transmission mode Preference (ID

0x106C) notifications from the modem. Default: True

HDRRSSI - Whether to enable and listen for HDR RSSI (ID 0x1067) notifications from the modem. Default:

True

HybridPref - Whether to enable and listen for HDR Hybrid Mode Preference (ID 0x106A) notifications from

the modem. Default: True

IdleDigitalMode - Whether to enable and listen for HDR Idle Digital Mode Preference (ID 0x106B)


RoamStatus - Whether to enable and listen for HDR Roaming Status (ID 0x1068) notifications from the


ServiceState - Whether to enable and listen for HDR Service State (ID 0x1069) notifications from the modem.

Default: True

HDR Tech Notifications

HDRAuthStatus - Whether to enable and listen for HDR Authentication Status (ID 0x4022) notifications


HDRChannel - Whether to enable and listen for HDR Channel (ID 0x4020) notifications from the modem.

Default: True

HDRDRC - Whether to enable and listen for HDR Data Rate Channel (ID 0x4023) notifications from the


HDRDRCCover - Whether to enable and listen for HDR Data Rate Channel Cover (ID 0x4024) notifications


HDRProtocolRevNo - Whether to enable and listen for HDR Protocol Revision Number (ID 0x401D)


HDRRFStats - Whether to enable and listen for HDR RF Statistics (ID 0x4026) notifications from the


HDRRRI - Whether to enable and listen for HDR Reverse Rate Indicator (ID 0x4025) notifications from the




HDRSector - Whether to enable and listen for HDR Sector (ID 0x401E) notifications from the modem.

Default: True

HDRSessionInfo - Whether to enable and listen for HDR Session Info (ID 0x4021) notifications from the


HDRState - Whether to enable and listen for HDR / AT Session State (ID 0x401F) notifications from the


System


Routes:


Failed to enable notifications - operation failed due to a service error

Failed to enable notifications (system) - operation failed due to system error



CDMA Report Notifications scene Purpose: To output the enabled CDMA notifications.

Note: To configure CDMA notifications, use the CDMA Enable Notifications scene.

Properties:

Hardware


System


Routes:


Failed to report notifications - operation failed

Failed to report notifications (system) - operation failed due to system error



CDMA Receive MMS DM scene Purpose: To receive an MMS over a CDMA connection.

Hint: Use the Send MMS scene to send an MMS over CDMA.

Properties:

Actor


Data

AllowDeliveryReport - choose Yes to allow the sending of a delivery report to the sender. Default: No


MaxDeliveryTime - how long (in seconds) to wait for a matching message. Default: 1200


Hardware

MMSClient - select the CDMA MMS Client resource to use

System


Routes:

OK - MMS download has succeeded, MMS is stored in the specified Content resource

Failed to receive mms - MMS download has failed due to a service error

Failed to receive mms (system) - MMS download has failed due to a system error



Chapter 22 - The Reporting Framework Group

Use the scenes and resources in the Reporting Framework Group to export testcase details, metrics and messages

to the Reporting Framework, so it can report results from your testcases. The Reporting Framework is an optional

new reporting system used by the TEMS IMS Monitoring Solutions that you can now use with your own Solutions.

This information is in two broad categories:

Key Facts: standard information that every testcase must report, such as when the test started and the test

status (success, service error, probe error, warning, etc) plus optional information such as links to audio and

trace files

Quality Metrics: information that you have chosen to report, to monitor the quality of service being

delivered

Key Facts (such as when a testcase starts and ends, and the outcome of each test step) are exported to the Projector

database directly by the Data Parties, by using the Testcase Generic scenes.

Quality Metrics are collected by your Data Parties and passed to the Collector by using the standard Propagate

resources; the Collector then reprocesses them as required and exports them to your Projector database, by using

the Testcase Collector scenes.

The Key Facts and Quality Metrics in the Projector database are converted to the format required by the Reporting

Framework dashboards and stored in a second database. This conversion is configured by a JSON file created by

TEMS Service Delivery to add your testcases to the Reporting Framework.

Note: The names of the Quality Metrics and Quality Messages exported by your scripts must match the names

defined in your JSON file our results from your testcases will be ignored by the Reporting Framework.

More information:

For information on propagating metrics, timings and messages to the Collector, see the Propagate Metrics,

Propagate Timings, and Propagate Messages resources.

For information on installing the Reporting Framework, see the Reporting Framework Install Guide. Note:

Installation is usually carried out for customers by TEMS Service Delivery personnel.

For information on configuring the Reporting Framework to support your testcases, including an example

script and JSON file, see the Reporting Framework Configuration Guide. Note: This configuration should be

carried out for customers by TEMS Service Delivery personnel.

For information on using the Reporting Framework Dashboards see the Reporting Framework User Guide

Resources:

Testcase

Data Scenes:

Record Step Status

Report Testcase

Start Testcase

End Testcase

Collector Scenes:

Rereport Testcase Messages



Rereport Testcase Metrics



Testcase resource Purpose: Used to identify the testcase to the Reporting Framework, should be included in every party in your

script.

Properties:

Data

Code - Text, the code for this Testcase, e.g. TC-01.01.01. To avoid confusion, do not use codes that are

already used for IMS Solutions! You can use any format you like. Default: blank

ID - The Testcase ID. An integer, 1 or more, that must uniquely identify this testcase as described below.

Default: 1

Reports

Test Point Type - Type the name of the test point that this testcase uses i.e. where or how it connects to the

network. For example: Subscriber, Internet, Radio interface, Gm, or ISC. Default: Subscriber

For a general introduction to the Reporting Framework, see the Reporting Framework User Guide.

Testcase IDs

Each Testcase ID must be unique, worldwide. To this end, TEMS reserves an ID range for each new Solution - and

any attempt to generate a Solution that uses a reserved Testcase ID will fail.

Testcase IDs 0-799 are already reserved. If you are creating a new Solution and haven't been assigned a block of IDs

for it, please contact TEMS R&D to reserve a block of IDs. If you are extending an existing Solution, make sure you

only use Testcase IDs within the allocated range that have not been used already.



Record Step Status scene Purpose: Used to report the status of the current Test Step to the Reporting Framework. A Test Step is a phases of a

test, such as hardware initialization, protocol setup, or data transfer. You can create as many or a few Test Steps as

you wish.

A typical Test Step will have several branches, indicating different outcomes (such as success, a failure that

prevents the testcase completing, or a warning about a possible problem); include a different suitably-configured

Record Step Status scene in each branch to report as much detail as you can to the Reporting Framework.

Properties:

Data

Failure - Describes the type of failure: Type 0 if it didn't fail, or type a Failure Id (an integer: 1, 2, 3, etc) to

report the type of failure. See Failure IDs below. Default: 0

Status - Describes the step's status. Select from Success, Service error, IMS error, etc. - see Step Status,

below. Default: Success

StepNumber - An integer (0, 1, 2, 3, etc.), the Step Number you are reporting for. Steps should be numbered

from 0 within a flow (branch). Default: 0

Warning - Describes the type of warning: Type 0 if no warning is needed, or type a Warning Id (an integer:

1, 2, 3, etc) to report the type of warning. See Warning IDs below. Default: 0

System


Testcase

Testcase - select the Testcase resource for the testcase that we are reporting results for.

Routes:

OK - the step status has been reported

There are no other routes for this scene.

Failure IDs

You can report the following Failures for a Step by typing the appropriate number:

0 = success (no failure)

1, 2, 3, etc. = Failure IDs defined in the JSON file for your testcases

Step Status

You can report the following status for a Step by selecting from a dropdown list:

Success

Service error

IMS error

Probe error

Unexpected flow

Access error

IMSAgent error

Script error

Prerequisites error



Warning

Warning IDs

You can report the following Warnings for a Step by typing the appropriate number:

0 = success (no warning)

1, 2, 3, etc. = Warning IDs defined in the JSON file for your testcases



Report Testcase scene Purpose: Used by a data party to identify the testcase and flow it's used for.

Properties:

System


Testcase

Flow - An integer, 1 or more, specifying which flow the testcase has tested (for example: it might use

UMTS if LTE is not available). Default: 1

Testcase - select the Testcase resource for the testcase that we are reporting.

Routes:

OK - the testcase has been reported




Start Testcase scene Purpose: Identifies the start of a testcase, for timing purposes. This scene must be used near the start of every party

in the testcase (not the Collector), typically after any pre-requisites have been checked - when you start to test the

service.

Properties:

System


Testcase

Testcase - select the Testcase resource for the testcase that we are starting.

Routes:

OK - the testcase start has been reported




End Testcase scene Purpose: Identifies the end of a testcase, for timing purposes. This scene must be used near the end of every Data

Party in the testcase (but not the Collector) - typically before any tidy-up scenes are executed, when you've finished

testing the service.

Properties:

System


Testcase

Testcase - select the Testcase resource for the testcase that we are reporting the start time for.

Routes:

OK - the testcase end has been reported




Rereport Testcase Metrics scene Purpose: Used in the Collector to export Quality Metrics to the Reporting Framework. These are metrics and

timings generated by the Data Parties and then propagated to the Collector for this purpose by using the Propagate

Metrics and Propagate Timings resources.

The names of the Quality Metrics exported by your scripts must match the names defined in the JSON file for your

testcases or they will be ignored by the Reporting Framework.

Note: This scene should only be used in the Collector script of a multi-party script; it will be ignored if used in a

Data Party. It can only access metrics and timings that have been propagated by the Data parties.

If an exported metric is not defined in the JSON file for your testcases it will be ignored; if a metric is defined but

not exported, it will be reported as 0.

Properties:

Collector

Metrics - the list of metrics to report. Click the button to display the List of Strings dialog, to define the

names. You can then add names by using the Add button, edit or delete them. Default: blank

Type a Metric name in the format party/transaction/metricname. For example, to specify the UserTime metric

from the main transaction in the Sender party, type Sender/main/UserTime; to specify all metrics from a

transaction, omit metricname

NotFoundError - select whether to return a System Error or No Error if any of the specified metrics does not

exist. Default: System Error

Output

Transaction - to report these metrics as coming from a specific Transaction, type the Transaction name here.

Optional. Default: blank

Resource


System


Routes:

OK - the metrics have been re-reported to the Reporting Framework

Failed to re-report testcase metrics (system) - the action failed, due to a system error



Rereport Testcase Messages scene TBA Purpose: Used in the Collector to export Quality Messages to the Reporting Framework. These are usually

generated by the Data Parties and then propagated to the Collector for this purpose by using the Propagate

Messages resources.

Note: This scene should only be used in the Collector script of a multi-party script; it will be ignored if used in a

Data Party. It can only access messages that have been propagated.

If an exported message is not defined in the JSON file for your testcases it will be ignored; if a message is defined in

the JSON file but not exported, it will be reported as blank.

Properties:

Collector

Messages - the list of messages to report. Click the button to display the List of Strings dialog, to define

the names. You can then add names by using the Add button, edit or delete them. Default: blank

Type Message names in the format party/transaction/type. For example, to re-report all Info messages from

the Sender party, type Sender//Info or, to re-report all Info messages, type //Info

NotFoundError - select whether to return a System Error or No Error if any of the specified messages does

not exist. Default: System Error

Output

Message Name - type a new name (type) for the messages (optional) or leave blank to use the current


Prefix Value with Name - select True to add the original name of the message (followed by a colon) to the

start of the exported value. Default: False

Transaction - to report these messages as coming from a specific Transaction, type the Transaction name

here. Optional. Default: blank

Resource


System


Routes:

OK - the messages have been re-reported to the Reporting Framework

Failed to re-report testcase messages (system) - the action failed, due to a system error


Appendix A - Real Device Key Codes

This Appendix lists the key codes used to "press" keys on a Real Device's keypad, with Real Device scenes such as

Press tethered MA key.

The key codes to use depend on the device's Operating System:

Key codes for Series 60 devices

Key codes for Sony Ericsson devices

Key codes for Series 60 devices

Typing keys

The standard typing keys have keycodes that stand for themselves. For example, use "A" to specify A, "B" to

specify B and so on.

Main keypad

"Call key"

"End key"

"Pencil/ABC key"

"Application key"

"Clear key"

"Left softkey"

"Right softkey"

"Left-arrow"

"Right-arrow"

"Up-arrow"

"Down-arrow"

"Enter (press-in)"

Numeric keypad

"VK_1" … "VK_9"

"VK_0"

"VK_*"

"VK_#"

The following are not real keys on Series 60 but may be used in some applications:

"'VK_A'" … "VK_Z"

Appendix A - Real Device Key Codes


Key codes for Sony Ericsson devices

Typing keys

The standard typing keys have keycodes that stand for themselves. For example, use "A" to specify A, "B" to

specify B and so on.

Main keypad

"Left softkey"

"Right softkey"

"Back"

"Clear"

"Left-arrow"

"Up-arrow"

"Right-arrow"

"Down-arrow"

"Enter"

"Video call"

"Browser"

"VK_1" … "VK_9"

"VK_0"

"VK_*"

"VK_#"

"Up-volume"

"Down-volume"

"Power"

"Camera"


Appendix B - CDMA Testing

This Appendix provides additional information on testing CDMA networks:

CDMA Scripting

CDMA Setup

CDMA Troubleshooting

CDMA Scripting Monitor Master supports testing of a variety of networks, including CDMA, GSM, LTE and TD-SCDMA. See

Appendix C for details of which scenes and resources can be used with each bearer.

To test a CDMA network you need properly provisioned CDMA SmartModems and scripts written for CDMA.

When writing CDMA test scripts you can use a wide range of general-purpose resources and scenes as well as the

CDMA-specific resources and scenes.

The MC5728V (SW5728V) CDMA modem can be ordered in a custom configuration, as a Type 2 Modem. In this

configuration, you must use the standard scenes and resource - not the CDMA ones listed in this chapter.

CDMA Setup CDMA-specific setup is largely confined to setting up the SmartModems and associated accounts, which may

require assistance from an TEMS sales representative. See the Installing and Managing guide for your Agent

appliance.

CDMA Troubleshooting If you encounter problems during CDMA testing, the following CDMA troubleshooting guidelines should prove

helpful.

This section describes some things to try if your CDMA tests don't work as expected.

Initial checks

Check the signal strength:

Use at!rssi? to check the signal strength.

Check that the modem is registered on the CDMA network

Use at!status to check that the modem is registered on a network

Check that the account is set up properly on the modem (on NAM0):

Use at!namval?0 to get the account details stored in the modem

Use ati to get the modem ESN

Make sure the account is correctly provisioned for the service being tested.

Appendix B - CDMA Testing


If you can send an SMS, but it is never received

Was the SMS sent using 8 bit encoding?

By default, the SW5725V modem sends SMS messages using 8-bit encoding. This includes messages that are sent

using the AT command interface, for example:

AT!SSMS=0,1234567890,,"Hello"

You can't change the encoding via the AT command interface. SMS messages sent using 8 bit encoding seem to be

incompatible with the system that transmits messages between carriers, so the message is never delivered.

The Send SMS scene defaults to using 7-bit ASCII, which should be relayed OK, but allows you to choose other

encodings.

Is the account provisioned for SMS?

After sending an SMS, use this command:

AT!SSMS?

to check whether the SMS was accepted by the network.

If you can't send an MMS

Is the account provisioned for MMS?

If not, you will typically receive an error from the MMSC such as "Originating address not recognised".

Are you using SPRINT?

SPRINT does not support MMS.

Is the HTTP proxy configured correctly?

Use ArgoScript.DoHTTPProxy "gw.vzwwap.com", 8080, mdn & "@vzw3g.com", "vzw"

where mdn is the MDN of the account.

Is the x-vzw-mdn header set?

Use ArgoScript.SetClientHeader "x-vzw-mdn", mdn


If data tests fail

Is the account provisioned for data?

Are the username and password for the data connection set correctly?

For Verizon:

username: [email protected]

password: vzw




Is the HTTP proxy / x-vzw-mdn header set correctly?

See If you can't send an MMS, above


Appendix C - Supported Networks

This Appendix summarizes Story Boarder's support for testing on GSM, CDMA, LTE and TD-SCDMA networks,

scene by scene.

For general information on CDMA testing, see Appendix B.

Network support for scenes and resources This appendix consists of a table for each Group in the Sidebar, listing its scenes and resources and indicating

which can be used for testing on GSM, CDMA, TD-SCDMA and LTE networks - provided the modem supports it

(check the modem's SPD if not sure).

Our TD-SCDMA modems support data only; our LTE modems support data on all modems, and voice and

messaging on selected modems - check the SPDs. Specific modems may have additional limitations - consult the

modem's SPD for full details.

WARNING: Type 2 Modems (including all LTE modems) return some timings that are not directly comparable

with the timings from Type 1 Modems. See the timing diagrams in the Standard Scripts Guide for details.

KEY: The names of folders within groups are in italic; resource and scene names are in bold.

Standard Group GSM CDMA TD-SCDMA LTE Notes

Start yes yes yes yes

Comment yes yes yes yes

End yes yes yes yes

Resource Group GSM CDMA TD-SCDMA LTE Notes

Resources: Scripting

Script yes yes yes yes

Engineer yes yes yes yes

Resources: Test

Prop yes yes yes yes

Props yes yes yes yes

PropStore yes yes yes yes

File yes yes yes yes

Parameter yes yes yes yes

Resources: Terminals

SmartModem yes no yes yes

LAN yes yes yes yes

Modem yes yes yes no

CDMA Hardware no yes no no

Resources: Connections




Operator yes yes yes yes

Device yes yes yes yes

Devices yes yes yes yes

User yes yes yes yes

Connection yes yes yes yes

Multi Connection yes no no yes MC7304 only

Connection Context yes no no yes MC7304 only

Internet Explorer yes yes yes yes

HTTP Client yes yes yes yes

CDMA MMS Client no yes no yes

Resources: Browser

Internet Explorer yes yes yes yes

ArgoBrowser yes yes yes yes

WebBrowser yes yes yes yes

Resources: Audio

Smart VoiceSession yes yes no no deprecated; does not support RTU

IAPI VoiceSession yes yes no no

VoiceSession yes yes no no

Audio Bridge yes yes no no

Voice Interface yes yes no no

Resources: Video

VideoPlayer yes yes yes yes

Video Engineer yes yes yes yes

VideoMOSEngine yes yes yes yes

Resources: Content

Content yes yes yes yes

Resources: PCAP

PCAP Engineer yes yes yes yes

PCAP Examiner yes yes yes yes

PCAP Manager yes yes yes yes

Resources: Power Control

External Hardware: BetterBox Device

Control

yes yes yes yes

External Hardware: iBoot Device Control yes yes yes yes

External Hardware: APC Device Control yes yes yes yes

External Hardware: DevCon Device

Control

yes yes yes yes

External Hardware: ActeSys Device

Control

yes yes yes yes

Resources: Advanced SIM Management




ActeSys Remote SIM Server yes no yes yes CDMA does not use SIMs

SIM yes no yes yes CDMA does not use SIMs

SIM List yes no yes yes CDMA does not use SIMs

SIM Server yes no yes yes CDMA does not use SIMs

Resources: XML File

XML File yes yes yes yes

Resources: VoIP

VoIP Client yes yes yes yes for OTA connection to SIP

VoIP VoiceSession yes yes yes yes for OTA connection to SIP

VoIP PCAP yes yes yes yes for OTA connection to SIP

Scripting Group GSM CDMA TD-SCDMA LTE Notes

Script yes yes yes yes

Loop yes yes yes yes

Wait yes yes yes yes

Delete file yes yes yes yes

Scripting: Synch Points

Synch Point yes yes yes yes

Verifying Synch Point yes yes yes yes

Neutral Synch Point yes yes yes yes

Scripting: Retrieve Values

Match values yes yes yes yes

Get PropStore value yes yes yes yes

Find value in Props yes yes yes yes

Match PropStore value yes yes yes yes

Get Props value yes yes yes yes

Scripting: Set Values

Set Prop value yes yes yes yes

Set Props list yes yes yes yes

Set PropStore items yes yes yes yes

Encode Base64 data yes yes yes yes

Decode Base64 data yes yes yes yes

Convert ArgoList to Props yes yes yes yes

Scripting: XML resource File

Set Prop from XML resource yes yes yes yes

Set Prop from SiteConfig yes yes yes yes

Set Props from XML resource yes yes yes yes

Set PropStore from XML resource yes yes yes yes



Test Group GSM CDMA TD-SCDMA LTE Notes

Test: Checks

Check Device Capabilities yes yes yes no

Check Environment yes yes yes yes

Check Props yes yes yes yes

Check User yes yes yes yes

Check Operator Service yes yes yes yes

Test: Properties

Get MSISDN for Party yes yes yes yes

Get Test Property yes yes yes yes

Test: Parameters

Operator Load from Params yes yes yes yes

Device Load from Params yes yes yes yes

Test:

Branch if Test Running yes yes yes yes Deprecated, use a multi-party script

Configure Branch Test yes yes yes yes Deprecated, use a multi-party script

Branch Test yes yes yes yes Deprecated, use a multi-party script

Merge Test yes yes yes yes Deprecated, use a multi-party script

Synchronize Test yes yes yes yes use a multi-party script

Start Test yes yes yes yes use a multi-party script

Probe Group GSM CDMA TD-SCDMA LTE Notes

Probe: Administration

Agent restart (hard) yes yes yes yes

Agent restart (soft) yes yes yes yes

Terminals Group GSM CDMA TD-SCDMA LTE Notes

PowerUp Modem yes yes yes yes

PowerDown Modem yes yes yes yes

Disable Modem yes yes yes yes

Recover Modem yes yes yes yes

Reset Modem yes no yes yes use CDMA Reset modem

Verify Modem yes no yes no

Ensure Modem Ready yes no yes no

Get Modem Information yes no yes no use CDMA Report scenes



Terminals Group GSM CDMA TD-SCDMA LTE Notes

Get Additional Modem Information yes no no no

Terminals: Advanced SIM Management

Connect to remote SIM yes no yes yes CDMA does not use SIMs

Select SIM yes no yes yes CDMA does not use SIMs

Load SIM From resource yes no yes yes CDMA does not use SIMs

Connections Group GSM CDMA TD-SCDMA LTE Notes

Connections: Packet

Make data connection yes yes yes yes

Drop data connection yes yes yes yes

GPRS attach yes no yes no

GPRS detach yes no yes no

GPRS PDP activate yes no yes no

GPRS PDP deactivate yes no yes no

Wait for PDP context deactivation yes no yes no

Get SIM number yes no yes yes CDMA does not use SIMs

Verify Network Accessibility (ETSI) yes yes yes no

Connections: Circuit

Make voice call yes no no no use CDMA Make a voice call

Drop voice call yes no no no use CDMA Drop voice call

Wait for call yes no no no use CDMA Receive a voice call

Maintain voice call yes no no no

Answer voice call yes no no no use CDMA Receive a voice call

Analyze PESQ yes yes yes no

Test Circuit Switched Loopback yes no yes no

Test Circuit Switched Remote yes no yes no

Test Circuit Switched Echo yes no yes no

Voice Group GSM CDMA TD-SCDMA LTE Notes

Assess Call Quality yes yes no no

Process Announcement yes yes no no

Stop Voice Recording yes no no no

Start Voice Recording yes no no no

Record volume yes no no no

Playback volume yes no no no

Play audio yes no no no



Voice Group GSM CDMA TD-SCDMA LTE Notes

Voice: Telephony

Make DTMF tone yes no no no

Make voice call yes no no no use CDMA Make a voice call

Drop voice call yes no no no use CDMA Drop voice call

Wait For Call yes no no no use CDMA Receive voice call

Maintain voice call yes no no no

Answer voice call yes no no no use CDMA Receive voice call

Analyze PESQ yes yes no no

Measure Voice Quality yes yes no no Type 2 Modems only

Voice: Telephony: Deprecated

Play spoken phrase yes no no no

Play TEC audio yes no no no

Record TEC audio yes no no no

Voice: VoIP

Make SIP call yes yes yes yes for OTA connection to SIP

Drop SIP call yes yes yes yes for OTA connection to SIP

Wait for SIP call yes yes yes yes for OTA connection to SIP

Send SIP message yes yes yes yes for OTA connection to SIP

Receive SIP message yes yes yes yes for OTA connection to SIP

Video Call Group GSM CDMA TD-SCDMA LTE Notes

Test Circuit Switched Loopback yes no yes no

Test Circuit Switched Remote yes no yes no

Test Circuit Switched Echo yes no yes no

Network Group GSM CDMA TD-SCDMA LTE Notes

Query signal strength yes no yes no

Select Operator yes no yes no use CDMA set network

Get Operators yes no yes no use CDMA report network info

Wait for Network yes no yes no

Set RAT yes yes yes yes TCC modems only

Lock Band yes yes yes yes TCC modems only

Network: Data

Download FTP yes yes yes yes

Upload FTP yes yes yes yes

Download HTTP yes yes yes yes



Network Group GSM CDMA TD-SCDMA LTE Notes

Ping yes yes yes yes

Video Ping yes yes yes yes

DNS Lookup yes yes yes yes

Network: Authentication

Set RADIUS details yes yes yes no

Check RADIUS access yes yes yes no

Network: PCAP

Examine PCAP yes yes yes yes

PCAP start yes yes yes yes

PCAP stop yes yes yes yes

Network: Diagnostics

Resources: Diagnostics Writer yes yes yes yes

Resources: Diagnostics Reader yes yes yes yes

Diagnostics Trace Start yes yes yes yes

Diagnostics Trace Stop yes yes yes yes

Diagnostics Trace Reporter yes yes yes yes

Diagnostics Trace Available yes yes yes yes

Supplementary Services Group GSM CDMA TD-SCDMA LTE Notes

Call Barring yes no no no

Call Forwarding Service yes no no no

CLIR yes no no no

CLIP yes no no no

Supplementary Services: Deprecated

Call Forwarding yes no no no

Messaging Group GSM CDMA TD-SCDMA LTE Notes

Messaging: Email

Messaging: Email: POP3

Receive email yes yes yes yes

Clear POP3 mailbox yes yes yes yes

Disconnect POP3 yes yes yes yes

Messaging: Email: SMTP

Send email yes yes yes yes

Disconnect SMTP yes yes yes yes

Messaging: Email: IMAP



Messaging Group GSM CDMA TD-SCDMA LTE Notes

List available IMAP mailboxes yes yes yes yes

Count all IMAP emails yes yes yes yes

List all IMAP emails yes yes yes yes

Receive IMAP email yes yes yes yes

Delete all IMAP emails yes yes yes yes

Disconnect IMAP yes yes yes yes

Messaging: Email: Security

Make email secure yes yes yes no

Messaging: SMS

Clear SMS inbox yes yes yes yes LTE: reduced functionality

Receive SMS yes yes yes yes LTE: reduced functionality

Receive SMS Notification yes yes yes yes LTE: reduced functionality

Send SMS yes yes yes yes LTE: reduced functionality

Send and receive SMS (P2A2P) yes yes yes no

Send and receive SMS (P2P) yes yes yes no

Send and receive SMS (P2OP) yes yes yes no

Messaging: MMS

Clear MMS inbox yes yes yes yes

Clear MMS local inbox yes yes yes yes

Send MMS yes yes yes yes LTE: reduced functionality

Receive MMS yes no yes no

Receive MMS notification yes no yes yes LTE: reduced functionality

Receive MMS delivery report yes no yes no

Download MMS yes no yes yes

Messaging: Instant Messaging

Messaging: Instant Messaging: OMA IMPS

Login to IM service yes no yes yes

Logout from IM service yes no yes yes

Send instant message yes no yes yes

Receive instant message yes no yes yes

Set IM presence yes no yes yes

Get IM presence yes no yes yes

Browser Group GSM CDMA TD-SCDMA LTE Notes

Browser: WAP/Web

Visit page yes yes yes yes

Autobrowse yes yes yes yes

Choose option yes yes yes yes



Browser Group GSM CDMA TD-SCDMA LTE Notes

Select form yes yes yes yes

Enter data yes yes yes yes

Follow link yes yes yes yes

Go back yes yes yes yes

Navigate yes yes yes yes

Click numbered link yes yes yes yes

Visit multipart page yes yes yes yes

Visit video yes yes yes yes

Browser GetCookies yes yes yes yes

Browser SetCookies yes yes yes yes

Browser ClearCookies yes yes yes yes

Browser ClearCache yes yes yes yes

Record navigation yes yes yes yes

Browser: IE

Browse to page yes yes yes yes

Click button yes yes yes yes

Click image yes yes yes yes

Click index yes yes yes yes

Click input yes yes yes yes

Click name yes yes yes yes

Enable checkbox yes yes yes yes

Enter text yes yes yes yes

Select option yes yes yes yes

Select form (IE) yes yes yes yes

Select frame yes yes yes yes

Record frame content yes yes yes yes

Click JS Entity yes yes yes yes

Browser: STK

Launch SIM Toolkit application yes no yes no

Browser: WebBrowser

Browser: WebBrowser: Control

Take snapshot yes yes yes yes

Browser: WebBrowser: Windows

Open new window yes yes yes yes

Select window yes yes yes yes

Close window yes yes yes yes

Enable multiple windows yes yes yes yes

Browser: WebBrowser: Navigation

Simple Autobrowse yes yes yes yes



Real Devices Group GSM CDMA TD-SCDMA LTE Notes

Real Devices: S60

Make tethered MA connection S60 yes no no no S60 devices only

Drop tethered MA connection yes no no no S60/SE devices

Press tethered MA key S60 yes no no no S60 devices only

Enter tethered MA text S60 yes no no no S60 devices only

Match tethered MA screen yes no no no S60/SE devices

Capture tethered MA screen yes no no no S60/SE devices

Clear tethered MA inbox S60 yes no no no S60 devices only

Send tethered MA SMS S60 yes no no no S60 devices only

Send tethered MA MMS S60 yes no no no S60 devices only

Receive tethered MA SMS S60 yes no no no S60 devices only

Receive tethered MA MMS S60 yes no no no S60 devices only

Visit tethered MA page S60 yes no no no S60 devices only

Real Devices: SE

Make tethered MA connection SE yes no no no SE devices only

Drop tethered MA connection yes no no no S60/SE devices

Press tethered MA key SE yes no no no SE devices only

Enter tethered MA text SE yes no no no SE devices only

Match tethered MA screen yes no no no S60/SE devices

Capture tethered MA screen yes no no no S60/SE devices

Capture tethered MA text SE yes no no no SE devices only

Real Devices: Android

ADB get property yes yes no yes Android devices only

ADB input events yes yes no yes Android devices only

ADB resource yes yes no yes Android devices only

ADB set property yes yes no yes Android devices only

ADB start activity yes yes no yes Android devices only

Content Inspection Group GSM CDMA TD-SCDMA LTE Notes

Content Inspection: Protocol

Match protocol headers yes yes yes yes

Content Inspection: Content

Match textual content yes yes yes yes

Basic content tests yes yes yes yes

mobileOK yes yes yes yes



Content Inspection Group GSM CDMA TD-SCDMA LTE Notes

Start content tests yes yes yes yes

Stop content tests yes yes yes yes

Check Device Hurdle yes yes yes yes

Record content metrics yes yes yes yes

XPath Query yes yes yes yes

Content Inspection: Images

Match image yes yes yes yes

Match image on page yes yes yes yes

Content Inspection: Audio

Audio Analysis yes yes yes no

Detect-mWatt yes yes yes no

Detect-fax yes yes yes no

Content Inspection: Video

Generate Video MOS score yes yes yes yes

Alarming Group GSM CDMA TD-SCDMA LTE Notes

Check thresholds yes yes yes yes

Raise SNMP trap yes yes yes yes

Raise ARF trap yes yes yes yes

Reporting Group GSM CDMA TD-SCDMA LTE Notes

Record message yes yes yes yes

Record metric yes yes yes yes

Record timing yes yes yes yes

Record meta tag yes yes yes yes

Record service type yes yes yes yes

Get GPS location yes yes yes yes

Random yes yes yes yes

Internal timing point yes yes yes yes

Scale metric yes yes yes yes

Report hardware platform yes yes yes yes

Reporting: Data

Upload file to Projector yes yes yes yes

Reporting: Party

Propagate Metrics yes yes yes yes

Propagate Messages yes yes yes yes



Reporting Group GSM CDMA TD-SCDMA LTE Notes

Propagate Timings yes yes yes yes

Reporting: Collector

Combine Availabilities yes yes yes yes

Aggregate Metrics yes yes yes yes

Rereport Metrics yes yes yes yes

Aggregate Timings yes yes yes yes

Rereport Messages yes yes yes yes

Rereport a Message yes yes yes yes

Reporting: ETSI

ETSI KPI Reporter yes no yes yes

ETSI Network Non-Accessibility yes no yes yes

ETSI Generic KPI Calculator yes no yes yes

ETSI HTTP KPI Calculator yes no yes yes

ETSI FTP-DL KPI Calculator yes no yes yes

ETSI FTP-UL KPI Calculator yes no yes yes

ETSI SMS KPI Calculator yes no yes no

ETSI MMS KPI Calculator yes no yes yes

ETSI GPRS Attach KPI Calculator yes no yes no

ETSI PDP Context Activation KPI

Calculator

yes no yes no

ETSI Voice KPI Calculator yes no yes no

ETSI WAP KPI Calculator yes no yes yes

ETSI DNS KPI Calculator yes no yes yes

ETSI Ping KPI Calculator yes no yes yes

Reporting: CDR

CDR Reporter yes yes yes yes

CDR Calculator yes yes yes yes

Trace Group GSM CDMA TD-SCDMA LTE Notes

Trace: PCAP

Examine PCAP yes yes yes yes

PCAP start yes yes yes yes

PCAP stop yes yes yes yes

Integration Group GSM CDMA TD-SCDMA LTE Notes

Run local command yes yes yes yes

Access a database yes yes yes yes



CDMA Group GSM CDMA TD-SCDMA LTE Notes

CDMA: resources

MDNCSVList no yes no no

CDMA Hardware no yes no no

CDMA: scenes

CDMA Setup Modem no yes no no

CDMA Report Party no yes no no

CDMA Report Byte Counters no yes no no

CDMA Report Hardware Info no yes no no

CDMA Report Network Info no yes no no

CDMA Report Voice TimeStamps no yes no no

CDMA Make Voice Call no yes no no

CDMA Receive voice call no yes no no

CDMA Drop voice call no yes no no

CDMA Enable Call-Forwarding no yes no no

CDMA Disable Call-Forwarding no yes no no

CDMA Send DTMF Tone no yes no no

CDMA Send DTMF Sequence no yes no no

CDMA MDN CSV List Get First no yes no no

CDMA MDN CSV List Get Next no yes no no

CDMA Set Mobile Id no yes no no

CDMA Set Network no yes no no

CDMA Set Active NAM no yes no no

CDMA Write PRL File no yes no no

CDMA Set CDMA Mode no yes no no

CDMA Reset Modem no yes no no

CDMA Enable Notifications no yes no no

CDMA Report Notifications no yes no no

CDMA Receive MMS DM no yes no no

Reporting Framework Group GSM CDMA TD-SCDMA LTE Notes

Resources

Testcase yes yes yes yes

Data

Record Step Status yes yes yes yes

Report Testcase yes yes yes yes



Reporting Framework Group GSM CDMA TD-SCDMA LTE Notes

Start Testcase yes yes yes yes

End Testcase yes yes yes yes

Collector

Rereport Testcase Messages yes yes yes yes

Rereport Testcase Metrics yes yes yes yes


Appendix D - HTTP Response Codes

This appendix lists the HTTP response codes that can be returned to Monitor Master, for your convenience:

HTTP v1.x response (or status) codes

HTTP v1.x Response Codes Application servers may return the following HTTP v1.x response (or status) codes to Monitor Master:

100 Continue

101 Switching Protocols

200 OK

201 Created

202 Accepted

203 Non-Authoritative Information

204 No Content

205 Reset Content

206 Partial Content

300 Multiple Choices

301 Moved Permanently

302 Moved Temporarily

303 See Other

304 Not Modified

305 Use Proxy

400 Bad Request

401 Unauthorized

402 Payment Required

403 Forbidden

404 Not Found

405 Method Not Allowed

406 Not Acceptable

407 Proxy Authentication Required

408 Request Timeout

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed



413 Request Entity Too Large

414 Request-URI Too Long

415 Unsupported Media Type

500 Internal Server Error

501 Not Implemented

502 Bad Gateway

503 Service Unavailable

504 Gateway Timeout

505 HTTP Version Not Supported



Index

7

7304 Modem. See SW7304 Modem

A

Access a database Scene, 465

Accessibility Scene, 447

ACM

diagnostics, 201

using, 201

ActeSys Device Control Resource, 84

ActeSys Remote SIM Server Resource, 85

ADB

Commands, 361, 412

Input Events, 361, 412

Key codes, 361, 412

Scenes, 360, 411

ADB Get Property Scene, 360, 363, 364, 365, 411, 414,

415, 416

ADB Input Events Scene, 361, 412

Adding

a SIM List, 88

Administration

Scenes, 147

Advanced Scripts, 28, 95

Advanced SIM Management

Resources, 85

Scenes, 160

Agent

configuring to display the Internet Explorer

window, 60

configuring to display the WebBrowser window,

63

Agent Restart

Scenes, 147, 148

Aggregate Metrics Scene, 442

Aggregate Timings Scene, 443

Alarming

Scenes, 418

Alias

Metrics in script, 20

Analysis levels, 21

Analyze PESQ Scene, 180, 199

Analyzing

content groups, 371, 372

current content, 368, 382

Android

phones, 360, 411

Scenes, 360, 411

Android Debug Bridge, 360, 411

Answer Voice Call (CDMA) Scene, 474

Answer Voice Call Scene, 179, 198

APC Device Control Resource, 82

ArgoBrowser Resource, 63

ArgoScript, 29, 97

Assess Call Quality Scene, 186

Audio

levels, 68

Resources, 65

Scenes, 387

Audio Analysis Scene, 387

Audio Bridge Resource, 70

Audio Capture Module, 201

Authentication

Scenes, 235

Autobrowse Scene, 297

Automatic Optimization Mode (FTP), 225

Available IMAP mailboxes Scene, 263



B

Back Scene, 303

Basic Content Tests Scene, 371

Bearer

locking, 220, 223

selecting, 220, 223

BetterBox Device Control Resource, 81

Branch If Test Running Scene, 139

Branch Test Scene, 142

Browse to Page Scene, 318

Browser

choosing, 295

configuring, 295

Resources, 60

Scenes, 295

Browser ClearCache Scene, 311

Browser ClearCookies Scene, 310

Browser GetCookies Scene, 307

Browser SetCookies Scene, 309

C

Calculating metrics, 441

Calculating timings, 443

Call Barring Scene, 252

Call Data Records, 460, 461

Call Forwarding

CDMA, 477, 478

GSM, 253, 256

Call Forwarding Scene, 255

Call Forwarding Service Scene, 252

Capture Tethered MA Screen Scene, 347, 359, 398,

410

Capture Tethered MA Text SE Scene, 360, 411

CDMA

Scenes, 466, 510

selecting, 220

setup, 507

testing, 507

troubleshooting, 507

CDMA Disable Call-Forwarding Scene, 477

CDMA Drop Voice Call Scene, 476

CDMA Enable Call-Forwarding Scene, 476

CDMA Enable Notifications Scene, 490

CDMA Hardware Resource, 43

CDMA limitations, 157

CDMA Make Voice Call Scene, 474

CDMA MDN CSV List Get First Scene, 480

CDMA MDN CSV List Get Next Scene, 481

CDMA MMS Client Resource, 60

CDMA Modems

Resources, 510

Scenes, 510

using, 510

CDMA Networks, 507

CDMA Receive MMS DM Scene, 494

CDMA Receive Voice Call (CDMA) Scene, 474

CDMA Receive Voice Call Scene, 474

CDMA Report Byte Counters Scene, 469

CDMA Report Hardware Info Scene, 471

CDMA Report Network Info Scene, 471

CDMA Report Notifications Scene, 493

CDMA Report Party Scene, 469

CDMA Report Voice TimeStamps Scene, 473

CDMA Reset Modem Scene, 489

CDMA Send DTMF Sequence Scene, 479

CDMA Send DTMF Tone Scene, 479

CDMA Set Active NAM Scene, 485

CDMA Set Akey Scene, 488

CDMA Set CDMA Mode Scene, 487

CDMA Set Mobile Id Scene, 483

CDMA Set Network Scene, 484

CDMA Setup Modem Scene, 467

CDMA Write PRL File Scene, 486

CDR

Scenes, 459



CDR Calculator Scene, 461

CDR Reporter Scene, 460

Cell Id, 159

Check Device Hurdle Scene, 377

Check Environment Scene, 129

Check Props Scene, 132

Check RADIUS access Scene, 237

Check Thresholds Scene, 419

Check User Scene, 133

Checking

alarm threshholds, 418

call forwarding status, 252

content groups, 371, 372

current content, 368, 382

device capabilities, 129

Diagnostics Trace available, 250

GPRS Attach, 37

network registration, 37

operator services, 133

Radio Trace available, 250

Scenes, 128

SIM Server ready, 37

test environment, 128

user properties, 132

Checks

Scenes, 128

Choose Option Scene, 299

Choosing a Device, 48

Chunked transfer, 380

CID, 159

Circuit

Scenes, 174

Clear MMS Inbox Scene, 282, 283

Clear MMS local inbox Scene, 283

Clear POP3 Mailbox Scene, 259

Clear SMS Inbox Scene, 270

Clear Tethered MA Inbox S60 Scene, 348, 399

Click Button Scene, 319

Click Image Scene, 320

Click Index Scene, 321

Click Input Scene, 322

Click Name Scene, 323

Click Numbered Link Scene, 304

Client Headers, 45

CLIP Scene, 255

CLIR Scene, 254

Close window Scene, 337

Codes

Series 60 devices, 505

Sony Ericsson devices, 506

Collector

Availability, 441

Messages, 445, 446, 504

Metrics, 442, 443

Scenes, 440

Testcase Metrics, 503

Timings, 443

Combine Availabilities Scene, 440

Combining

Metrics, 441

Timings, 443

Comment Scene, 26

Configure Branch Test Scene, 141

Configuring

FTP download, 227

script, 21

SmartModem, 37

Connect to Remote SIM Scene, 161

Connection Context Resource, 58

Connection Resource, 43, 56

Connection type, 164

Connections

Connection resoruce, 56

Make Data Connection scene, 164



Multi Connection resoruce, 57

multiple, 57, 58

primary, 57, 58

Scenes, 164

secondary, 57, 58

switching, 57, 58

Content

analysing, 368, 371, 372, 382

checking, 368, 371, 372

groups, 371, 372, 374, 376

inspecting, 367

Resources, 74

Scenes, 368

Content Groups

analysing, 371

checking, 372

creating, 374, 376

Content Inspection

Scenes, 367

Converting ArgoList to Props Scene, 121

Cookie Support, 52

Copying

Availability, 440

Messages, 444, 445

Metrics, 441, 442

Testcase Messages, 503


Timings, 443

Count All IMAP Emails Scene, 264

D

Data

Scenes, 225, 434

Database Scene, 465

Decode Base64 Data Scene, 121

Default Routes, 18

Defining functions, 28

Degraded samples, 201

Delete all IMAP Emails Scene, 267

Delete File Scene, 105

Deleting

files, 105

temporary files, 105

Deprecated

Scenes, 139

Detect-fax Scene, 390

Detect-mWatt Scene, 389

DevCon Device Control Resource, 83

Device

Resources, 48, 52

selecting, 48

selecting at runtime, 50

Wizard, 48

Device Load from Params, 139

Diagnostic Trace

Analysing, 248

Scenes, 241

Diagnostics

Scenes, 241

Diagnostics Reader Resource, 244

Diagnostics Trace Available Scene, 250

Diagnostics Trace Reporter Scene, 248

Diagnostics Trace Start Scene, 245

Diagnostics Trace Stop Scene, 246

Diagnostics Writer Resource, 243

Disable

call forwarding, 253

content download, 227

Modems, 153

Disconnect IMAP Scene, 268

Disconnect POP3 Scene, 260

Disconnect SMTP Scene, 262

DL KPI Calculator Resource, 450

DNS Lookup Scene, 235

Download FTP Scene, 226



Download HTTP Scene, 231

Download MMS Scene, 288

Drop Data Connection Scene, 167

Drop SIP Call Scene, 208

Drop Tethered MA Connection Scene, 343, 355, 394,

406

Drop Voice Call (CDMA) Scene, 475

Drop Voice Call Scene, 176, 195

E

Editing

scripts, 18

Storyboards, 18

Email

Scenes, 257, 260, 262

Secure, 269

Security, 52, 55

SSLMode, 55

Enable

Call forwarding, 253

Checkbox Scene, 324

Multiple Windows Scene, 337

Encode Base64 Data Scene, 120

End Scene, 27

End Testcase Scene, 501, 502

Engineer Resource, 31

Engineering functions, 65

Ensure Modem Ready Scene, 156

Enter Data Scene, 301

Enter Tethered MA Text S60 Scene, 345, 396

Enter Tethered MA Text SE Scene, 357, 408

Enter Text Scene, 325

Environment, 130

Ericsson F3607 Modem

diagnostics, 241

radio trace, 241

supported Scenes, 201, 241

ETSI

Scenes, 446

ETSI DNS KPI Calculator Resource, 458

ETSI FTP-DL KPI Calculator Resource, 450

ETSI FTP-UL KPI Calculator Resource, 451

ETSI Generic KPI Calculator Resource, 448

ETSI GPRS Attach KPI Calculator Resource, 453

ETSI HTTP KPI Calculator Resource, 449

ETSI KPI Reporter Scene, 446

ETSI Network Non, 448

ETSI PDP Context Activation KPI Calculator

Resource, 454

ETSI Ping KPI Calculator Resource, 459

ETSI SMS KPI Calculator Resource, 452

ETSI Voice KPI Calculator Resource, 455

ETSI WAP KPI Calculator Resource, 456

EVDO

selecting, 220

Examine PCAP Scene, 238

Example Scripts

Audio Analysis, 388, 389, 390

Get MSISDN for Party, 135

Get Test Property, 137

XPath Query, 382

Exporting


External Hardware, 81, 82, 83, 85

F

F3607 Modem. See Ericsson F3607 Modem

File Resource, 36

Files

deleting, 105

Find Value in Props Scene, 113

Follow Link Scene, 302

Forwarding Calls

CDMA, 477, 478

GSM, 253, 256

FTP



automatic optimization mode, 225

configuring, 225

download scene, 225

file sizes, 225, 228

Scenes, 225, 228

upload scene, 228

Function definitions, 96

G

Generate Video MOS Score Scene, 391

Get Additional Modem Information Scene, 159

Get GPS Location Scene, 430

Get IM Presence Scene, 294

Get Modem Information Scene, 157

Get MSISDN for Party Scene, 134

Get Operators Scene, 219

Get Props Value Scene, 115

Get PropStore Value Scene, 112

Get SIM Number Scene, 173

Get Test Property Scene, 137

Go Back Scene, 303

GPRS Attach Scene, 168

GPRS Detach Scene, 169

GPRS PDP Activate Scene, 170

GPRS PDP Deactivate Scene, 171

GPRSAttached

checking, 37, 156

GSM

Scenes, 510

selecting, 220

GSM Modems

Resources, 510

Scenes, 510

using, 510

H

Hardware details, 433

Hardware Resource, 37, 41, 43

HTTP

chunked transfer, 380

Client Resource, 59

configuring, 230

download scene, 230

file sizes, 230

input buffer, 231

Response Codes, 524

Scenes, 230

Huawei ME909u-521 Modem

using, 201

I

IAPI VoiceSession Resource, 68

IBoot Device Control Resource, 82

IE

Scenes, 317

IM Service Scene, 289, 290

Image Matching

Scenes, 383

IMAP

Scenes, 262

IMEI, 159

IMSI, 159

Input buffer

FTP, 226

HTTP, 231

Instant Messaging

Scenes, 288

Integration

Scenes, 463

Intellisense editor, 97

Internal Timing Point Scene, 431

International Mobile Equipment Id, 159

International Mobile Subscriber Id, 159

Internet Explorer Resource, 61

IP trace

multiple connections, 57

IP Trace



configuring, 237

Control header, 238

Engineer Resource, 76

Examiner Resource, 77

for CDMA, 237

for GSM, 237

for LTE, 237

for TD-SCDMA, 237

for Type 1 Modems, 237


Manager Resource, 78

operation timeout, 238

resources, 75

scenes, 237

Start Scene, 240

Stop Scene, 241

timeouts, 238

IPv4, 37

IPv6, 37

using, 164

J

JavaScript support

WebBrowser, 332

JS Entity Scene, 330

L

L3 Trace. See Radio Trace

LAC, 159

LAN Resource, 40

Launch SIM Toolkit application Scene, 332

Layer 3 Trace. See Radio Trace

Limits

FTP file size, 225, 228

HTTP file sizes, 230

List all IMAP emails Scene, 264

Load SIM from Resource Scene, 162

Location Area Code, 159

Lock Band Scene, 223

Login to IM Service Scene, 289

Logout from IM Service Scene, 290

Loop Scene, 104

LTE

APN, 37

IPTrace, 237

limitations, 155, 157, 167, 177, 196

network registration, 37

Scenes, 510

selecting, 220

LTE Modems

Resources, 510

Scenes, 510

using, 510

M

Maintain Voice Call Scene, 178, 197

Make Data Connection Scene, 164

Make DTMF Tone Scene, 192

Make Email Secure Scene, 269

Make SIP Call Scene, 207

Make Tethered MA Connection S60 Scene, 342, 393

Make Tethered MA Connection SE Scene, 354, 405

Make Voice Call (CDMA) Scene, 473

Make Voice Call Scene, 175, 194

Match Image on Page Scene, 385

Match Image Scene, 385

Match PropStore Value Scene, 114

Match Protocol Headers Scene, 368

Match Tethered MA Screen Scene, 346, 358, 397, 409

Match Textual Content Scene, 368

Match Values Scene, 110

MC7304 Modem. See SW7304 Modem

MCC, 159

MDNCSVList Resource, 466

Measure Voice Quality Scene, 201

MeasurePerformance option

FTP download, 227



HTTP download, 232

Merge Test Scene, 143

Messaging

Scenes, 257

Meta tags

recording, 428, 429

Service Type, 429

Metrics

aliases, 21

converting, 433

end-to-end data size, 379, 380

end-to-end duration, 379, 380

end-to-end payload duration, 380

end-to-end payload size, 379, 380

HTTP, 379, 380

renaming, 21, 432

scaling, 432

MMS

Scenes, 281

MNC, 159

Mobile Country Code, 159

Mobile Network Code, 159

Mobile Station ISDN, 159

MobileOK Scene, 372

Modem Identity, 157

Modem Information, 157

Modem Resource, 42

Modem Revision, 157

Modem Type, 157

Modems

Band, 223

IP Trace, 237

RAT, 220

Monitor Master Scripting Engine, 61

MSISDN, 159

Multi Connection Resource, 57

N

Naming Metrics, 21

Navigate Scene, 303

NDIS

limitations, 167

Network

choosing, 220

choosing a Band, 223

registration, 37

roaming, 221

Scenes, 216

support, 510

Network Id, 159

Neutral Synch Point scene, 109

NID, 159

O

OMA IMPS

Scenes, 288

Open New Window Scene, 335

Operator

adding client headers, 45

Client Headers, 45

Editing, 44

in Local Mode, 44

Load from Params Scene, 137

Resource, 44

settings, 37

Examples, 45

Operator Settings

APN, 37

CID, 37

file, 37

PDP_TYPE, 37

P

P862, 180, 199

Packet

capture in scripts, 237



Scenes, 164

Parameters. See also Scene Parameters, Runtime

Parameters

Resource, 36

Scenes, 137

Validation, 23

Party

Resources, 437

PCAP. See IP Trace

resources, 75

scenes, 237

PCAP Engineer Resource, 76

PCAP Examiner Resource, 77

PCAP Manager Resource, 78

PCAP Start Scene, 240

PCAP Stop Scene, 241

PDP Type, 37

Performance Measuring Mode

FTP, 225, 226

HTTP, 230, 231

PESQ

for Type 1 Modems, 180, 199


reference files, 180, 199

scenes, 180, 199, 201

volume levels, 180, 199

Ping Scene, 233

Play Audio Scene, 192

Play Spoken Phrase Scene, 204

Play TEC Audio Scene, 204

Playback volume, 68

Playback Volume Scene, 191

Plugins, 21

POLQA


scenes, 201

POP3 Email

Scenes, 257

Power Control

Resources, 80

PowerDown Modem Scene, 151

PowerUp Modem Scene, 151

Press Tethered MA Key S60 Scene, 344, 395

Press Tethered MA Key SE Scene, 356, 407

Probes

details, 433

Scenes, 147

Process Announcement Scene, 187

Projector Scene, 435

Prop Resource, 33

Propagate Messages Resource, 438

Propagate Metrics Resource, 437

Propagate Timings Resource, 439

Propagating

Availability, 440

Messages, 444, 445

Metrics, 441, 442

Testcase Messages, 503


Timings, 443

Properties

Scenes, 134

PropStore Resource, 34

Protocol

Scenes, 367

Q

QC Trace, 241, 246

QMD Trace, 241, 246

Query Signal Strength Scene, 216

R

Radio Access Technology, 221, 224

Radio Trace

checking availability, 250

diagnostics, 241



overview, 241

Resources, 241

Scenes, 241

Raise ARF Trap Scene, 421

Raise SNMP Trap Scene, 419

Random Scene, 431

RAT Locking

Scenes, 37, 220, 223

Real Devices

Key Codes, 505

Scenes, 341, 392

Receive Email Scene, 257

Receive IMAP Email Scene, 266

Receive Instant Message Scene, 292

Receive MMS Delivery Report Scene, 286

Receive MMS Notification Scene, 285

Receive MMS Scene, 285

Receive SIP Message Scene, 211

Receive SMS Notification Scene, 272

Receive SMS Scene, 271

Receive Tethered MA MMS S60 Scene, 352, 403

Receive Tethered MA SMS S60 Scene, 351, 402

Receive Window

FTP, 226

HTTP, 231

Recird Step Status, 498, 500

Record Content Metrics Scene, 377

Record Frame Content Scene, 328

Record Message Scene, 425

Record Meta Tag Scene, 428

Record Metric Scene, 426

Record Navigation Scene, 315

Record Service Type Scene, 429

Record Step Status Scene, 497

Record TEC Audio Scene, 205

Record Timing Scene, 427

Record Volume, 68

Record Volume Scene, 190

Recover Modem Scene, 154

Renaming

Messages, 445, 446, 504

Metrics, 21, 442, 443

Resources, 18

Scenes, 18


Renaming Metrics, 21

Report Hardware Platrform Scene, 433

Report Testcase Scene, 499

Reporting

Bearer, 159

CID, 159

IMEI, 159

IMSI, 159

LAC, 159

MCC, 159

MNC, 159

Modem Identity, 157

Modem Information, 157

Modem Revision, 157

Modem Type, 157

MSISDN, 159

NID, 159

Party, 159

RSSI, 159

Scenes, 424

SID, 159

TAC, 159

Reporting Framework

Scenes, 495

Rereport a Message Scene, 446

Rereport Messages Scene, 445

Rereport Metrics Scene, 443, 503

Rereport Testcase Messages, 503

Rereport Testcase Messages Scene, 504



Rereport Testcase Metrics Scene, 502

Reset Modem Scene, 155

Resource Parameters

setting, 18, 21

Resource Properties

setting, 18, 21

Resources

Adding, 18

Deleting, 18

for CDMA, 510

for GSM, 510

for LTE, 510

for TD-SCDMA, 510


Renaming, 18

Resource Files, 18

Using, 18

Resources Group, 28

Retrieve Values

Scenes, 110

Roaming, 221

RSSI, 159

Run Local Command Scene, 464

Runtime Parameters

Creating, 20

Validating, 21

S

S60

Scenes, 341, 392

Samsung Galaxy S5 SM-G900F Modem

using, 201

Samsung Galaxy S5 SM-G900V Modem

using, 201

Scale Metric Scene, 433

Scaling Metrics, 432

Scene Parameters

and Runtime Parameters, 21

setting, 18, 21

Scene Properties

setting, 18, 21

Scenes

Adding, 18

Deleting, 18

for CDMA, 510

for GSM, 510

for LTE, 510

for TD-SCDMA, 510


Renaming, 18

Using, 18

Script Resource, 28

Script Scene, 95

Scripting

Engine, 61

Resources, 28

Scenes, 95

Scripts

editing, 18

SE

Scenes, 353, 404

Secure Email, 55, 269

Security

Scenes, 268

Select Form IE Scene, 326

Select Form Scene, 300

Select Frame Scene, 328

Select Operator Scene, 218

Select Option Scene, 325

Select SIM Scene, 162

Select Window Scene, 336

Send and Receive SMS

Scenes, 275, 277, 279

Send Email Scene, 261

Send Instant Message Scene, 291



Send MMS Scene, 284

Send SIP Message Scene, 210

Send SMS Scene, 275

Send Tethered MA MMS S60 Scene, 349, 400

Send Tethered MA SMS S60 Scene, 349, 400

Service Type meta tag

recording, 429

Set IM Presence Scene, 293

Set Prop from SiteConfig Scene, 124

Set Prop Value Scene, 116

Set Props from XML Resource Scene, 125

Set Props List Scene, 117

Set PropStore from XML Resource Scene, 126

Set PropStore Items Scene, 118

Set RADIUS Details Scene, 236

Set RAT Scene, 220

Set Values

Scenes, 115

SID, 159

Sidebar Groups, 19

Signal Strength, 159

Signal Strength %, 159

Signal Strength (dBm), 159

SIM List Resource, 88

SIM Resource, 87

SIM Server

check if ready, 37

SIM Server Resource, 90

Simple Autobrowse Scene, 340

Smart VoiceSession Resource, 66

SmartModem. See Modems

SmartModem Resource, 37

SMS

Inbox, 271, 272

Receive, 271

Receive Notification, 272

Scenes, 269

SMS Ready, 37, 156

SMTP Email

Scenes, 260

Standard

Scenes, 20

Start Content Tests Scene, 374

Start Scene, 21

Metric Aliases, 21

Runtime Parameters, 21

Start Test Scene, 146

Start Testcase Scene, 500, 501

Start Voice Recording Scene, 189

STK

Scenes, 330

Stop Content Tests Scene, 376

Stop Voice Recording Scene, 188

Subscriber Id, 159

Subtracting timings, 443

Supplementary Services

Scenes, 251

Supported

Bearers, 510

Networks, 510

Scenes, 510

SW5728V Type 2 Modem, 466

SW7304 Modem

using, 201

Synch Point, 107, 109, 110

Scenes, 106

Synch Point Scene, 106

Synchronize Test Scene, 145

T

TAC, 159

Take Snapshot Scene, 333

TCC

limitations, 155, 157, 167, 177, 196

timings, 510



TD-SCDMA

Scenes, 510

selecting, 220

TD-SCDMA Modems

Resources, 510

Scenes, 510

using, 510

Telephony

Scenes, 192, 203, 255

Temporary files, 201

deleting, 105

TEMS Audio Capture Module, 201

TEMS Device, 131

TEMS Discovery, 241

Terminals

Resources, 37

Scenes, 150

Tescase Resource, 496

Test

environment, 129

Resources, 32

Scenes, 128

Test Circuit Switched Echo Scene, 184, 215

Test Circuit Switched Loopback Scene, 181, 212

Test Circuit Switched Remote Scene, 183, 214

Testcase

end time, 501

start time, 500

Testing CDMA Networks, 507

Testing GSM Networks, 507

Tokens in XPath Queries, 122, 123, 124

Tracking Area Code, 159

TRP Trace, 241, 246

Type 1 Modems

PESQ, 180, 199

Resources, 510

Scenes, 510

timings, 510

Type 2 Modems, 510

PESQ, 201

POLQA, 201

U

Upload file to Projector Scene, 435

Upload FTP Scene, 229

User Data

using, 21

User Parameters, 21

User Resource, 53

Using

Resources, 18

Scenes, 18

the Default Gateway, 71

the Loop Scene, 103

V

Validating Parameters, 21

VBScript

function definitions, 28

resource, 28

scene, 95

Verify Modem Scene, 156

Verify Network Accessibility ETSI Scene, 173

Verifying Synch Point Scene, 108

Video

Resources, 70

Scenes, 390

Video Call

Scenes, 212

Video Engineer Resource, 72

Video Ping Scene, 234

VideoMOSEngine Resource, 74

VideoPlayer Resource, 71

Virtual network adaptor, 41

Visibility

of the Internet Explorer window, 60



of the WebBrowser window, 63

Visit Multipart Page Scene, 306

Visit Page Scene, 296

Visit Tethered MA Page S60 Scene, 352, 403

Visit Video Scene, 307

Voice

Quality, 201

Resources, 66, 68

Scenes, 185

VoiceSession Resource, 69

VoIP

Resources, 91, 92, 93

Scenes, 206

VoIP Client Resource, 92

VoIP PCAP Resource, 94

VoIP VoiceSession Resource, 93

W

Wait for Call Scene, 177, 196

Wait for Network Scene, 220

Wait for PDP Context Deactivation Scene, 171

Wait for SIP Call Scene, 209

Wait Scene, 105

WAP/Web

Scenes, 295

WCDMA

selecting, 220

WebBrowser

JavaScript support, 332

limitations, 295

Resource, 64

Scenes, 332

Writing VBScript, 95

X

XML File

Resources, 90

XML File Resource, 91

XML Resource

Scenes, 122, 124, 125

XML Resource File

Scenes, 122

XPath Query Scene, 382

Date post:	01-Feb-2018
Category:	Documents
Upload:	vothien
View:	240 times
Download:	4 times

Story Boarder Reference -...

Documents