Post on 16-Mar-2020
transcript
Modeler Objects Cellex Confidential
1
Cellex Virtual subscriber
Modeler Objects Guide
Modeler Objects Cellex Confidential
2
Table of Contents Important Notice ............................................................................................................................................................ 6
1 BROWSER .................................................................................................................................................................... 8 1.1 Browser Click........................................................................................................................................................... 9
1.2 Browser Get Text ................................................................................................................................................... 10 1.3 Browser Go to URL ............................................................................................................................................... 11 1.4 Browser Select Element......................................................................................................................................... 12 1.5 Browser Send Keys ................................................................................................................................................ 13
1.6 Browser Switch Context ........................................................................................................................................ 14 1.7 Browser Screenshot .............................................................................................................................................. 15 1.8 Browser Clear Pop Ups ......................................................................................................................................... 16
1.9 Browser Open ........................................................................................................................................................ 17 2 CMD .............................................................................................................................................................................. 18
2.1 ReadStringFromApp .............................................................................................................................................. 19
2.2 SendStringToApp .................................................................................................................................................. 20
2.3 WaitForAppToEnd ................................................................................................................................................ 21 2.4 Execute Command Line ........................................................................................................................................ 22
3 DATA ............................................................................................................................................................................ 23 3.1 Data Connect .......................................................................................................................................................... 24 3.2 Data Disconnect ..................................................................................................................................................... 25
3.3 DataRoute ............................................................................................................................................................... 26 3.4 Ping ......................................................................................................................................................................... 27
3.5 Data Trace .............................................................................................................................................................. 28 3.6 DNS Lookup .......................................................................................................................................................... 29 3.7 Data Get IP ............................................................................................................................................................. 30
3.8 Data Get Counters .................................................................................................................................................. 31
4 HANDSET .................................................................................................................................................................... 32 4.1 Handset Click ......................................................................................................................................................... 33 4.2 Handset Command Set .......................................................................................................................................... 34
4.3 Handset Press Button ............................................................................................................................................. 35 4.4 Handset Reset ......................................................................................................................................................... 36 4.5 Handset Search Text .............................................................................................................................................. 37 4.6 Handset Search Image ........................................................................................................................................... 38 4.7 Handset Press Key ................................................................................................................................................. 39
4.8 Handset Press Keys Sequence ............................................................................................................................... 40 4.9 Handset Slide Screen ............................................................................................................................................. 41 4.10 Handset Swipe Screen ......................................................................................................................................... 42 4.11 Handset Wait For Image ...................................................................................................................................... 43
4.12 Handset Wait For text .......................................................................................................................................... 44
Modeler Objects Cellex Confidential
3
4.13 Handset Screenshot .............................................................................................................................................. 45
5 Fax .................................................................................................................................................................................. 46 5.1 Fax Connect ........................................................................................................................................................... 47 5.2 Fax Disconnect ....................................................................................................................................................... 48 5.3 Fax Receive ............................................................................................................................................................ 49 5.4 Fax Send ................................................................................................................................................................. 50
6 FTP ................................................................................................................................................................................. 51 6.1 FTP Connect........................................................................................................................................................... 52 6.2 FTP Download ....................................................................................................................................................... 53 6.3 FTP Upload ............................................................................................................................................................ 54
7 FILES ............................................................................................................................................................................. 55
7.1 File Compare .......................................................................................................................................................... 56 7.2 File Load ................................................................................................................................................................. 57
7.3 File Delete .............................................................................................................................................................. 58 7.4 File Copy ................................................................................................................................................................ 59 7.5 File Save ................................................................................................................................................................. 60 7.6 File Get Size ........................................................................................................................................................... 61
8 HTTP ............................................................................................................................................................................. 62 8.1 HttpConnect ........................................................................................................................................................... 63
8.2 HTTP Compare pages .......................................................................................................................................... 64 8.3 HTTP Get Link By Index ...................................................................................................................................... 65 8.4 HTTP URL by index ............................................................................................................................................. 66
8.5 HTTP SearchText .................................................................................................................................................. 67
8.6 Set Concurrent Downloads Limit ......................................................................................................................... 68
8.7 Activate Trace ........................................................................................................................................................ 69 8.8 Get Web Page Images ............................................................................................................................................ 70
9 INSTANT MESSAGING............................................................................................................................................. 71 9.1 IM Receive Message.............................................................................................................................................. 72 9.2 IM Send Message................................................................................................................................................... 73
9.3 IM Get Contact List ............................................................................................................................................... 74 9.4 IM Change Status ................................................................................................................................................... 75
10 Mail .............................................................................................................................................................................. 76 10.1 Mail Send ............................................................................................................................................................. 77 10.2 Mail Receive ........................................................................................................................................................ 78 10.3 Mail Latest Message ............................................................................................................................................ 79
10.4 Mail Disconnect From Server ............................................................................................................................. 80 10.5 Mail Delete Messages .......................................................................................................................................... 81
10.6 Mail Connect ToServer ....................................................................................................................................... 82 11 MMS ............................................................................................................................................................................ 83
11.1 MMS Receive ...................................................................................................................................................... 84 11.2 MMS Send ........................................................................................................................................................... 86 11.3 MMS Send V2 ..................................................................................................................................................... 88
12 PTT Category .............................................................................................................................................................. 90 12.1 PTT Abort Play Sound ........................................................................................................................................ 91 12.2 PTT Abort Record Sound .................................................................................................................................... 92 12.3 PTT Incoming call ............................................................................................................................................... 93 12.4 PTT Leave Call .................................................................................................................................................... 94
12.5 PTT Make Call ..................................................................................................................................................... 95 12.6 PTT Play Sound ................................................................................................................................................... 96
Modeler Objects Cellex Confidential
4
12.7 PTT Record Sound .............................................................................................................................................. 97
12.8 PTT Sign In .......................................................................................................................................................... 98 12.9 PTT Sign-Out ....................................................................................................................................................... 99
13 RADIO ....................................................................................................................................................................... 100 13.1 Network Lock .................................................................................................................................................... 101 13.2 Radio Get Parameters ........................................................................................................................................ 102
13.3 Radio On/Off ...................................................................................................................................................... 104 13.4 Reception ............................................................................................................................................................ 105 13.5 Radio Attach/Detach .......................................................................................................................................... 106
14 SCRIPTS ................................................................................................................................................................... 107 14.1 Delay ................................................................................................................................................................... 108
14.2 ExitError ............................................................................................................................................................. 109 14.3 ExitSuccess ........................................................................................................................................................ 110
14.4 Log Entry ............................................................................................................................................................ 111 14.5 Splitter ................................................................................................................................................................ 112 14.6 Get Time ............................................................................................................................................................. 113 14.7 Force Transfer To Server ................................................................................................................................... 114
14.8 UnassignVUserSIMs ......................................................................................................................................... 115 14.9 Keep Script alive ................................................................................................................................................ 116
14.10 Runs Counter ................................................................................................................................................... 117 14.11 Do Nothing ....................................................................................................................................................... 118 14.12 Reserve Device ................................................................................................................................................ 119
14.13 Discard Run ...................................................................................................................................................... 120
14.14 If ........................................................................................................................................................................ 121
14.15 IF5 ..................................................................................................................................................................... 122 14.16 Loop .................................................................................................................................................................. 123
14.17 Next .................................................................................................................................................................. 124 14.18 FOR .................................................................................................................................................................. 125 14.19 Export Device Value ....................................................................................................................................... 126
14.20 Transfer Files To Slave.................................................................................................................................... 127 14.21 Transfer Files To Master ................................................................................................................................. 128
15 SMS ........................................................................................................................................................................... 129 15.1 Send SMS ........................................................................................................................................................... 130 15.2 SMS Receive ...................................................................................................................................................... 131 15.3 SMS Send RAW ................................................................................................................................................ 132
16 STK – SIM Tool Kit ................................................................................................................................................. 133 16.1 STK Confirm ..................................................................................................................................................... 134
16.2 STK Input Request ............................................................................................................................................ 135 16.3 STK Main Menu ................................................................................................................................................ 136 16.4 STK Input Data .................................................................................................................................................. 137 16.5 STK Sub Menu .................................................................................................................................................. 138 16.6 STK Back ........................................................................................................................................................... 139
16.7 STK Wait For Notification ................................................................................................................................ 140 17 TELNET .................................................................................................................................................................... 141
17.1 Telnet Connect ................................................................................................................................................... 142 17.2 Telnet Disconnect .............................................................................................................................................. 143 17.3 Telnet Send ......................................................................................................................................................... 144
17.4 Telnet Get Text Block ....................................................................................................................................... 145 18 USSD ......................................................................................................................................................................... 146
Modeler Objects Cellex Confidential
5
18.1 USSD Receive ................................................................................................................................................... 147
18.2 Send USSD ........................................................................................................................................................ 148 18.3 Retrieve Balance USSD .................................................................................................................................... 149
19 VARIABLES ............................................................................................................................................................ 150 19.1 CalcDifference ................................................................................................................................................... 151 19.2 IncreaseVar ........................................................................................................................................................ 152
19.3 ResetCounters .................................................................................................................................................... 153 19.4 Tokenize string ................................................................................................................................................... 154 19.5 Set Global Variable Value ................................................................................................................................. 155 19.6 String Constructor .............................................................................................................................................. 156 19.7 Set Measurement Status .................................................................................................................................... 157
19.8 Set variable Value .............................................................................................................................................. 158 19.9 Break String ....................................................................................................................................................... 159
19.10 Declare Variables ............................................................................................................................................. 160 19.11 SetReportVarValue .......................................................................................................................................... 161 19.12 String Replace .................................................................................................................................................. 162 19.13 String Format ................................................................................................................................................... 163
19.14 ParseString ....................................................................................................................................................... 164 19.15 ParseDate .......................................................................................................................................................... 165
19.16 GetUniqueID .................................................................................................................................................... 166 19.17 Device phone number ...................................................................................................................................... 167
20 VIDEO ....................................................................................................................................................................... 168
20.1 Video Progressive .............................................................................................................................................. 169
20.2 Video Streaming ................................................................................................................................................ 171
21 VOICE ....................................................................................................................................................................... 173 21.1 Voice Send DTMF............................................................................................................................................. 174
21.2 Voice Detect Tone ............................................................................................................................................. 175 21.3 Voice Set Hook .................................................................................................................................................. 176 21.4 Voice Quality ..................................................................................................................................................... 177
21.5 Voice Conference .............................................................................................................................................. 179 21.6 Compare Voice Files ......................................................................................................................................... 180
21.7 Voice Set Call Waiting ...................................................................................................................................... 181 21.8 Voice Set Call Barring ....................................................................................................................................... 182 21.9 Audio Prompt Detect ......................................................................................................................................... 183 21.10 Voice Abort Play ............................................................................................................................................. 185
21.11 Voice Play Audio ............................................................................................................................................. 186 21.12 Voice Answer................................................................................................................................................... 187
21.13 Voice Dial ........................................................................................................................................................ 188 21.14 VoiceHangup ................................................................................................................................................... 189 21.15 Voice Set CallForward .................................................................................................................................... 190 21.16 Voice Wait HangUp ........................................................................................................................................ 191 21.17 Voice Wait Waiting Call ................................................................................................................................. 192
21.18 Voice Wait Silence .......................................................................................................................................... 193 21.19 Voice Start Tone Detect .................................................................................................................................. 194 21.20 Voice Switch Call ............................................................................................................................................ 195
22 XML........................................................................................................................................................................... 196 22.1 XML Find Element ............................................................................................................................................ 197
22.2 XML Get Attribute ............................................................................................................................................ 198 22.3 XML Get Element ............................................................................................................................................. 199
Modeler Objects Cellex Confidential
6
22.4 XML Get Sub Element ...................................................................................................................................... 200
22.5 XML Load.......................................................................................................................................................... 201 22.6 Save XML .......................................................................................................................................................... 202 22.7 XML Set Element .............................................................................................................................................. 203
Appendix Measurement ‘Status’ values
Important Notice
Copyright and Trademark Notices
All right, title, and interest in and to Cellex Virtual subscriber (the "Product") and any related
documentation, shall remain with Cellex Networks Ltd. and its licensors. The Product and the
documentation are protected under international copyright, trademark and trade secret and patent laws. The
license granted herein does not constitute a sale of the Product and the documentation or any portion or
copy of it.
Nothing in this document is intended to grant you any rights under any patent and/or copyright and/or other
intellectual property rights of Cellex Networks Ltd. or its licensors. You acknowledge that Cellex Networks
Ltd., or its licensors, own and shall retain all right, title and interest in and to: (i) the Product and/or any
documentation relating thereto, including all intellectual property rights embodied therein (including but
not limited to, translations of documentation or marketing materials); (ii) all of the service marks,
trademarks, trade names or any other designations, and (iii) all copyrights, patent rights, trade secret rights,
and other proprietary rights in the Product and the documentation and you shall have no rights with respect
thereto other than the rights expressly set forth herein.
Limited License
Cellex Networks Ltd. hereby grants you a revocable, non-exclusive, non-transferable license to use the
documentation solely for your own internal business purposes to support your use of the Product in
accordance with Products' license terms.
Proprietary Notices. You must reproduce and include the copyright notices and any other notices that
appear on the original copy of a Product or documentation on any copies made by you on any media.
Modeler Objects Cellex Confidential
7
Disclaimer of Warranties
THE CONTENT AND/OR MATERIALS AVAILABLE BY THIS DOCUMENT ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE"
BASIS AND WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. TO THE FULLEST EXTENT PERMITTED BY
APPLICABLE LAW, Cellex Networks Ltd. EXPRESSLY DISCLAIMS ALL WARRANTIES AND CONDITIONS OF ANY KIND,
WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS.
Limitation of Liability
TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, UNDER NO CIRCUMSTANCES SHALL Cellex Networks Ltd.
OR ANY OF ITS SUBSIDIARIES, AFFILIATES, STOCKHOLDERS, DIRECTORS, OFFICERS, EMPLOYEES, LICENSORS OR SUPPLIERS
(THE “Cellex Networks Ltd .PARTIES”) BE LIABLE, JOINTLY OR SEVERALLY, TO YOU OR ANY OTHER PERSON AS A
RESULT OF YOUR USE OR ACCESS OF THE SERVICE, THE SITE OR ANY CONTENT APPEARING VIA THE SITE AND SERVICE
FOR ANY INDIRECT, CONSEQUENTIAL, INCIDENTAL, SPECIAL, PUNITIVE OR EXEMPLARY DAMAGES, INCLUDING, BUT NOT
LIMITED TO, DAMAGES FOR LOSS OF REVENUE, PROFITS, USE, DATA OR OTHER INTANGIBLES (COLLECTIVELY, THE
“EXCLUDED DAMAGES”), WHETHER OR NOT CHARACTERIZED IN NEGLIGENCE, TORT, CONTRACT OR OTHER THEORY OF
LIABILITY, EVEN IF ANY OF THE Cellex Networks Ltd. PARTIES HAVE BEEN ADVISED OF THE POSSIBILITY OF OR COULD
HAVE FORESEEN ANY OF THE EXCLUDED DAMAGES, AND REGARDLESS OF ANY FAILURE OF AN ESSENTIAL PURPOSE OF A
LIMITED REMEDY. IF ANY APPLICABLE AUTHORITY HOLDS ANY PORTION OF THIS SECTION TO BE UNENFORCEABLE, AND
THEN THE LIABILITY OF THE Cellex Networks Ltd. PARTIES SHALL BE LIMITED TO THE FULLEST POSSIBLE EXTENT
PERMITTED BY APPLICABLE LAW. TO THE EXTENT THE FOREGOING LIMITATION OF LIABILITY IS PROHIBITED OR FAILS OF
ITS ESSENTIAL PURPOSE, PROVIDER’S SOLE OBLIGATION TO YOU FOR DAMAGES SHALL BE LIMITED TO $100.00.
Third-Party Information
Any third-party information which is included as part of this document is subject to the terms and
conditions of such third party provider. All of your rights and remedies with respect to such third party
information and documentation or reference are governed by the applicable third party end-user license or
such other agreement of such third party provider. Cellex Networks Ltd. shall not bear any liability in
connection with any such third party information.
Modeler Objects Cellex Confidential
8
1 BROWSER
“BROWSER” objects enable full automation of a real browser. Objects are used for testing and monitoring Web-
based application and web-sites.
Browser Click
Browser Get Text
Browser Go to URL
Browser Select Element
Browser Send Keys
Browser Switch Context
Browser Take Screenshot
Browser Clear Pop Ups
Browser Open
Modeler Objects Cellex Confidential
9
1.1 Browser Click
Functionality
Click on an Element
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Select By The Type of Selection
Selection Value The value to select by
Seclection Timeout "The Timeout of waiting for the Element to appear, in
Milliseconds
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
Not Found
Exit States
Done
Not Found
Modeler Objects Cellex Confidential
10
1.2 Browser Get Text
Functionality
Get the Text of an Element
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Select By The Type of Selection
Selection Value The value to select by
Seclection Timeout "The Timeout of waiting for the Element to appear, in
Milliseconds
Into Variable The name of the variable to store the Text in
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
Get Text failed
Exit States
Done
Not Found
Modeler Objects Cellex Confidential
11
1.3 Browser Go to URL
Functionality
Go to URL
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
URL The URL to surf to
Timeout "The Timeout of waiting for the page to load, in Seconds
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
GoToURL failed
Exit States
Done
Modeler Objects Cellex Confidential
12
1.4 Browser Select Element
Functionality
Selects an Element on the web page
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Timeout "The Timeout of waiting for the page to load, in Seconds
By The Type of Selection
Value The value to select by
Timeout (ms) The Timeout of waiting for the Element to appear, in Milliseconds
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
SelectElement failed
Exit States
Found
Not Found
Modeler Objects Cellex Confidential
13
1.5 Browser Send Keys
Functionality
Send a sequence of keys to an Element
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Timeout “The Timeout of waiting for the page to load, in Seconds
By The Type of Selection
Value The value to select by
Clear First Clear the contents of the Element firs
Text The sequence of keys to send to the Element
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
HTML Element was not found
Exit States
Done
Not Found
Modeler Objects Cellex Confidential
14
1.6 Browser Switch Context
Functionality
Switch to Context????
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Timeout The Timeout of waiting for the page to load, in Seconds
Select By The Type of Selection
Context Switch the context to either the Default or an inner Frame
Selection Value The value to select by
Seclection Timeout "The Timeout of waiting for the Element to appear, in Milliseconds
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
SwitchToDefault failed
HTML Element was not found
Exit States
Done
Not Found
Modeler Objects Cellex Confidential
15
1.7 Browser Screenshot
Functionality
Take a Screenshot of the Browser window
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
File Name The file name, without the path and extension
Measurements
Variable Name: Functionality/Comments
No Measurement
Error Descriptions
TakeScreenshot failed
Exit States
Done
Modeler Objects Cellex Confidential
16
1.8 Browser Clear Pop Ups
Functionality
In case a popup message is displayed, handle alert message window.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Manual/Automatic Manual or automatic alert handling
Mode Handling Mode
Keys The sequence of keys to send to the Element
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions
Failed to handle modal dialog
Exit States
Done
Modeler Objects Cellex Confidential
17
1.9 Browser Open
Functionality
Start a browsingsession
Input Parameters
Parameter Name: Functionality/Comments
Device ResponsePart
Browser Browser to use
URL The URL to surf to
Profile The Profile to use
Time out The Timeout of waiting for the page to load, in Seconds
User Agent The User-Agent to use
Measurements
Variable Name: Functionality/Comments
User Time Name of Total user time Measurement
Error Descriptions:
BeginSession failed
Exit States
Done
Modeler Objects Cellex Confidential
18
2 CMD
CMD Objects enables to executeexternal applications as part of Cellex script.
Execute Command Line
Wait For App To End
Send String To App
Read String From App
Modeler Objects Cellex Confidential
19
2.1 ReadStringFromApp
Functionality
Readoutput fromApp. Output is saved into variable.
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
ID The ID
Into Variable The name of the variable to store the application's output in
Measurements
Variable Name: Functionality/Comments
No Measurements
Error Descriptions:
ReadOutputFromApp failed
Exit States:
Done
Modeler Objects Cellex Confidential
20
2.2 SendStringToApp
Functionality
Send String to App
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
ID The ID
String Type Send String to app
Measurements
Variable Name: Functionality/Comments
No Measurements
Error Descriptions
SendInputToApp failed
Exit States:
Done
Modeler Objects Cellex Confidential
21
2.3 WaitForAppToEnd
Functionality
Waits for an Application to end.
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
ID The ID
Timeout in MS How long to wait for the Application to terminate, in miliseconds
Measurements
Variable Name: Functionality/Comments
No Measurements
Error Descriptions:
Timed out
Application Ended
Modeler Objects Cellex Confidential
22
2.4 Execute Command Line
Functionality
Execute Command Line
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
Executed app App to execute
TerminateOnScriptEnd Terminate process on script end
CreatePipes Create pipes in order to redirect input/output
TerminateMethod Terminate method
ID The ID
CommandLineParams Command line params passed to app
Measurements
Variable Name: Functionality/Comments
No Measurements
Error Descriptions:
Command Failed To Execute
Exit States:
Command Executed
Modeler Objects Cellex Confidential
23
3 DATA
Basic Data functionality.
Data Connect
Data Disconnect
Data Route
Data Trace
Data Get IP
Data Get Counters
Ping
DNS Lookup
Modeler Objects Cellex Confidential
24
3.1 Data Connect
Functionality
Establish Cellular data connection.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
APN APN Selection
Data_Trace Defines the comparison time
RedialAttempts Redial Attempts on failure
Time_Between_Redial_Atte
mpts
Time Between Redial Attempts
Trace_Size_Limit_KB Data Trace file size limit, in kilobytes
DelayAfterCaptureStart Delay to allow capture app time to start before first packet
Information: Connection IP Name of Info Var for Data Connection IP
DNS Route To preform DNS route Yes or No
DialupPrefix Prefix for dialup connection in case of manual dialer
Source xDR field Source xDR field
HSDPA category The Category number to use for download / upload
Measurements
Variable Name: Units Functionality/Comments
UserTime Seconds The total time of the transaction
DataConnectDelay Seconds Time that took to establish data connection
Error Descriptions
Data Routing failed
Data Connect failure counter reached limit
Exit States
Done
Notes
When using HTTP script need to used APN ‘Internet’
Modeler Objects Cellex Confidential
25
3.2 Data Disconnect
Functionality
Disconnect data connection
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States:
Data disconnected
Notes:
In case of not using this object the Cellex script will close all open connections
Modeler Objects Cellex Confidential
26
3.3 DataRoute
Functionality
Add route to routing table, in order toroutes to a specific IP address. In most cases routing is handled by the specific
object.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Route IP Route IP Address
Redial Attempts Redial Attempts
Measurements
Variable Name: Units Functionality/Comments
UserTime Seconds The total time of the transaction
RouteDelay Seconds Time that took to route data connection
Error Descriptions:
Routing failed.
Exit States:
Route Success.
Data route failed.
Notes:
This object need to be used in FTP DNS scenarios.
Modeler Objects Cellex Confidential
27
3.4 Ping
Functionality
Send ping to specific IP address or web address
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Address IP address to ping.
Payload The sent data.
Payload Length Length of the sent data.
NumIterations Description=”Number of Ping iterations.” DefValue=”1”/
IntervalMS Interval between consecutive Ping iterations (in milliseconds).”
DefValue=”1000”
RouteRetries Route Attempts
Information: Connection IP Name of Info Var for Data Connection IP
Measurements
Variable Name: Units Functionality/Comments
Success Ping success Report Variant (optional)
Roundtrip Milliseconds Roundtrip Report Variant (optional), in milliseconds
UserTime Seconds Total user time Report Variant
Exit States:
Done
Ping failed
Notes:
In case of using more than one ping iterations the report will show in average
Modeler Objects Cellex Confidential
28
3.5 Data Trace
Functionality
Sniffer the IP communication of a selected device. PCAP file will be uploaded as part of script content.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Trace_Size_Limit_KB Data Trace file size limit, in kilobytes
Measurements
Variable Name: Functionality/Comments
No Measurements
Exit States:
Trace Activated.
Notes
Need to be used only in Ethernet scripts.
Modeler Objects Cellex Confidential
29
3.6 DNS Lookup
Functionality
DNS lookup.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Address Address
Resolved IP Resolved IP
Measurements
Variable Name: Units Functionality/Comments
Domain Resolve Time Seconds Domain Resolve Time
Error Descriptions:
DNS Lookup failed.
Exit States:
Done.
Modeler Objects Cellex Confidential
30
3.7 Data Get IP
Functionality
Get IP address of network adaptor.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Connection IP Connection IP
Measurements
Variable Name: Units Functionality/Comments
No Variables
Error Descriptions:
Get Connection IP failed.
Exit States:
Done.
Modeler Objects Cellex Confidential
31
3.8 Data Get Counters
Functionality
Get Connection Info counters: bytes received, bytes transmitted, etc’
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Measurements
Variable Name: Units Functionality/Comments
BytesTransmitted Bytes Bytes Transmitted
BytesReceived Bytes Bytes Received
ConnectionDuration mSeconds Connection Duration
Total Volume Bytes Total volume received
Error Descriptions
Get Connection Info failed.
Exit States
Done.
Notes
This object need to come before Data disconnect object
Modeler Objects Cellex Confidential
32
4 HANDSET
Handset objects are used to develop scripts for Android, iPhone apps.
Handset Click
Handset Command Set
Handset Press Button
Handset Reset
Find Search Text
Handset Search Image
Handset Press Key
Handset Press Keys Sequence
Handset Slide Screen
Handset Swipe Screen
Handset Wait For Image
Handset Wait For text
Handset Screenshot
Modeler Objects Cellex Confidential
33
4.1 Handset Click
Functionality
Click Screen
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
X X coordinate of the screen
Y Y coordinate of the screen
MouseButton Mouse button to click
DurationMS Click Duration
DelayBefore Delay before button pressed
DelayAfter Delay after button pressed
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Clicked Screen Failed
Exit States
Clicked Screen
Modeler Objects Cellex Confidential
34
4.2 Handset Command Set
Functionality
Read set of actions from a file and execute the actions one after the other.
Input Parameters
Parameter Name: Functionality/Comments
Input file name The Input file name
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions:
LoadTextFile failed
Exit States:
Clicked Screen
Reached end of file
Slide screen
Notes
Read the input file, skip lines that were already processed, process new lines (if there are any),
and wait for the input-file to change
Modeler Objects Cellex Confidential
35
4.3 Handset Press Button
Functionality
Press Button: Home, Restart, Back, etc’
Input Parameters
Parameter Name: Functionality/Comments
Device Source device
Button Smartphone button to press
Duration (ms) Duration in Milliseconds
DelayBefore Delay before button is pressed
Delay after Delay after key is pressed
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
PressButton failed
Exit States
Done
Modeler Objects Cellex Confidential
36
4.4 Handset Reset
Functionality
Reset the Handset
Input Parameters
Parameter Name: Functionality/Comments
Device Source device
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Error Descriptions
Failed to reset device
Exit States
Done
Modeler Objects Cellex Confidential
37
4.5 Handset Search Text
Functionality
Using OCR, look for aspecific Word in Image
Input Parameters
Parameter Name: Functionality/Comments
Device Source device
Word The word to look for
Look in Image The Image to look in, or the last Screenshot from the Device
Confidence (Percent) The required matching confidence
Look for Image The Image to look for
Image Pre-processing Pre-processing algorithm to improve image readability
Pre-processing Value 1st value for the Pre-processing algorithm
Region of interest X The Region of interest X
Region of interest Y The Region of interest Y
Region of interest Width Region of interest Width
Region of interest Height The Region of interest Height
Save Pre-processed in File Image file to store Pre-processing result in
Language Codes Language codes from ISO 639-3
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Find word in image failed
Take Screenshot failed
Exit States:
Detected
Not Detected
Modeler Objects Cellex Confidential
38
4.6 Handset Search Image
Functionality
Look for the existence of an image (icon, butoon, etc’) in the handset screen.
Input Parameters
Parameter Name: Functionality/Comments
Device Source device
Look in Image The Image to look in, or the last Screenshot from the Device
Look for Image The Image to look for
Confidence (Percent) The required matching confidence
Region of interest X The Region of interest X
Region of interest Y The Region of interest Y
Region of interest Width Region of interest Width
Region of interest Height The Region of interest Height
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions:
Image find failed
TakeScreenshot failed
Exit States:
Detected
Image Not Detected
Modeler Objects Cellex Confidential
39
4.7 Handset Press Key
Functionality
Press key in handset keyboard.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Virtual Key Thevirtual key to press
Delay Before Delay before key is pressed
Delay After Delay after key is pressed
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
Press Key failed.
Exit States:
Pressed key.
Modeler Objects Cellex Confidential
40
4.8 Handset Press Keys Sequence
Functionality
Press set of keys in handset keyboard.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Keys Thevirtual keys to press
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
SendKeysSequence failed.
Exit States
Pressed keys.
Modeler Objects Cellex Confidential
41
4.9 Handset Slide Screen
Functionality
Slide Screen
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
StartX Start X coordinate of the screen
StartY Start Y coordinate of the screen
IntervalLength Slide interval length
Direction Slide Direction
DelayBefore Delay before button is pressed
DelayAfter Delay after button is pressed
File name File which will store screenshot
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
SlideScreen starting at X,Y failed.
Exit States:
Done.
Modeler Objects Cellex Confidential
42
4.10 Handset Swipe Screen
Functionality
From Swipe action on screen.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Start X Start X coordinate on the screen
Start Y Start Y coordinate on the screen
End X End X coordinate on the screen
EndY End Y coordinate on the screen
Starting Duration The duration of the movement, in Milliseconds
Ending Duration The duration before the release, in Milliseconds
DelayBefore Delay before screen is pressed
Delay after Delay after screen is pressed
File name File which will store screenshot
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description:
Slide Screen starting at X,Y failed .
Exit States:
Done.
Modeler Objects Cellex Confidential
43
4.11 Handset Wait For Image
Functionality
Wait for imageto be displayed on screen. Measure time till image appeared.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Wait_for_screen_interval # of times to poll the screen until we get the expected capture
Look in Image The Image to look in, or the last Screenshot from the Device
Confidence (Percent) The required matching confidence
Region of interest X The Region of Interest X
Region of Interest Y The Region of Interest Y
Region of interest Width The Region of Interest Width
Region of interest Height The Region of interest Height
File name File which will store screenshot
Measurements
Variable Name: Units Functionality/Comments
Comparison result
ReportVar
Indicates whether compared region was identical
Wait delay ReportVar Seconds Time interval to wait for the expected screen
UserTime ReportVar Seconds Total user time Report Var
Error Description
Take Screenshot failed..
Image find failed
Did not receive the expected screen
Exit States
Done.
Did not received the expected screen
Modeler Objects Cellex Confidential
44
4.12 Handset Wait For text
Functionality
Wait for text to be displayed on screen.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Wait_for_text_interval # of times to poll the screen until we get the expected text
Look in Image The Image to look in, or the last Screenshot from the Device
Word The word to look for
Confidence (Percent) The required matching confidence
Image Pre-processing Pre-processing algorithm to improve image readability
Pre-processing Value 1st value for the Pre-processing algorithm
Region of interest X The Region of interest X
Region of interest Y The Region of interest Y
Region of interest Width The Region of interest Width
Region of interest Height The Region of interest Height
Save Pre-processed in File Image file to store Pre-processing result in
Measurements
Variable Name: Units Functionality/Comments
Comparison result
ReportVar
Indicates whether compared region was identical
Wait delay ReportVar Seconds Time interval to wait for the expected screen
UserTime ReportVar Seconds Total user time Report Var
Error Description
Find word in image failed.
TakeScreenshot failed.
Exit States
Detected.
Not Detected.
Modeler Objects Cellex Confidential
45
4.13 Handset Screenshot
Functionality
Taking snapshot of device screen.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
File name File which will store screenshot
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
Take Screenshot failed.
Exit States
Done
Modeler Objects Cellex Confidential
46
5 Fax
Perform Fax operations.
Fax Connect
Fax Send
Fax Receive
Fax Disconnect
Modeler Objects Cellex Confidential
47
5.1 Fax Connect
Functionality
Establish Fax connection
Input Parameters
Parameter Name: Functionality/Comments
From Device Device for the fax service.
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Fax Connect failed.
Exit States
Fax connected.
Modeler Objects Cellex Confidential
48
5.2 Fax Disconnect
Functionality
Disconnect fax service.
Input Parameter
Parameter Name: Functionality/Comments
Device The device that was used for Fax service
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Fax Disconnect failed.
Exit States:
Fax disconnected.
Modeler Objects Cellex Confidential
49
5.3 Fax Receive
Functionality
Receive fax message.
Input Parameters
Parameter Name: Functionality/Comments
To Device Specify which device will receive the fax message
ReceiveTimeout The amount of time to wait for fax message
Expected Page Expected number of pages
ID The fax id.
Measurements
Variable Name: Units Functionality/Comments
Fax receive delay Seconds The amount of time took to receive the fax message
Success 1/0
Error Description
Receive Fax failed, reported error.
Receive Fax failed.
Receive Fax timeout.
Exit States
Received fax
Modeler Objects Cellex Confidential
50
5.4 Fax Send
Functionality
Send Fax message
Input Parameters
Parameter Name: Functionality/Comments
From Device Select source device
DestinationFaxNumber Optional parameter
File to send Specify the file to send
Operation End-time Variant Variable that holds the last time stamp
ID The fax id.
Convert file anyway Indicates whether we want to convert non-fmf files even if a
converted file already exists
Measurements
Variable Name: Units Functionality/Comments
Send Delay Seconds The amount of time took to send the fax message
UserTime Seconds The total transaction time
Success Success report var
Error Descriptions
Send fax failed, reported error.
Send fax failed.
Exit States
Fax sent
Modeler Objects Cellex Confidential
51
6 FTP
FTP operations
FTP Connect
FTP Download
FTP Upload
Modeler Objects Cellex Confidential
52
6.1 FTP Connect
Functionality
Connect to FTP server
Input Parameters
Parameter Name: Functionality/Comments
Device SourceDevice
Server Address FTP Server IP
Port FTP port
Mode Connection mode
(active/passive/ForceExtendedPassive/ForceRegularPassive/SFTP)
UserName Username for FTP connection
Password Password for FTP connection
FTP Error Variable to receive FTP error description
Measurements
Variable Name: Units Functionality/Comments
UserTime Seconds Total user time Report Variable
Error Descriptions
FTP Connect failed
Exit States
Done
Connect Failed
Modeler Objects Cellex Confidential
53
6.2 FTP Download
Functionality
Download file from FTP
Input Parameters
Parameter Name: Functionality/Comments
File name The file to download from FTP
Server Address FTP Server IP
Port FTP port
Mode Connection mode
(active/passive/ForceExtendedPassive/ForceRegularPassive/SFTP)
UserName Username for FTP connection
Password Password for FTP connection
RemoteDir Remote directiry
FTP Error Variable to receive FTP error description
Into variable Defines the variable that will include the data from the loaded file.
Measurements
Variable Name: Units Functionality/Comments
File Size Bytes Size of the downloaded File.
Duration Seconds Duration in seconds
BandWidth BytesPerSec Bandwidth in Bytes per Seconds
UserTime Seconds Total user time Report Variable
Exit States
Done
Download failed
Modeler Objects Cellex Confidential
54
6.3 FTP Upload
Functionality
Upload file to FTP
Input Parameters
Parameter Name: Functionality/Comments
File name The file to upload to FTP
Server Address FTP Server IP
Port FTP port
Mode Connection mode
(active/passive/ForceExtendedPassive/ForceRegularPassive/SFTP)
UserName Username for FTP connection
Password Password for FTP connection
RemoteDir Remote directiry
FTP Error Variable to receive FTP error description
Into variable Defines the variable that will include the data from the loaded file.
Measurements
Variable Name: Units Functionality/Comments
File Size Bytes Size of the uploaded File.
Duration Seconds Duration in seconds
BandWidth BytesPerSec Bandwidth in Bytes per Seconds
UserTime Seconds Total user time Report Variable
Exit States
Done
Upload failed
Modeler Objects Cellex Confidential
55
7 FILES
Operations of files.
File Compare
File Load
File Delete
File Copy
File Save
File Get Size
Modeler Objects Cellex Confidential
56
7.1 File Compare
Functionality
Compares two files in binary mode
Input Parameters
Parameter Name: Functionality/Comments
First file Select first file
Second file Select second file
Measurements
Variable Name: Units Functionality/Comments
Match 1 – files are identical ; 0 – files not match
Exit States
Files are different.
Files are identical.
Modeler Objects Cellex Confidential
57
7.2 File Load
Functionality
Loads text file into variable
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
File name The file name to load
Into variable Defines the variable that will include the data from the loaded file.
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Load Text File failed.
Exit States
Done
Modeler Objects Cellex Confidential
58
7.3 File Delete
Functionality
Delete file.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
DeleteFile The file to delete
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
DeleteFile failed.
Exit States
File Deleted.
Modeler Objects Cellex Confidential
59
7.4 File Copy
Functionality
Copy file
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Source File Source file
Destination Path to destination
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Copy file failed.
Exit States
File Copied.
Modeler Objects Cellex Confidential
60
7.5 File Save
Functionality
Writes data to a text file.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Output File name The name of the output text file
Output Data Data to be written into file
Append Overwrite file or append to it. (Yes/No)
Convert special chars Convert special chars before saving. (Yes/No)
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Save to text filefailed.
Exit States
Done
Modeler Objects Cellex Confidential
61
7.6 File Get Size
Functionality
Get the file size
Input Parameters
Parameter Name: Functionality/Comments
File name The name of the file
Device device
In to Variable The name of the variable to store the file size in
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
62
8 HTTP
HTTP and Web operations
HTTP Connect
Compare Web Pages
Get Link by Index
Go to URL by Index
Search Text in Web Page
Set Concurrent Download Limit
Activate Trace
Get Web Page Images
Modeler Objects Cellex Confidential
63
8.1 HttpConnect
Functionality
Connects the modem/handset to the operator's gateway – should be used after Data Connect in this case.
Establish connection via Ethernet.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Gateway Defines which gateway to connect to (By Operator/ User defined/
None)
Gateway Port Gateway port (only for user-defined gateway)
Gateway Username Gateway username (only for user-defined gateway)
Gateway Password Gateway password (only for user-defined gateway)
DownloadsLimit Concurrent Downloads Limit. Default = 10
ServerDnldLimit Concurrent Downloads Limit for each server. Default = 4
Route
Measurements
Variable Name: Units Functionality/Comments
Gateway Connection Delay Seconds Time that took to connect to the gateway
UserTime Seconds The total time of the transaction
Error Descriptions
Set concurrent downloads limit failed
Routing to Gateway failed
Connecting to Gateway failed
Exit States
Connected to HTTP
HTTP Connect failed
Modeler Objects Cellex Confidential
64
8.2 HTTP Compare pages
Functionality
Search text in web page
Input Parameters
Parameter Name: Functionality/Comments
First Page ID The ID used to identify the first page
Second Page ID The ID used to identify the Second page
Measurements
Variable Name: Units Functionality/Comments
Match ReportVar Result of compare (1=Match, 0=No match)
No Measurements
Error Descriptions
Pages are different
Exit States
Pages are identical
Pages are different
Modeler Objects Cellex Confidential
65
8.3 HTTP Get Link By Index
Functionality
Get Links By Index
Input Parameters
Parameter Name: Functionality/Comments
Device Device number
Index Index Var
Put URL in Var URL
In page ID The ID used to identify the downloaded page
URL Filter A text that should appear in the returned URL
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
No more links
Exit States
No more links
Got Link
Modeler Objects Cellex Confidential
66
8.4 HTTP URL by index
Functionality
Go to URL by index
Input Parameters
Parameter Name: Functionality/Comments
Device Device number
Page ID The ID used to identify this page"
Index Index Va
New Page ID The ID for the new page
Measurements
Variable Name: Units Functionality/Comments
BandWidth ReportVar Bandwidth Measurement, in Bytes per second
User Time Name of Total user time Measurement
Receive Delay Name of Download delay Measurement.
Http Status Name of HTTP Status Measuremen
Error Descriptions
Page download timeout
Exit States
Page Downloaded
No Such Index
Modeler Objects Cellex Confidential
67
8.5 HTTP SearchText
Functionality
Search text in a specified web page.
Input Parameters
Parameter Name: Functionality/Comments
Text_to_Find The text to find in the web page
In Page ID The ID used to identify the downloaded page
TextFound TimeStamp Text found time stamp
Measurements
Variable Name: Units Functionality/Comments
TextFound Indicates if we found the expected text in the web-
page
Error descriptions
The content is not a web page.
Exit States
Text found
Text not found
Modeler Objects Cellex Confidential
68
8.6 Set Concurrent Downloads Limit
Functionality
Set concurrent downloads limit
Input Parameters
Parameter Name: Functionality/Comments
Device
Download Limit Concurrent Downloads Limit. Set -1, to for unlimited concurrent
downloads
Download Limit Concurrent Downloads Limit for each server
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error descriptions
Set concurrent downloads limit failed
Exit States
Done
Modeler Objects Cellex Confidential
69
8.7 Activate Trace
Functionality
Activate Trace
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Download Limit Concurrent Downloads Limit. Set -1, to for unlimited concurrent
downloads
ID The ID
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error descriptions
Set concurrent downloads limit failed
Exit States
Done
Modeler Objects Cellex Confidential
70
8.8 Get Web Page Images
Functionality
Download the Images of a downloaded web page
Input Parameters
Parameter Name: Functionality/Comments
Of Page ID The ID used to identify the downloaded page
Measurements
Variable Name: Units Functionality/Comments
HTTP HTTP Status
UserTime ReportVar Total user time Report Var
Status Receive Delay
ReportVar
Download delay Report Var
Error descriptions
Set concurrent downloads limit failed
Exit States
Done
Modeler Objects Cellex Confidential
71
9 INSTANT MESSAGING
Instant Messaging objects are using for building scripts which send and receive Instant Messaging such as:
Microsoft Messenger, Skype, Facebook Chat, etc’
IM Receive Message
IM Send Message
IM Get Contact List
IM Change Status
Modeler Objects Cellex Confidential
72
9.1 IM Receive Message
Functionality
Receive a private message
Input Parameters
Parameter Name: Functionality/Comments
Device device name
FromMedium The type of Instant Messaging network where the Contact is
FromContact The name of the Contact to receive the message from
Delay Start-time Var The Var that holds the time from which the calculated delay
starts
Expected_Message The text we expect to receive
Measurements
Variable Name: Units Functionality/Comments
Receive Delay ReportVar IM Receive delay Report Var
UserTime ReportVar Total user time Report Var
Error Descriptions
Message Received Failed
Exit States
Message Received
Message Received Failed
Modeler Objects Cellex Confidential
73
9.2 IM Send Message
Functionality
Send a private message
Input Parameters
Parameter Name: Functionality/Comments
Device device name
Medium The type of Instant Messaging network where the Contact is
Name The name of the Contact to Send the message to
Text The Message text
Operation End-time Var The Var that will hold the time of the operation's completion
Store text in Var The Var that holds the sent text
Measurements
Variable Name: Units Functionality/Comments
Message send time
ReportVar
DateTime Message send time Report Var
Exit States
Message Sent
Modeler Objects Cellex Confidential
74
9.3 IM Get Contact List
Functionality
Get Contacts
Input Parameters
Parameter Name: Functionality/Comments
Device device name
Connection ID Contacts of which Connection to list
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Descriptions
Getting Contacts list failed
Exit States
Received Contact-list
Modeler Objects Cellex Confidential
75
9.4 IM Change Status
Functionality
Change my Status
Input Parameters
Parameter Name: Functionality/Comments
Device device name
Status The Status my contacts will see for me
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Descriptions
Change My Status failed
Exit States
Done
Modeler Objects Cellex Confidential
76
10 Mail
Mail objects are used in order to develop scripts simulating SMTP/POP3 applications.
Connect To Email Server
Mail Send
Mail Receive
Mail Latest Message
Mail Delete Messages
Mail Disconnect From Server
Modeler Objects Cellex Confidential
77
10.1 Mail Send
Object ID
Functionality
Send email by using SMTP
Input Parameters
Parameter Name: Functionality/Comments
To_Address To address
Device Source Device
From_Address From address
Subject Email subject
Text_Body Email text body
Attach File Attach file
Attachment Type Attachment Type
ID Cellex internal use
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Error Descriptions
Send Email failed
Exit States
Done
Modeler Objects Cellex Confidential
78
10.2 Mail Receive
Functionality
Receive Email using POP3
Input Parameters
Parameter Name: UI
Var
Functionality/Comments
Username Username
Password Password
POP_Server_Name POP_Server_Name
Server_Port Server_Port
Connect Retries Connect Retries
Extract attachments Extract attachments
ID The ID
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit State
Command executed
Modeler Objects Cellex Confidential
79
10.3 Mail Latest Message
Functionality
Fetch message
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
Subject The subject pattern
Sender The sender pattern
Flag Flag
Received EMailID EmailID
Received Subject The subject of Email
Received From The sender pattern
Received Body The sender pattern
Received Attachments The sender pattern
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
FetchLatestMessage failed
Exit States
Done
Not Found
Modeler Objects Cellex Confidential
80
10.4 Mail Disconnect From Server
Functionality
Disconnect from email Server
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
Disconnect failed
Exit States
Done
Modeler Objects Cellex Confidential
81
10.5 Mail Delete Messages
Functionality
Delete Email/s
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
EMailID EMailID
Subject The subject pattern
Sender The sender pattern
Flag Flag
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
DeleteE-Mail failed.
Exit States
Done
Modeler Objects Cellex Confidential
82
10.6 Mail Connect ToServer
Functionality
Input Parameters
Parameter Name: Functionality/Comments
Device Define the device type
Protocol Protocol
HostName Hostname of Email server
Username Username
Password Password
TLS Type TLS
EMailBoxFolderName Inbox Description
SocksHostname SocksHostname
Socks Username Socks Username
Socks password Socks password
Socks Version Socks Version
SocksPort SocksPort
HttpProxyHostname HttpProxyHostname
HttpProxyPort HttpProxyPort
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
Connect to the email server
Exit States
Done
Modeler Objects Cellex Confidential
83
11 MMS
Modeler Objects Cellex Confidential
84
11.1 MMS Receive
Functionality
Receive MMS
Input Parameters
Parameter Name: Functionality/Comments
Receiving Device Defines the input device name
MMS ID Cellex internal use
MMS Start-Time Var The Var that holds the time the MMS Send began
Delay Start-Time Var A variable that holds the operation end time value.
Expected MMS Subject By default, a different subject is sent each time.
Compare Content Compare content (Yes/No)
Data_Trace Data trace (Yes/No)
Redial Attempts Number of radial attempts
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
Notification Delay Seconds Amount of time before notification arrived
Download Delay Seconds Amount of time that took to download MMS
Data Connection Delay Seconds Amount of time that took to establish connection
User Time Seconds The total time of the transaction
MMS Notification Time Seconds MMS Notification Time report variable
MMS Receive Time Seconds MMS Receive Time report variable
Error Descriptions
Data connect failure counter reached limit.
Routing failed.
MMS Download failed.
Cannot get text from received MMS.
Received MMS text does not match the sent text.
Cannot get image from received MMS.
Notification Removal failed.
Destination Data Disconnect failed.
Modeler Objects Cellex Confidential
85
MMS Notification receive timeout.
MMS download timeout.
Exit States
Additional Info.
MMS Not received..
MMS received..
Modeler Objects Cellex Confidential
86
11.2 MMS Send
Functionality
Send MMS
Input Parameters
Parameter Name: Functionality/Comments
From Device Defines the input device name
Destination MMS Destination number
RequestDeliveryReport An option to request delivery report
MMS ID Cellex internal use
MMS Subject The MMS Subject
Send Text MMS content text
Send Image file MMS Image file
Image content-type Image content type
Operation End-Time Variable that holds the operation end time value
Store Subject in Var Variable that holds the sent MMS Subject
Data Trace Start data trace (yes/no)
Redial Attempts Number of redial attemps.
Operation Start-Time Var The Var that will hold the time of the operation's beginning
Operation End-Time Var The Var that will hold the time of the operation's completion
SenderUserAgent The User-Agent of the sending Handset.
Data_Trace Data Trace
Source xDR field Source xDR Field
DelayAfterCaptureStart DelayAfterCaptureStart
Dest xDR field Dest xDR Field
Measurements
Variable Name: Units Functionality/Comments
MMS Send Time DateTime Amount of time that took to send MMS
UserTime Seconds The total time of the transaction
Data Connection Delay Seconds Data connection delay
MMS Send Delay Seconds MMS send Delay report variable
Error Descriptions
Data connect failed.
Modeler Objects Cellex Confidential
87
Routing failed.
Sending MMS failed.
Source Data Disconnect failed.
Exit States
MMS sent.
Additional info.
Modeler Objects Cellex Confidential
88
11.3 MMS Send V2
Functionality
Send simple MMS
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Destination Destination Number
MMS Subject The MMS Subject
MMS Width The MMS Width
MMS Text The MMS Text
MMS Height The MMS Height
JPG File Image file to include in MMS
URL The URL of the page to download
Ack Download ID The ID used to identify this MMS
Detailed Report flags Flags (Bit Mask) that control the amount of details reported
Verify sent request Check whether a request was sent within reasonable time
Measurements
Variable Name: Units Functionality/Comments
Send Ack Receive Delay Seconds Name of Acknowledge delay Measurement
UserTime Seconds Name of Total user time Measurement
Send Ack HTTP Status Name of HTTP Status Measurement
Error Descriptions
Get Connection Info failed.
Nothing was transmitted during request
An internal error occurred while downloading request
Timeout while downloading request
Connection was closed by the remote host while downloading request.
Exit States
Downloaded successfully
The request return an error
Could not retrieve the url/link
Nothing was transmitted
Modeler Objects Cellex Confidential
89
Modeler Objects Cellex Confidential
90
12 PTT Category
Objects for Push to Talk over GSM
PTT Sign In
PTT Make Call
PTT Incoming Call
PTT Play Sound
PTT Record Sound
PTT Abort Play Sound
PTT Abort Record Sound
PTT Leave Call
PTT Sing Out
Modeler Objects Cellex Confidential
91
12.1 PTT Abort Play Sound
Functionality
Abort Play Sound object in the middle, before play is completed.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Abort sound play failed
Exit States
Sound Aborted
Modeler Objects Cellex Confidential
92
12.2 PTT Abort Record Sound
Functionality
Abort PTT Record Sound in the middle, before silence was detected.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Error Descriptions
Abort sound record failed
Exit States
Sound Aborted
Modeler Objects Cellex Confidential
93
12.3 PTT Incoming call
Functionality
Wait for Incoming PTTcall
Input Parameters
Parameter Name: Functionality/Comments
Device Device
PTT Incoming cal Answer Incoming Calls From
Accept Call Accept Call
Dial End-time Var The Var that holds the time from the end of the Dial operation
Measurements
Variable Name: Units Functionality/Comments
Incoming Call Delay
ReportVar
Incoming call delay Report Var
UserTime ReportVar Total user time Report Var
Error Descriptions
Did not receive a call
Exit States
Answered call
Did not receive a call
Modeler Objects Cellex Confidential
94
12.4 PTT Leave Call
Functionality
Leave PTT call
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Answer End-time Var The Var that holds the time from the end of the Dial operation
Accept Call Accept Call
Dial End-time Var The Var that holds the time from the end of the Dial operation
Measurements
Variable Name: Units Functionality/Comments
Call Duration ReportVar Seconds Call Duration Report Var
UserTime ReportVar Seconds Total user time Report Var
CallEndTime ReportVar DateTime CallEndTime ReportVar
Error Descriptions
Did not receive a call
Exit States
Answered call
Did not receive a call
Modeler Objects Cellex Confidential
95
12.5 PTT Make Call
Functionality
Setup PTT call
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Destination Dest
Call Type Call Type
Call Mode Call mode synchronic or asynchronous
Dial End-time Var Call mode synchronic or asynchronous
Measurements
Variable Name: Units Functionality/Comments
Connect Delay ReportVar Seconds Call Start time Report Var
Call Start Time ReportVar DateTime Call Start time Report Var
Call Duration ReportVar Seconds Call duration Report Var
UserTime ReportVar Seconds Total user time Report Var
Error Descriptions
PTT call was disconnected in the middle
PTT call was disconnected before it started
Exit States
Signed In
Call Disconnected
Call timeout
Modeler Objects Cellex Confidential
96
12.6 PTT Play Sound
Functionality
PTT Play Sound
Input Parameters
Parameter Name: Functionality/Comments
Device Device
File Name File to play
Wait Until End Wait for the sound to end
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Description
PTT play sound failed
Exit States
Play Sound
Modeler Objects Cellex Confidential
97
12.7 PTT Record Sound
Functionality
PTT Record Sound
Input Parameters
Parameter Name: Functionality/Comments
Device Device
File Name File to Record
Wait Until End Wait for the sound to end
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Descriptions
Record Sound Failed
Exit States
Play Sound
Modeler Objects Cellex Confidential
98
12.8 PTT Sign In
Functionality
Sign In to PTT service using login credentials.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
ServerAddress IP of server
UserName Username
Password Password
LoginLevel Login Level
InitialState Initial State
WaitForDefaultChatroom Wait For Default Chatroom
Measurements
Variable Name: Units Functionality/Comments
Sign-In Delay ReportVar Seconds Sign-In delay Report Var
Error Description
Failed to sign in to PTT server,
Sign in to PTT server was denied
Exit States
Signed In
Signed time out
Modeler Objects Cellex Confidential
99
12.9 PTT Sign-Out
Functionality
Sign Outfrom PTT Session.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
PTT sign-out failed
Exit States
Out
Modeler Objects Cellex Confidential
100
13 RADIO
Radio related objects, get radio parameters as well as lock to a specific network.
Network Lock
Radio Get Parameters
Radio On/Off
Reception
Radio Attach/Detach
Modeler Objects Cellex Confidential
101
13.1 Network Lock
Object ID
Functionality
Lock on a specific Network according to NetworkID or required ACT.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
NetworkID NetworkID
NetworkType NetworkType
Measurements
Variable Name: Units Functionality/Comments
NetworkLock Delay Seconds Network Lock delay Measurement
Exit States
Done.
Modeler Objects Cellex Confidential
102
13.2 Radio Get Parameters
Functionality
Get Radio Engineering Parameters: Cell ID, ACT, OAC, RxLev, Etc;
Input Parameters
Parameter Name: Functionality/Comments
Device SourceDevice
Use_Default_Names Use default parameters' names (Yes/No)
Operator name The Operator name, info var
ACT Access technology of the serving cell (2G/3G
Get RxLeV The Operator name, info var
(U)ARFCN[Dec] ARFCN (Absolute Radio Frequency Channel Number) of the
BCCH carrier
MCC[Dec] Mobile Country Code
MNC[Dec] Mobile Network Code
LAC[Hex] Location Area Code
CellID[Hex] The CellID of the current device
C1[Dec] Coefficient for base station selection (relevant only for 2G)
PSC[Dec] Primary Synchronisation Code (relevant only for 3G, Decimal)
Ec/Io[dB] Carrier to noise ratio in dB (relevant only for 3G)
RSCP[dBm Received Signal Code Power in dBm (relevant only for 3G)
LTE_Band LTE band (relevant only for 4G)
LTE_Bw LTE bandwidth (relevant only for 4G)
LTE_RxChan LTE RX channel (relevant only for 4G)
LTE_TxChan LTE RTX channel (relevant only for 4G)
RSRP[dBm] Tracking Area Code (relevant only for 4G)
TAC[Dec] Tracking Area Code (relevant only for 4G)
RSRQ[dB] Reference Signal Receive Quality in dB (relevant only for 4G)
SINR[dB] Signal to Interference plus Noise in dB (relevant only for 4G)
Measurements
Variable Name: Units Functionality/Comments
UserTime ReportVa Seconds Total user time Report Var
Modeler Objects Cellex Confidential
103
Error descriptions
No network attached
Get Engineering Cell Data timeout
Exit States
Done
Get engineering cell data timeout
Modeler Objects Cellex Confidential
104
13.3 Radio On/Off
Functionality
Turn Off/On smartphone
Input Parameters
Parameter Name: Functionality/Comments
Device Select device, must be a smartphone.
TurnOnOff On/Off
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Device Turned
Modeler Objects Cellex Confidential
105
13.4 Reception
Functionality
Measure modem's signal strength
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Measurements
Variable Name: Units Functionality/Comments
Reception dBm The signal strength measurement
Exit States
Reception measured
Internal error
Modeler Objects Cellex Confidential
106
13.5 Radio Attach/Detach
Functionality
Device Attach/Detach
Input Parameters
Parameter Name: Functionality/Comments
Device SourceDevice
AttachOrDetach Attach or Detach
Delay Sleep After device state changed
Measurements
Variable Name: Units Functionality/Comments
ServiceStatus Present status of a netework service
Exit States
Detach Network failed
Done
Modeler Objects Cellex Confidential
107
14 SCRIPTS
Objects for flow control or other script related actions.
Delay
Exit Error
Exit Success
Log Entry
Splitter
Get Time
Force Transfer To Server
UnassignVUserSIMs
Keep Script Alive
Runs Counter
Do Nothing
Reserve Device
Discard Run
If
If5
Loop
Next
For
Export Device Value
Modeler Objects Cellex Confidential
108
14.1 Delay
Functionality
Delay script execution in seconds
Input Parameters
Parameter Name: Functionality/Comments
Delay The amount of time in seconds.
Add To UserTime An option to add the delay time to the user time measurement
Write to Log Indicates whether we should write to log
Measurements
Variable Name: Units Functionality/Comments
UserTime seconds The total time of the transaction
Exit States
Delay ended
Modeler Objects Cellex Confidential
109
14.2 ExitError
Functionality
Exit script in case of an error.
Success value will be set to 0.
Input Parameters
Parameter Name: Functionality/Comments
Var status Define the exit status e.g. Service Error
Measurements
Variable Name: Units Functionality/Comments
Success ReportVar Success report variable
Exit States
Modeler Objects Cellex Confidential
110
14.3 ExitSuccess
Functionality
Exit script in case of success.
Success KPI will be set to 1.
Input Parameters
Parameter Name: Functionality/Comments
No Parameteres
Measurements
Variable Name: Units Functionality/Comments
UserTime ReportVar Seconds Total user time Report Var
Success ReportVar Success report variable
Exit States
Done
Modeler Objects Cellex Confidential
111
14.4 Log Entry
Functionality
Print a log entry to the script's drilldown.
Input Parameters
Parameter Name: Functionality/Comments
Text expression The expression you want to enter into the log
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done.
Modeler Objects Cellex Confidential
112
14.5 Splitter
Functionality
This object should be used in case it is required to perform two operations in parallel.
Input Parameters
Parameter Name: Functionality/Comments
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Output1
Output2
Modeler Objects Cellex Confidential
113
14.6 Get Time
Functionality
Return current time
Input Parameters
Parameter Name: Functionality/Comments
Time Stamp output var Time Stamp for measurements
String Date output var Date
String Time Stamp output var Time stamp in format hh:mm:ss
Minutes var Minutes part of current time
AdjustBySeconds Time adjustment (seconds)
Measurements
Variable Name: Units Functionality/Comments
Time Stamp output
Date output
Minutes
Exit States
Done
Modeler Objects Cellex Confidential
114
14.7 Force Transfer To Server
Functionality
Changes the default Force Transfer behavior for this specific script run. Force Transfer configuration
defines when drilldown or content files will be uploaded to Server.
Input Parameters
Parameter Name: Functionality/Comments
Transfer Mode Transfer Mode (Transfer all | Hold content files |Hold files | don’t
force)
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
115
14.8 UnassignVUserSIMs
Functionality
Unassign all SIMs currently assigned to VUser.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
SIMs Unassigned.
Modeler Objects Cellex Confidential
116
14.9 Keep Script alive
Functionality
If there is no activity in script for 15 minutes, script will be aborted. This is require in order to
prevent scripts to run forever. This object is used to prevents this timeout. It should be used only
ifknown that script should berunningfor a long time.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Keep-Alive interval (minutes) The interval used for keeping the Script alive.
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
117
14.10 Runs Counter
Functionality
Counts script runs.
Input Parameters
Parameter Name: Functionality/Comments
Num of runs Number of runs to make
ResetRunsCounter 1 = Reset runs counter, 0 = Normal operation.
ScenarioName Scenario Name
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Runs Counter Increased.
Modeler Objects Cellex Confidential
118
14.11 Do Nothing
Functionality
Do Nothing. This object is in use when Splitter object is used.
Input Parameters
Parameter Name: Functionality/Comments
No Parameters
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
119
14.12 Reserve Device
Functionality
During script run, reserves a device which is not being used by the script.
Input Parameters
Parameter Name: Functionality/Comments
Device Device
No Parameters
Measurements
Variable Name: Units Functionality/Comments
No Variables
Exit States
Done
Modeler Objects Cellex Confidential
120
14.13 Discard Run
Functionality
Exit and discard run
Input Parameters
Parameter Name: Functionality/Comments
Device device
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
121
14.14 If
Functionality
If condition
Input Parameters
Parameter Name: Functionality/Comments
Condition Condition string
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Condition is True.
Condition is False.
Modeler Objects Cellex Confidential
122
14.15 IF5
Functionality
If statement with 5 conditions. Similar to Case/Switch statements.
Input Parameters
Parameter Name: Functionality/Comments
COS
Condition1
Condition2
Condition3
Condition4
Condition5
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Condition 1 is true.
Condition 2 is true.
Condition 3 is true.
Condition 4 is true.
Condition 5 is true.
Else
Modeler Objects Cellex Confidential
123
14.16 Loop
Functionality
Object for using Loops in a script.
Input Parameters
Parameter Name Functionality/Comments
Loop Condition When True, the loop will continue. When False, the loop will exit.
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Inside the loop.
After the loop
Modeler Objects Cellex Confidential
124
14.17 Next
Functionality
Next, used together with Loop object.
Input Parameters
Parameter Name: Functionality/Comments
No Parameters
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
125
14.18 FOR
Functionality
Using in For loop.
Input Parameters
Parameter Name: Functionality/Comments
No Parameters
Measurements
Vairable Name Units Functionality/Comments
No Measurements
Exit States
Inside the loop
After the loop
Modeler Objects Cellex Confidential
126
14.19 Export Device Value
Functionality
Export Device Value
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
Value Device Reg Value
Store In Var Store In Value
Measurements
Vairable Name Units Functionality/Comments
No Measurements
Exit States
Inside the loop
After the loop
Modeler Objects Cellex Confidential
127
14.20 Transfer Files To Slave
Functionality
Sends file to server
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
File Name File to send
Destination name Destination file name
File transfer timeout File Transfer Timeout, in Seconds
Measurements
Vairable Name Units Functionality/Comments
No Measurements
Error Discription
Send Files to Slave Failed
Files Send
Modeler Objects Cellex Confidential
128
14.21 Transfer Files To Master
Functionality
Transfer Files to Master
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
File Name File to send
Destination name Destination file name
File transfer timeout File Transfer Timeout, in Seconds
Device Defines the input device name
Measurements
Vairable Name Units Functionality/Comments
No Measurements
Error Discription
Send Files to Master
Files Send
Modeler Objects Cellex Confidential
129
15 SMS
SMS Send
SMS Send Raw
SMS Receive
Modeler Objects Cellex Confidential
130
15.1 Send SMS
Functionality
Send SMS with an option to define the text message
Input Parameters
Parameter Name: Functionality/Comments
From Device Defines the input device name
TO Destination Number
SMS Text Defines the text to send. Auto Increasing sends test message with
increasing number in it.
Operation Start-Time Va The Var that will hold the time of the operation's beginning
Operation End-time The Variant that will hold the time of the operation's completion
Use PDU Mode Use PDU (Binary) mode for sending
Request delivery
confirmation
Supported only in PDU Mode. Asks for a Status Report about the
delivery of the SMS to the destination.
Minimum Char Width Smallest Char width allowed (in Bits). Relevant only for PDU mode
Store text in Var The Var that holds the sent text
Force Sender TON Force Sender TON
Force Sender NPI Force Sender NPI
Force Dest TON Force Destination TON
Force Dest NPI Force Destination NPI
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
SendDelay Seconds The time that took to send the SMS.
UserTime Seconds The total time of the transaction
SMS Send Time DateTime SMS Send Time report variable
Error Descriptions
SMS Encode failed.
Exit States
SMS sent
Failed to send sms
Modeler Objects Cellex Confidential
131
15.2 SMS Receive
Functionality
Receive SMS from internal modem or external source
Input Parameters
Parameter Name: Functionality/Comments
Receiving Device Defines the input device name
Source Number Define the SMS source number
Expected SmsText Define the Expected SMS text.
SMS Received Data Variable that stores the SMS content
Send SMS End-time Variable that holds the operation end time value.
Use PDU Mode Use PDU (Binary) Data if possible
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
Receive SMS Delay Seconds Amount of time before SMS received.
Success Measurement that indicates success
1 - Success
0 - Failure
User Time Seconds The total time of the transaction
Receive SMS Time Seconds Receive SMS Time report variable
Error Descriptions
SMS parse failed.
Exit States
SMS received.
SMS receive failed.
Wrong SMS Content.
Modeler Objects Cellex Confidential
132
15.3 SMS Send RAW
Functionality
Send SMS to a Device or a number
Input Parameters
Parameter Name: Functionality/Comments
Receiving Device Device
Source_Number Received SMS Numbe
Operation Start-Time Var The Var that will hold the time of the operation's beginning
Operation End-Time Var The Var that will hold the time of the operation's completion
TPDU_SMS_Text TPDU text to send
Store text in Va The Var that holds the sent text
Source xDR field Source xDR Field
Measurements
Variable Name: Units Functionality/Comments
Send Delay ReportVar Seconds SMS Send delay Report Var
User Time ReportVar Seconds UserTime Report
SMS Send Time ReportVar DateTime SMS Send time Report Var
Error Descriptions
Failed to send SMS
Exit States
SMS Sent
Failed to send sms
Modeler Objects Cellex Confidential
133
16 STK – SIM Tool Kit
Objects are used for STK applications, navigating in menu, selecting items and entering text.
STK Main Menu
STK Sub Menu
STK Input Request
STK Input Data
STK Confirm
STK Back
STK Wait for Notification
Modeler Objects Cellex Confidential
134
16.1 STK Confirm
Functionality
Confirm
Input Parameters
Parameter Name: Functionality/Comments
Device Device
OperationEndTime The Var that holds the time from the end of the menu selection
Measurements
Variable Name Units Functionality/Comments
No Measurements
Error Descriptions
Failed to execute AT command
Exit States
Done
Modeler Objects Cellex Confidential
135
16.2 STK Input Request
Functionality
Fetch Input Request
Input Parameters
Parameter Name: Functionality/Comments
Device Device
OperationEndTime The Var that holds the time from the end of the menu selection
Measurements
Variable Name Units Functionality/Comments
Response Delay ReportVar Seconds Response Delay
UserTime ReportVar Seconds total user time Report Var
Error Descriptions
Failed to execute AT command
Exit States
Done
Modeler Objects Cellex Confidential
136
16.3 STK Main Menu
Functionality
Fetch Main Menu and select item
Input Parameters
Parameter Name: Functionality/Comments
Device Device
OperationEndTime The Var that holds the time from the end of the menu selection
SelectMainMenuItem Main menu item for select
MenuDataOutput MenuDataOutput
Measurements
Variable Name Units Functionality/Comments
Response Delay ReportVar Seconds Response Delay
UserTime ReportVar Seconds total user time Report Var
Exit States
Done
Modeler Objects Cellex Confidential
137
16.4 STK Input Data
Functionality
InputText
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Recieved Question The Var that holds the time from the end of the menu selection
InputData Text for input
OperationEndTime The Var that holds the time from the end of the menu selection
Measurements
Exit States
Done
Variable Name Units Functionality/Comments
UserTime ReportVar Seconds total user time Report Var
Response Delay ReportVar Seconds Response Delay
Modeler Objects Cellex Confidential
138
16.5 STK Sub Menu
Functionality
Wait For Menu and select item
Input Parameters
Parameter Name: Functionality/Comments
Device Device
MenuDataOutput MenuDataOutput
SelectMenuItem The menu item for select
OperationEndTime The Var that holds the time from the end of the menu selection
Measurements
Variable Name Units Functionality/Comments
Response Delay ReportVar Seconds Response Delay
UserTime ReportVar Seconds total user time Report Var
Error Descriptions
The menu item not found.
Exit States
Done
Modeler Objects Cellex Confidential
139
16.6 STK Back
Functionality
Select Back Option
Input Parameters
Parameter Name: Functionality/Comments
Device Device
OperationEndTime The Var that holds the time from the end of the menu selection
Measurements
Variable Name Units Functionality/Comments
No Measurements
Error Descriptions:
The menu item not found.
Exit States
Done
Modeler Objects Cellex Confidential
140
16.7 STK Wait For Notification
Functionality
Wait For Notification
Input Parameters
Parameter Name: Functionality/Comments
Device Device
OperationEndTime The Var that holds the time from the end of the menu selection
Store TPDU SMS text in Var The Var that holds TPDU text for sent
Measurements
Variable Name Units Functionality/Comments
Response Delay ReportVar Seconds Response Delay
UserTime ReportVar Seconds total user time Report Var
Error Descriptions
The menu item not found.
Exit States
Done
Modeler Objects Cellex Confidential
141
17 TELNET
Telnet Connect
Telnet Send
Telnet Get Text Block
Telnet Disconnect
Modeler Objects Cellex Confidential
142
17.1 Telnet Connect
Functionality
Connect to telnet server.
Input Parameters
Parameter Name: Functionality/Comments
IP Server IP
Port Server Port
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Failed to connect.
Exit States
Telnet connected.
Modeler Objects Cellex Confidential
143
17.2 Telnet Disconnect
Functionality
Disconnect from telnet server
Input Parameters
Parameter Name: Functionality/Comments
No Parameters
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Telnet Disconnect failed.
Exit States
Telnet Disconnected.
Modeler Objects Cellex Confidential
144
17.3 Telnet Send
Functionality
Send a telnet command and wait for response
Input Parameters
Parameter Name: Functionality/Comments
Send Text Text to send
WaitForResponse Response to wait for
Timeout
Device Define the Device type
Response Accumulation
Timeout MS
Response accumulation timeout
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Response arrived
Response did not arrived
Modeler Objects Cellex Confidential
145
17.4 Telnet Get Text Block
Functionality
Get text block into string.
Input Parameters
Parameter Name: Functionality/Comments
Send Text Text to send
Start Text Response Part
Stop Text End Block string
CompareTo Compare to string
Timeout Timeout
OutputString String that holds the text block
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Failed to send text
Exit States
Response did not arrive.
Correct Response arrived.
Incorrect Response arrived.
Modeler Objects Cellex Confidential
146
18 USSD
USSD Send
USSD Receive
Modeler Objects Cellex Confidential
147
18.1 USSD Receive
Functionality
Receive USSD message.
Input Parameters
Parameter Name: Functionality/Comments
Receiving Device Select receiving device
Delay Start-time The Variable that holds the time from which the calculated delay
starts
Expected Ussd Message
Ussd Message Variable storing Ussd message.
Measurements
Variable Name: Units Functionality/Comments
Receive Delay Seconds The amount of time took to receive the USSD
message
UserTime Seconds Total transaction time
Error Descriptions
Ussd failed.
Ussd Receive timeout
Exit States
Ussd recived
USSD recive failed
Modeler Objects Cellex Confidential
148
18.2 Send USSD
Functionality
Send USSD message.
Input Parameters
Parameter Name: Functionality/Comments
Device Source Device
USSD Text Usssd Text to send
Operation End-time Var The Var that will hold the time of the operation's completion
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Ussd failed.
Ussd Receive timeout
Modeler Objects Cellex Confidential
149
18.3 Retrieve Balance USSD
Functionality
Retrieve Balance using USSD
Input Parameters
Parameter Name: Functionality/Comments
Device The device used
USSD_Text The USSD string to use for receiving the Balance
Need to configure a global parameter to hold the Regex for the Balance Parsing.
The Global Param is set under System > Parameters
Press, Add new key > Key Name = ConfigStrings | Key Value = Balance
Parameter Name = BalanceRegEx | Parameter Type = String | Parameter Value = <Reg ex>
Measurements
Variable Name: Units Functionality/Comments
Receive Delay ReportVar Seconds The amount of time took to receive the USSD
message
UserTime Seconds Total transaction time
Balance ReportVar Seconds The report Var to hold the Parsed balance amount
Error Descriptions
USSD failed.
USSD Receive timeout
Exit States
USSD received
USSD receive failed
Modeler Objects Cellex Confidential
150
19 VARIABLES
Objects for handling variables, strings and Global parameters.
Variables
Get Unique ID
Increase Var
Reset Counters
Set Global Variable Value
Set Measurement Status
Set Variable Value
Declare Variables
Set Report Var Value
Calc Difference
Device Phone Number
Text Operations
String Replace
String Format
String Constructor
Tokenize String
Break String
Parse String
Modeler Objects Cellex Confidential
151
19.1 CalcDifference
Functionality
Calculates the difference between two numbers.
Input Parameters
Parameter Name: Functionality/Comments
First number The first number
Second number The Second number
Measurements
Variable Name: Units Functionality/Comments
Difference The difference between the two numbers
Exit States
Difference calculated.
Modeler Objects Cellex Confidential
152
19.2 IncreaseVar
Functionality
Increase defined parameter by 1 (similar to ++)
Input Parameters
Parameter Name: Functionality/Comments
Var Name The name of the variable
Increase By Increase by
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Variant increased.
Modeler Objects Cellex Confidential
153
19.3 ResetCounters
Functionality
Reset a variable to defined value.
Input Parameters
Parameter Name: Functionality/Comments
VarToReset The name of the variable to reset
ResetToValue The value the variable will be reset to
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Output Point
Modeler Objects Cellex Confidential
154
19.4 Tokenize string
Functionality
Tokenize a stringaccording to the defineddelimiter.
Input Parameters
Parameter Name: Functionality/Comments
Text source The text source to tokenize
Delimiter The delimiter between tokens
Token index The index of the desired token
Into variable The variable that will receive the token
Variable Type Variable Type
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Done.
Modeler Objects Cellex Confidential
155
19.5 Set Global Variable Value
Functionality
Set global variable's value.
Input Parameters
Parameter Name: Functionality/Comments
Var Name Variant Name
Set Value Set value
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Variant set.
Modeler Objects Cellex Confidential
156
19.6 String Constructor
Functionality
String Constructor.
Input Parameters
Parameter Name: Functionality/Comments
String1 String 1
String2 String2
String before Constructed Add Text before Sound
String after Constructed Add Text after Sound
Delimiter Delimiter
Output string Sound String
Measurements
Variable Name:
Units Functionality/Comments
No Measurements
Exit States
Done.
Modeler Objects Cellex Confidential
157
19.7 Set Measurement Status
Functionality
Set Measurement value.
Input Parameters
Parameter Name: Functionality/Comments
ReportVar Device Reg Value
Vars Status Measurement Status for all ReportVars who are currently being
measured"
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States:
Done
Modeler Objects Cellex Confidential
158
19.8 Set variable Value
Functionality
Set variable's value
Input Parameters
Parameter Name: Functionality/Comments
Var Value Variable name
Set Value Variable value
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
159
19.9 Break String
Functionality
Text operations, get part of a text.
Input Parameters
Parameter Name: Functionality/Comments
Text source The text source
SearchFor Substring to search for
Left into var The variable that will receive the left substring
Right into var The variable that will receive the right substring
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Exit States
Done.
Modeler Objects Cellex Confidential
160
19.10 Declare Variables
Functionality
Set variable's value
Input Parameters
Parameter Name: Functionality/Comments
Default value Click the ... button to enter variable name
Var Name Name of the local variable
Initial value Name of the Persistent Variable
Description Description of the Information var
Measurements
Exit States
Done
Variable Name: Units Functionality/Comments
Var#1 type The type of Variable #1
Var#2type The type of Variable #2
Var#3 type The type of Variable #3
Var#4 type The type of Variable #4
Var#5 type The type of Variable #5
Var#6 type The type of Variable #6
Var#7 type The type of Variable #7
Var#8 type The type of Variable #8
Var#9 type The type of Variable #9
Var#10 type The type of Variable #10
Modeler Objects Cellex Confidential
161
19.11 SetReportVarValue
Functionality
SetReportVarValue
Input Parameters
Parameter Name: Functionality/Comments
Variant Name Variable Name
Set Value Set Value
Measurements
Exit States
Done
Variable Name: Units Functionality/Comments
No Measurements
Modeler Objects Cellex Confidential
162
19.12 String Replace
Functionality
Replace part of a String with a different substring.
Input Parameters
Parameter Name: Functionality/Comments
Text source The text to tokenize
Search For Substring to search for
Replace with Substring which should be inserted into the text source
Measurements
Exit States
Done
Variable Name: Units Functionality/Comments
No Measurements
Modeler Objects Cellex Confidential
163
19.13 String Format
Functionality
Format String
Input Parameters
Parameter Name: Functionality/Comments
Format Output Format
Buffer Size Size of output buffer (in letters)
Input Input argument
Input Type Type of Input argument
Into var The variable that will receive the formatted text
Measurements
Exit States
Done
Variable Name: Units Functionality/Comments
No Measurements
Modeler Objects Cellex Confidential
164
19.14 ParseString
Functionality
Parse String using regular expression.
Input Parameters
Parameter Name: Functionality/Comments
Text Source Text Source
RegularExpression RegularExpression
OutputVar1 OutputVar1
OutputVar1 The type of OutputVar1
OutputVar2 OutputVar2
OutputVar2 The type of OutputVar2
OutputVar3 OutputVar3
OutputVar3 The type of OutputVar3
OutputVar4 OutputVar4
OutputVar4 The type of OutputVar4
OutputVar5 OutputVar5
OutputVar5 The type of OutputVar5
OutputVar6 OutputVar6
OutputVar6 The type of OutputVar6
OutputVar7 OutputVar7
OutputVar7 The type of OutputVar7
OutputVar8 OutputVar8
OutputVar8 The type of OutputVar8
OutputVar9 OutputVar9
OutputVar9 The type of OutputVar9
OutputVar10 OutputVar10
OutputVar10 The type of OutputVar10
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
165
19.15 ParseDate
Functionality
Parse Date string to Numeric using regular expression.
Input Parameters
Parameter Name: Functionality/Comments
Year Hold the Year Value (Mandatory Field)
Month Holds the Month Value (Mandatory Field)
Day Hold the Day Value (Mandatory Field)
Hour Holds the Hour Value
Minute Holds the minutes Value
Seconds Holds the seconds Value
AM/PM Holds the AM/PM time
Date Numeric Output Var The Variable name that will hold the numeric output of the
date/time
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Modeler Objects Cellex Confidential
166
19.16 GetUniqueID
Object ID
Functionality
In some cases it is required to have a single Unique ID for the whole system. In this case the Unique ID is being
managed by the server. This object gets the next free Unique ID
Input Parameters
Parameter Name: Functionality/Comments
Device device
Unique name The name of the unique ID entity
Unique ID The Variable that will receive the returned unique ID
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Get unique id
Get unique id failed
Modeler Objects Cellex Confidential
167
19.17 Device phone number
Functionality
Manipulations on a device phone number.
Should be used in case required to add prefix or postfix to the device phone number and save it to a
variable.
Input Parameters
Parameter Name: Functionality/Comments
Device Define device
Phone Number Var Phone number
Text before Number Add Text before Phone Number
Text after Number Add Text after Phone Number
Use Provider Indicates if we use provider or prefix setting from registry
Output info var Name of output info var
Phone Var Phone var
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Number received
Modeler Objects Cellex Confidential
168
20 VIDEO
Objects for Video Streaming (RTSP) or Progressive Video (video over HTTP).Covering both mobile as well as
broadband video.
Video Streaming
Video Progressive
Modeler Objects Cellex Confidential
169
20.1 Video Progressive
Functionality
Play Video on HTTP
Input Parameters
Parameter Name: Functionality/Comments
Device Device
Video type The type of video
VideoURL URL
Proxy_Host RSTP Host
Proxy_Port RSTP Port
Preferred_Bandwidth The bandwidth of the stream we want to receive
Initial_Buffering_Duration The minimal buffering duration (in Seconds) before video starts
playing
Identity
Duration_Limit Limit the duration of the played video
Segments_Limit Limit the duration of the played video
Video Route Video Route
Initial_Buffering_Size The minimal buffering size (in Bytes) before video starts playing
Measurements
Variable Name: Units Functionality/Comments
Video Received Indicates whether a Video stream was received or not
DownloadTimeUntilFirstPlay Seconds Download time until first play
Underruns Number of Buffer Underruns
TotalInterruptsDuration Seconds TotalInterruptsDuration
TotalDataSize Bytes Data Size
TotalDataDuration Seconds TotalDataDuration
TotalDataBandwidth K/Bytes Total Bandwidth
TotalVideoDuration Seconds Total Video Duration
TotalDownloadDuration Seconds Total Download Duration.
UserTime Seconds Name of Total user time Measurement
Modeler Objects Cellex Confidential
170
Error Descriptions
Play Failed
Exit States
Play failed
Video was received
Modeler Objects Cellex Confidential
171
20.2 Video Streaming
Object ID
Functionality
Play Streaming Video (RTSP based)
Input Parameters
Parameter Name: Functionality/Comments
Device Device
VideoURL Videos URL
Proxy_Host RTSP Proxy host
Proxy_Port RTSP Proxy Port
Video Route Video Route
MaxClipPlayTime Play time
Identity ID
PollingInterva
NumberOfBytesTillFirstFrame
Measurements
Variable Name: Units Functionality/Comments
UserTime ReportVar Seconds total user time Report Var
Video Codec ReportVar Video Codec
Video MeanBandwidth
ReportVar
K/Bytes MeanBandwidth
Video TotalPackets
ReportVar
Bytes Total Packets
Video TotalLostPackets
ReportVar
TotalLostPackets
Video OutOfOrderPackets
ReportVar
OutOfOrderPackets
Video JitterMS ReportVar Mili
Second
Jitters in milli seconds
Audio Codec ReportVar Audio Codec
Modeler Objects Cellex Confidential
172
Audio MeanBandwidth
ReportVar
K/Bytes Bandwidth
Audio TotalPackets
ReportVar
Total Packets
Audio TotalLostPackets
ReportVar
TotalLostPackets
Audio OutOfOrderPackets OutOfOrderPackets
Audio ClipPlayTime
ReportVar
Second ClipPlayTime
Audio JitterMS ReportVar Mili
Seconds
Jitter in Milli-Seconds
Video Received ReportVar Indicates whether a Video stream was received or not
Audio Received ReportVar Indicates whether an Audio stream was received or not
Error Descriptions
Video play failed
Play Failed
Exit States
Play Failed
Only audio received
Only Video receive
Video Audio receive
Modeler Objects Cellex Confidential
173
21 VOICE
Call Flow
Voice Dial
Voice Answer
Voice Hangup
Voice Wait Hangup
Voice Wait Waiting Call
Voice Wait Silence
Voice Send DTMF
Voice Set Hook
Voice Switch Call
Tone Detection
Voice Start Tone Detect
Voice Detect Tone
Audio Quality and IVR Prompt Detection
Voice Quality
Voice Conference
Compare Voice Files
Audio Prompt Detect
Voice Abort Play
Call Divert
Voice Set Call Waiting
Voice Set Call Barring
Voice Set Call Forward
Modeler Objects Cellex Confidential
174
21.1 Voice Send DTMF
Functionality
Send DTMF.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
DTMF The DTMF string
Delay The amount of time to wait after sending the DTMF
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Send DTMF failed.
Exit States
Sent DTMF.
Modeler Objects Cellex Confidential
175
21.2 Voice Detect Tone
Functionality
Check if the requested tone was detected
Input Parameters
Parameter Name: Functionality/Comments
Detection ID The ID of the StartToneDetection operation
Tone Pattern name The name of the Tone Pattern to wait for
Tone_Detection_Timeout The time to wait for tone detection, in seconds
Detected Tone Pattern Var The tone pattern that was detected
Measurements
Variable Name: Units Functionality/Comments
Detection Success ReportVar Indicates if specified Tone was detected
Exit States
Detected
Not detected
Modeler Objects Cellex Confidential
176
21.3 Voice Set Hook
Functionality
In analog lines, Set hook On/Off
Input Parameters
Parameter Name: Functionality/Comments
SourceDevice SourceDevice
On/Off Hook On/Off Hook
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Done
Error Description
Set hook failed
Modeler Objects Cellex Confidential
177
21.4 Voice Quality
Functionality
Calculate MOS result based on PESQ algorithm.
Input Parameters
Parameter Name: Functionality/Comments
File name The name of the file to test (including the path)
Management Interface The Network Device for communicating with the MOS Server
save uploaded file as Enter a unique file name if you want the uploaded file to be kept
Reference File name The name of the Reference file (without the path)
Route to MOS Server Do Routing to the MOS Server
Measurements
Variable Name: Units Functionality/Comments
PESQ (P862.1) PESQ Score according to P.862.1
Exit States
Done
Request returned an error
Cant retrieve MOS results.
Error Description
MOS connection failed
IfFile Exists failed.
This VUser does not have the file
Could not read the MosServer registry value
The MosServer registry value was not set
Routing to MOS Server failed
The request returned an Error
MOS Result download timeout
Could not access URL
Modeler Objects Cellex Confidential
178
Modeler Objects Cellex Confidential
179
21.5 Voice Conference
Functionality
Setup a conference call between several parties.
Input Parameters
Parameter Name: Functionality/Comments
Device Choose device
Measurements
Variable Name: Units Functionality/Comments
Offset ReportVar Seconds Offset of the New file, in Seconds
Result ReportVar Comparison result
Error Descriptions
Start Conference Call Failed.
Modeler Objects Cellex Confidential
180
21.6 Compare Voice Files
Functionality
Analyze and compare two audio files.
Input Parameters
Parameter Name: Functionality/Comments
Device Choose device
New sound file Name of the file we want to compare
Pre-recorded sound file Name of the file we want to compare it with
Silence duration at start of
Pre-recorded file
The duration, in Seconds, of the silence at the begining of the Pre-
recorded sound file
Sound Delay Var The var that holds the delay until sound was detected (specified in the
Voice Compare object)
Measurements
Variable Name: Units Functionality/Comments
Offset ReportVar Seconds Offset of the New file, in Seconds
Result ReportVar Comparison result
Error Descriptions
CompareFiles failed for file
The specified Sound Delay var does not exist
Exit States
Match Found
No Match Found
Modeler Objects Cellex Confidential
181
21.7 Voice Set Call Waiting
Functionality
Set call divert to Call Waiting.
Input Parameters
Parameter Name: Functionality/Comments
Device Choose device
Waiting Enable\Disable Waiting Disable or Enable
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Call waiting activated
Call waiting activation failed
Modeler Objects Cellex Confidential
182
21.8 Voice Set Call Barring
Functionality
Set Call Barring
Input Parameters
Parameter Name: Functionality/Comments
Device Choose device
Code Barring Code
Barring Mode Barring Mode
Barring Enable\Disable Barring Disable or Enable
Measurements
Variable Name: Functionality/Comments
No Variables
Exit States
Call Barred
Barring failed.
Modeler Objects Cellex Confidential
183
21.9 Audio Prompt Detect
Functionality
AudioDetection of IVRprompt.
Input Parameters
Parameter Name: Functionality/Comments
Device Choose the device
SmartStartTimeout Smart Start Timeout. A zero value means no Smart Start
VoiceCompareTime CompareTime
Compare to File Sound file to compare to
VoiceStartTime The amount of time to wait until the voice starts
SoundCard The sound card to record from
AudioChannel The Audio channel of the sound card the device is connected to
RMS Threshold Noice RMS Threshold
Before a Follow-up IVR This IVR is immediatly followed up by another IVR in the same
sound sequence
Retract if mismatch If not detected, the next IVR will use the same sound we heard
Stop Recording Afterwards Will stop recording after the comparison if this arg is set to TRUE
Stop after silence Automatically stop recording after silence is detected
Tone pattern1 An explicit definition of a Tone pattern to listen for
Tone pattern2 An explicit definition of a Tone pattern to listen for
Tone pattern3 An explicit definition of a Tone pattern to listen for
Trim Silence Trim silence from the beginning of the recording
Play Start Time Var The var that holds the play start time
Sound Delay Var The var that holds the sound delay
Measurements
Variable Name: Units Functionality/Comments
Detection Success
ReportVar
Indicates if specified sound was detected
Voice Delay ReportVar Seconds Holds the delay until the sound we're looking for has
started
Error Descriptions
Modeler Objects Cellex Confidential
184
IVR Compare command failed
Did not detect the given sound
IVR detected wrong audio
IVR failure counter reached limit
IVR detected timeout
Exit States
Detected
Not Detected
Modeler Objects Cellex Confidential
185
21.10 Voice Abort Play
Functionality
Abort playing Sound.
Input Parameters
Parameter Name: Functionality/Comments
Device Choose the device
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Descriptions
Abort sound play failed
Exit States
Sound Aborted
Modeler Objects Cellex Confidential
186
21.11 Voice Play Audio
Functionality
Play a sound file
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Sound File The sound file to play
Wait until end
SoundCard The sound card to play with.
AudioChannel The Audio channel of the sound card the device is connected to
Play Start Time Var The variable that holds the play start time
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Played sound
Specific Scripts usage
Playing sound files.
Modeler Objects Cellex Confidential
187
21.12 Voice Answer
Functionality
Answer an incoming call.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
AnswerIncomingCallsFrom Specify the incoming call phone number
Dial End-time Var Variable that holds the dial end time
Answer End-time Var Variable that holds the answer end time
Answer Mode Answer mode synchronic or asynchronous
WaitForVoiceIncomingEvent Wait for voice incoming event (Yes/No)
Incoming call timeout Timeout until we receive a call
AnswerAnyCall Answer any call mode (Yes/No)
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
Incoming Call Delay Seconds The amount of time until voice call received
Call Start Time Time
Stamp
Call start time Report
Call Duration Seconds Call Duration Report
UserTime Seconds Total transaction time
Call Established 1 – Established call, 0 – Did not receive a call
CLI Correct CLI Correct Report Variant
CallEndTime DateTime Call End Time Report Var
Error Descriptions
A sync Voice Answer failed.
Sync Voice Answer failed.
Voice call disconnected before it started.
Voice Incoming Timeout.
Exit States
Did not receive a call.
Voice call disconnected in middle.
Answered call.
Modeler Objects Cellex Confidential
188
21.13 Voice Dial
Functionality
Dial to destination
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Destination Number Specify the destination number
Line Number For PRI: Line number on which the call will be issued. Set to -1 to
use any available line.
Dial Mode Dial mode synchronic or asynchronous
Redial Attempts Redial Attempts
Time_Between_Redial_Attem
pts
Time Between Redial Attempts
Source xDR field Source xDR field
Dest xDR field Dest xDR field
Measurements
Variable Name: Units Functionality/Comments
Call Start Time ReportVar DateTime
Connection Delay ReportVar Seconds The amount of time took to establish connection
Call Duration ReportVar Seconds
UserTime ReportVar Seconds Total transaction time
Error Descriptions
Voice call disconnected in the middle.
Destination is busy.
Dialing error or failure.
Exit States
Voice connected
Voice call disconnected in th middle
Destination busy
Dialing error
Timed out waiting for answer
Failed to establish voice call
Modeler Objects Cellex Confidential
189
21.14 VoiceHangup
Functionality
Disconnect an established call.
Input Parameters
Parameter Name: Functionality/Comments
Source Device Defines the input device name
Dest Device
Answer End-time Specify the variable that holds the answer end time.
Mode Reject or UDUB mode
Operation End Time Specify the variant will hold the time of the operation's
completion
Measurements
Variable Name: Units Functionality/Comments
Call Duration Seconds Call duration in seconds.
User Time Seconds The total transaction time
Active Call Duration Seconds Active Call Duration Report Var
Error Descriptions
Disconnect failed
Exit States
Voice call disconnected
Disconnect failed
Modeler Objects Cellex Confidential
190
21.15 Voice Set CallForward
Functionality
Set call divert to Call Forward
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Phone Number Number to dial to
Forward Mode Forward mode
(AllCalls|Busy|NotAnswered|OutOfReach|UnRegister)
Forward Enable\Disable Forward Disable or Enable
Redial Attempts Number of Redial Attempts.
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Forwarded
Call Forward failed
Modeler Objects Cellex Confidential
191
21.16 Voice Wait HangUp
Functionality
Wait for a disconnect event from the remote party.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Dial End-time The Variant that holds the time from the end of the Dial operation
Measurements
Variable Name: Units Functionality/Comments
"Voice Disconnect delay Seconds Voice Disconnect delay ReportVar
Exit States
Voice call disconnected
Voice call disconnects failed (error).
Modeler Objects Cellex Confidential
192
21.17 Voice Wait Waiting Call
Functionality
Incoming CallWaiting.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
IncomingCallWaitingFrom Answer Incoming Calls From
Dial End-time The Variant that holds the time from the end of the Dial operation
Measurements
Variable Name: Units Functionality/Comments
Incoming CallWaiting
Delay
Seconds Incoming call delay Report Variant
UserTime Seconds Total user time Report Variant
Error Description
Voice Incoming Call Waiting Timeout.
Exit States
Received Call Waiting.
Did not receive a callwaiting.
Modeler Objects Cellex Confidential
193
21.18 Voice Wait Silence
Functionality
Wait for silence.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Detection ID The ID of this operation
Wait Timeout The amount of time to wait
Sound Card Sound Card
Audio Channel The Audio channel of the sound card the device is connected to.
RMS Threshold Noise RMS Threshold.
Stop Recording Afterwards Will stop recording after the detection (Yes/No).
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Error Description
Wait for silence failed.
Wait for silence timeout.
Exit States
Silence detected.
Silence not detected.
Modeler Objects Cellex Confidential
194
21.19 Voice Start Tone Detect
Functionality
Start Tone Detect.
Define the tone patterns to be identified.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input device name
Detection ID The ID of this operation
Tone_Detection_Timeout The amount of time to wait until tone detected
Sound Card Sound Card
Audio Channel The Audio channel of the sound card the device is connected to.
RMS Threshold Noise RMS Threshold.
Stop Recording Afterwards Will stop recording after the detection (Yes/No).
Tone_Pattern_1 An explicit definition of a Tone pattern to listen for.
Tone_Pattern_2 An explicit definition of a Tone pattern to listen for.
Tone_Pattern_3 An explicit definition of a Tone pattern to listen for.
Stop After Tone Pattern Whether we should stop recording after tone pattern
Measurements
Variable Name: Units Functionality/Comments
No Measuremetns
Error Description
Tone Detection failed.
Exit States
Starting Tone Detection.
Modeler Objects Cellex Confidential
195
21.20 Voice Switch Call
Functionality
In case of Call Waiting or Conference call, Switch Call.
Input Parameters
Parameter Name: Functionality/Comments
Device Defines the input destination device name
Measurements
Variable Name: Units Functionality/Comments
No Measurements
Exit States
Call switched.
Modeler Objects Cellex Confidential
196
22 XML
Objects for reading and manipulating XML files
XML Load
XML Get Element
XML Find Element
XML Get Attribute
XML Get Sub Element
XML Set Element
XML Save
Modeler Objects Cellex Confidential
197
22.1 XML Find Element
Functionality
Find Element in XML File
Input Parameters
Parameter Name: Functionality/Comments
Element Name The name of the element
Attribute Name The name of an attribute of the element
Attribute Value The value of the attribute
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Descriptions
Element not found
Exit States
Element not found
Element Found
Modeler Objects Cellex Confidential
198
22.2 XML Get Attribute
Functionality
Get XML Attribute Text
Input Parameters
Parameter Name: Functionality/Comments
Reset Position Reset position afterwards
Attribute Name The name of an attribute of the element
In to Variable The name of the variable to store the loaded text in
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Exit States
Done
Modeler Objects Cellex Confidential
199
22.3 XML Get Element
Functionality
Get XML Element Text
Input Parameters
Parameter Name: Functionality/Comments
In to Variable The name of the variable to store the loaded text in
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Exit States
Done
Modeler Objects Cellex Confidential
200
22.4 XML Get Sub Element
Object ID
Functionality
XML - Get Sub Element under and Element.
Input Parameters
Parameter Name: Functionality/Comments
Sub Element Name The name of the element
Sub Element Index The index of the element
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Error Descriptions
SubElement Not Found
Exit States:
SubElement Not Found
SubElement Recevied
Modeler Objects Cellex Confidential
201
22.5 XML Load
Functionality
1. Load XML File
Input Parameters
Parameter Name: Functionality/Comments
File Name Name of XML file
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Exit States
Done
Modeler Objects Cellex Confidential
202
22.6 Save XML
Functionality
Save XML File
Input Parameters
Parameter Name: Functionality/Comments
File Name Name of XML file
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Exit States
Done
Modeler Objects Cellex Confidential
203
22.7 XML Set Element
Functionality
Set Element Value in XML File
Input Parameters
Parameter Name: Functionality/Comments
Element Name Name of the Element
Element Value Value of the Element
Measurements
Variable Name: Units Functionality/Comments
No Measurement
Exit States
Done
Modeler Objects Cellex Confidential
204
Appendix 1
Measurement ‘Status’ values :
Common
Value: Description
0 SUCCESS
1 UNSET The start default value.
2 UNKNOWN_ERROR The some script error, wrong using the object
3 ERROR_IN_SECTION The common error
Voice
Value: Description
100 VOICE_CONN_ERROR Indicates voice connect/disconnect errors
101 BUSY
102 VOICE_INCOMING_TIME
OUT
Indicates Timeout when waiting for incoming voice
103 VOICE_DISCONNECTED Indicates wrong voice disconnection includes voce
disconnected in the middle
Data
Value: Description
200 DATA_CONN_ERROR Indicate voice data connect/ disconnect errors, routing
problems
201 SETUP_FAILURE Setup configuration problems
202 TIMEOUT Indicates Timeout when waiting for incoming voice
203 GET_IMAGES_FAILED
210 REQUEST_TIMEOUT Indicates time when waiting for Ping response
211 HOST_UNREACHABLE The ping destination host was unreachable.
229 COMMON_PING_ERRORS The other Ping problems.
SMS
Value: Description
301 SEND_SMS_FAILED Send SMS failed.
302 RECEIVE_SMS_FAILED Receive SMS failed.