testexecfw/useremul/help/temp/UserEmulator.ptml.xml
author Johnson Ma <johnson.ma@nokia.com>
Mon, 08 Mar 2010 15:03:44 +0800
changeset 0 3e07fef1e154
permissions -rw-r--r--
Initial EPL Contribution
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     1
<?xml version="1.0"?>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     2
<?xml:stylesheet href="file:///C:/S60/devices/S60_5th_Edition_SDK_v1.0/epoc32/tools/cshlpcmp/xsl/ptml.xsl" title="PTML" type="text/xsl"?>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     3
<!DOCTYPE ptml SYSTEM "file:///C:/S60/devices/S60_5th_Edition_SDK_v1.0/epoc32/tools/cshlpcmp/dtd/ptml.dtd">
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     4
<ptml>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     5
<p style="comment">Author: Reshma Sandeep Das</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     6
<p style="comment">Date: 2009-29-07</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     7
<p style="comment">Version: 3.7</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     8
<p style="heading 1">Category</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
     9
<p style="category uid">0x2001C3AF</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    10
<p style="heading 2">Topic title</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    11
<p style="synonyms">Synonyms for the topic</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    12
<p style="context">Context1 <cs style="context comment">with a comment</cs></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    13
<p style="index">User Emulator</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    14
<p><manual formattype="font-size"><b>Purpose and Scope</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    15
<p><manual formattype="font-size">This document provides an outline on the User Emulator tool, instructions on how to use the tool and guidelines on reading and analysing the results after running the tool.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    16
<p><manual formattype="font-size"><b>Overview</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    17
<p><manual formattype="font-size"><b>User Emulator:</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    18
<p><manual formattype="font-size">User Emulator is a tool for automated test creation, execution and management. The tool is very useful to automate functional and non-functional testing of applications. Eg, stress testing application usage over 24 hours. Regression testing, etc. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    19
<p><manual formattype="font-size">The user emulator tool programmatically simulates application UI usage as described in an XML script on the S60 device. This tool helps in writing, reusing and executing tests on the code under development.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    20
<p><manual formattype="font-size">Following are the features supported by the User Emulator tool:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    21
<p><manual formattype="font-size">&ndash; Up/down/left/right arrow key events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    22
<p><manual formattype="font-size">&ndash; Selection, LSK, RSK key events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    23
<p><manual formattype="font-size">&ndash; Menu key events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    24
<p><manual formattype="font-size">&ndash; Alpha-Numeric key events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    25
<p><manual formattype="font-size">&ndash; Launch application using UID/Name</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    26
<p><manual formattype="font-size">&ndash; Loops in XML script</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    27
<p><manual formattype="font-size">&ndash; Pointer/Touch events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    28
<p><manual formattype="font-size">&ndash; Take Screen shots</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    29
<p><manual formattype="font-size">&ndash; Capture Panics </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    30
<p><manual formattype="font-size">&ndash; Log to file</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    31
<p><manual formattype="font-size">&ndash; Record and playback of Key/Pointer events</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    32
<p><manual formattype="font-size">&ndash; Random Test </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    33
<p><manual formattype="font-size">&ndash; Random Test to stress all applications under S60 menu system</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    34
<p><manual formattype="font-size">&ndash; Random Test targeted to specific applications</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    35
<p><manual formattype="font-size"><b>Menu Options: </b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    36
<p><manual formattype="font-size">After the application launch, any scripts available in the default settings path are displayed to the user. This view is refreshed if there is any change in the settings path or addition/deletion of scripts.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    37
<p><manual formattype="font-size"><b>1</b><b>. Run Scripts</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    38
<p><manual formattype="font-size">Script execution can start by selecting the Run Scripts menu option. Script selection can be made by clicking on a script name. Single selection or multiple script selection option is available to the user. After the selection, file(s) are parsed using an XML parser and appropriate actions are performed. Visual indications of scripts execution pass/fail/cancellation are displayed using icons on the screen.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    39
<p><manual formattype="font-size">Green Icon: pass</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    40
<p><manual formattype="font-size">Red Icon: Fail</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    41
<p><manual formattype="font-size">Yellow Icon: Cancellation of script execution</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    42
<p><manual formattype="font-size">Script run starts on idle screen after the Menu application and idle screen reset</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    43
<p><manual formattype="font-size"><b>2</b><b>. Select</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    44
<p><manual formattype="font-size">This option can be used for file selection and de-selection respectively. There is an option to select/de-select a single file or multiple files at the same time.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    45
<p><manual formattype="font-size"><b>3</b><b>. Record input</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    46
<p><manual formattype="font-size">This menu option allows users to start recording any key presses or screen taps. User has to enter a name for the recorded script. The file name cannot contain any special characters. An error message is displayed to the user and a dialog is prompted to enter correct filename. The file is stored in 'Scripts Path ' folder. Screenshot tag can be added dynamically in the script by pushing the camera button once during script recording. Recording can be cancelled any time by pressing the power button once.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    47
<p><manual formattype="font-size">Script recording starts on idle screen after the Menu application and idle screen reset</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    48
<p><manual formattype="font-size"><b>4</b><b>. Random test run</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    49
<p><manual formattype="font-size">Starts the random test on the device and sends random key presses and screen taps to the device. Random test can be stopped by pressing the power button once.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    50
<p><manual formattype="font-size"><b>5</b><b>. Settings</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    51
<p><manual formattype="font-size">This menu option launches a settings dialog that has configuration information for the User Emulator tool.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    52
<p><manual formattype="font-size">Scripts Path: User can modify the storage path of the test scripts.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    53
<p><manual formattype="font-size">Log Status: Logging option can be turned ON/OFF using this settings option.      </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    54
<p><manual formattype="font-size">Log File Path: Path for the log file that logs the script execution actions. This file also captures any system wide panics.  </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    55
<p><manual formattype="font-size">Note: User has to exit the tool in order to check the log files. Log files are overwritten every time the tool starts.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    56
<p><manual formattype="font-size">Target for Random Test? Can be ON/OFF. 'ON' enables random tests on ID specified application(s). If it is in 'OFF' state then random test will perform without starting an application at start time.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    57
<p><manual formattype="font-size">App Ids of Random Test: If the previous option is 'ON' then 'Random test run' will start application(s) at the beginning of the test using these IDs.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    58
<p><manual formattype="font-size"><b>6</b><b>. System Info</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    59
<p><manual formattype="font-size">Option that gives the complete system information </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    60
<p><manual formattype="font-size"><b>7</b><b>. Help</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    61
<p><manual formattype="font-size">Help file describing the User Emulator tool usage</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    62
<p><manual formattype="font-size"><b>8</b><b>. About</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    63
<p><manual formattype="font-size">A brief about the tool</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    64
<p><manual formattype="font-size"><b>Middle soft K</b><b>ey Options:</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    65
<p><manual formattype="font-size"><b>Run Scripts</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    66
<p><manual formattype="font-size">User can call Run Scripts to run a script on focus. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    67
<p><manual formattype="font-size"><b>XML Script Format</b></manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    68
<p style="style1"><manual formattype="Bold-Style-Removed">This section describes the data format of the XML script that is generated during script recording operation from an S60 device.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    69
<p style="style1"><manual formattype="Bold-Style-Removed">The XML script has user actions (key inputs/ screen taps) recorded and can be used to simulate the same during script execution.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    70
<p style="style1"><manual formattype="Bold-Style-Removed">Each user action is written as an action element enclosed within the main tag having the following syntax:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    71
<p style="style1"><manual formattype="Bold-Style-Removed">Syntax:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    72
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;UserEmulator&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    73
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    74
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;. &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    75
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;. &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    76
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt;. &lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    77
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt;. &lt;/keys&gt; </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    78
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;screenshot&gt; . &lt;/screenshot&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    79
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;print&gt; . &lt;/print&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    80
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/action&gt; </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    81
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/UserEmulator&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    82
<p style="style1">Description of tags and elements</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    83
<p style="style1">&lt;name&gt;... &lt;/name&gt;: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    84
<p style="style1"><manual formattype="Bold-Style-Removed">This is an optional tag which can be used to define the action. A meaningful name can be given to this tag to identify the action. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    85
<p style="style1">Syntax:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    86
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;name&gt; &lt;Application name&gt; &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    87
<p style="style1">Example: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    88
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt; Calculator &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    89
<p style="style1">&lt;type&gt;... &lt;/type&gt;: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    90
<p style="style1"><manual formattype="Bold-Style-Removed">This is a mandatory tag which should be defined to identify the type of action. User has to choose any one of the below mentioned values to identify the type of action.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    91
<p style="style1">Currently supported types of action: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    92
<p style="style1"><manual formattype="Bold-Style-Removed">   - app      (To launch an application)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    93
<p style="style1"><manual formattype="Bold-Style-Removed">   - view     (To switch the views)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    94
<p style="style1"><manual formattype="Bold-Style-Removed">   - closeapp   (To close any application)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    95
<p style="style1"><manual formattype="Bold-Style-Removed">   - keypress   (To simulate key press)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    96
<p style="style1"><manual formattype="Bold-Style-Removed">   - wait           (To pause for the specified duration in milliseconds)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    97
<p style="style1"><manual formattype="Bold-Style-Removed">   - javaapp     (To launch a java midlet)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    98
<p style="style1"><manual formattype="Bold-Style-Removed">   - pointerevent (To simulate pointer events)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
    99
<p style="style1"><manual formattype="Bold-Style-Removed">   - orientation    (Change device's screen orientation (portrait or landscape mode))</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   100
<p style="style1"><manual formattype="Bold-Style-Removed">   - screenreset  (Resets menu screen and older version of Home Screen's idle screen )</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   101
<p style="style1">Note: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   102
<p style="style1"><manual formattype="Bold-Style-Removed">The above types of action are case sensitive </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   103
<p style="style1">Syntax:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   104
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;type&gt; &lt;action-type&gt; &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   105
<p style="style1">Example: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   106
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt; app &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   107
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt; view &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   108
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt; closeapp &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   109
<p style="style1">&lt;params&gt;... &lt;/params&gt;: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   110
<p style="style1"><manual formattype="Bold-Style-Removed">This tag should be used to pass parameters for carrying out specified action. This tag is mandatory if the &lt;type&gt; tag is set to any one of the following types:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   111
<p style="style1"><manual formattype="Bold-Style-Removed">"app, view, closeapp, wait, javaapp"</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   112
<p style="style1">Syntax:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   113
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; &lt;application specific params&gt; &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   114
<p style="style1">Example:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   115
<p style="style1"><manual formattype="Bold-Style-Removed">In order to launch an application, currently the UID of the application has to be passed as the first parameter and the application name as the second parameter. Comma (',') is used as a delimiter between the parameters. The second parameter (application name) is a label which is required for logging purposes</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   116
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;params&gt; 0x10005902, Calculator &lt;/params&gt; //Launches the calculator application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   117
<p style="style1"><manual formattype="Bold-Style-Removed">For closing an application, the UID of the application along with the application name (comma separated) to be closed should be passed.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   118
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;params&gt; 0x10005902, Calculator &lt;/params&gt; // Closes the calculator application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   119
<p style="style1"><manual formattype="Bold-Style-Removed">In order to switch views, application UID and view ID (comma separated) should be passed to the params tag</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   120
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;params&gt; 0x101f4cd5, 0x05 &lt;/params&gt; // Activates Missed calls view</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   121
<p style="style1"><manual formattype="Bold-Style-Removed">For wait operation, the time interval in milliseconds should be specified as follows:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   122
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;params&gt; 100 &lt;/params&gt; //Pause for 100 milliseconds</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   123
<p style="style1"><manual formattype="Bold-Style-Removed">For launching a java midlet, midlet name should be specified in the params tag. Midlet name is case sensitive.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   124
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;params&gt; Music Store &lt;/params&gt; //Launches Music Store application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   125
<p style="style1">&lt;keys&gt;&#8230; &lt;/keys&gt;: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   126
<p style="style1"><manual formattype="Bold-Style-Removed">This tag should be used to pass any key events to the application. More than one key code can be specified in the &lt;keys&gt; tag. Space (" ") is used as a delimiter between the key codes. Following key codes can be passed as the key events in &lt;keys&gt; tag.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   127
<p style="style1"> Key Codes Reference:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   128
<p style="style1"><manual formattype="Bold-Style-Removed">  LSK     = left soft key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   129
<p style="style1"><manual formattype="Bold-Style-Removed">  RSK    = right soft key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   130
<p style="style1"><manual formattype="Bold-Style-Removed">  DAK    = down arrow key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   131
<p style="style1"><manual formattype="Bold-Style-Removed">  RAK    = right arrow key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   132
<p style="style1"><manual formattype="Bold-Style-Removed">  LAK     = left arrow key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   133
<p style="style1"><manual formattype="Bold-Style-Removed">  UAK    = up arrow key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   134
<p style="style1"><manual formattype="Bold-Style-Removed">  MSK    = Middle soft key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   135
<p style="style1"><manual formattype="Bold-Style-Removed">  SP       = Space</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   136
<p style="style1"><manual formattype="Bold-Style-Removed">  BS       = Backspace/clear</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   137
<p style="style1"><manual formattype="Bold-Style-Removed">  lt          = Less Than</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   138
<p style="style1"><manual formattype="Bold-Style-Removed">  gt         = Greater Than</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   139
<p style="style1"><manual formattype="Bold-Style-Removed">  amp     = Ampersand</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   140
<p style="style1"><manual formattype="Bold-Style-Removed">  MENU  = Menu</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   141
<p style="style1"><manual formattype="Bold-Style-Removed">  KYES  = Green Key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   142
<p style="style1"><manual formattype="Bold-Style-Removed">  KNO    = Red Key</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   143
<p style="style1"><manual formattype="Bold-Style-Removed">  1 = Number 1</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   144
<p style="style1"><manual formattype="Bold-Style-Removed">  2 = Number 2</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   145
<p style="style1"><manual formattype="Bold-Style-Removed">  3 = Number 3  </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   146
<p style="style1"><manual formattype="Bold-Style-Removed">  4 = Number 4</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   147
<p style="style1"><manual formattype="Bold-Style-Removed">  5 = Number 5</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   148
<p style="style1"><manual formattype="Bold-Style-Removed">  6 = Number 6</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   149
<p style="style1"><manual formattype="Bold-Style-Removed">  7 = Number 7  </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   150
<p style="style1"><manual formattype="Bold-Style-Removed">  8 = Number 8</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   151
<p style="style1"><manual formattype="Bold-Style-Removed">  9 = Number 9</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   152
<p style="style1"><manual formattype="Bold-Style-Removed"> </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   153
<p style="style1"><manual formattype="Bold-Style-Removed">Alphabets: </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   154
<p style="style1"><manual formattype="Bold-Style-Removed">a-z and A-Z  </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   155
<p style="style1"><manual formattype="Bold-Style-Removed">Special characters:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   156
<p style="style1"><manual formattype="Bold-Style-Removed">. ? @  , ' ! " - ( ) / : _ ; + % = [ ] { } \ ~ ^ | ` $</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   157
<p style="style1">Syntax:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   158
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt; &lt;key value &gt; &lt;/type&gt; </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   159
<p style="style1">Example: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   160
<p style="style1"><manual formattype="Bold-Style-Removed">   &lt;keys&gt; DAK &lt;keys&gt; // Press down arrow key </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   161
<p style="style1">Loop:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   162
<p style="style1"><manual formattype="Bold-Style-Removed">This tag should be used to specify any repetitive actions and should be defined using the tag  </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   163
<p style="style1"><manual formattype="Bold-Style-Removed">   &lt;loop count='2'&gt; // begin loop </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   164
<p style="style1"><manual formattype="Bold-Style-Removed">   .</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   165
<p style="style1"><manual formattype="Bold-Style-Removed">   .</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   166
<p style="style1"><manual formattype="Bold-Style-Removed">   &lt;/loop&gt; // end loop</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   167
<p style="style1"><manual formattype="Bold-Style-Removed">In the above tag, 'count' indicates the number of times the set of actions has to be executed in a loop. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   168
<p style="style1">Syntax:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   169
<p style="style1"><manual formattype="Bold-Style-Removed">    &lt;loop count=&lt;enter the count value for looping action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   170
<p style="style1"><manual formattype="Bold-Style-Removed">     .</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   171
<p style="style1"><manual formattype="Bold-Style-Removed">     .</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   172
<p style="style1"><manual formattype="Bold-Style-Removed">     &lt;/loop&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   173
<p style="style1">Example:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   174
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;loop count='5'&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   175
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   176
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;names&gt; enter 1 &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   177
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;    keypress   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   178
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt;   1 &lt;/keys&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   179
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   180
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/loop&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   181
<p style="style1"><manual formattype="Bold-Style-Removed">In the above example, key press 1 is sent to the application. This operation is carried out five times in a loop. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   182
<p style="style1">Note: </p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   183
<p style="style1"><manual formattype="Bold-Style-Removed">By specifying the count value as 'infinite', one can execute the operations in a loop infinitely.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   184
<p style="style1"><manual formattype="Bold-Style-Removed">Stopping Script Executions</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   185
<p style="style1"><manual formattype="Bold-Style-Removed">Script execution can be interrupted by pressing the Power button on the device.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   186
<p style="style1"><manual formattype="Bold-Style-Removed">   </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   187
<p style="style1"><manual formattype="Bold-Style-Removed">Example for launching a calculator application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   188
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   189
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   Calculator &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   190
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   app   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   191
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; 0x10005902, Calculator&lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   192
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   193
<p style="style1"><manual formattype="Bold-Style-Removed">Example for switching views </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   194
<p style="style1"><manual formattype="Bold-Style-Removed">Activates the Missed calls view</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   195
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   196
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   Missed Calls &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   197
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   view   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   198
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; 0x101f4cd5, 0x05 &lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   199
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt;   MSK MSK &lt;/keys&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   200
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   201
<p style="style1"><manual formattype="Bold-Style-Removed">Example for closing a calculator application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   202
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   203
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   Calculator &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   204
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   closeapp   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   205
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; 0x10005902, calculator&lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   206
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   207
<p style="style1"><manual formattype="Bold-Style-Removed">Example for keypress action </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   208
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   209
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   keypress   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   210
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt;   1 2 &lt;/keys&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   211
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   212
<p style="style1"><manual formattype="Bold-Style-Removed">Example for wait/pause</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   213
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   214
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   pause &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   215
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   wait   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   216
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; 4000 &lt;/params&gt; //Time interval in milliseconds</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   217
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   218
<p style="style1"><manual formattype="Bold-Style-Removed">Example for Loop action</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   219
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;loop count='5'&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   220
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   221
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   enter 1 and 2 &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   222
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   keypress   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   223
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;keys&gt;   1 2 &lt;/keys&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   224
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   225
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/loop&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   226
<p style="style1"><manual formattype="Bold-Style-Removed">Example for launching a java application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   227
<p style="style1"><manual formattype="Bold-Style-Removed">Launches the Music Store application</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   228
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   229
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   Music Store &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   230
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   javaapp  &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   231
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; Music Store &lt;/params&gt; //Midlet name </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   232
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   233
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;print&gt;&#8230;&lt;/print&gt;:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   234
<p style="style1"><manual formattype="Bold-Style-Removed">This is an optional tag that can be added in the scripts to print any debug logs. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   235
<p style="style1"><manual formattype="Bold-Style-Removed">Example:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   236
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   237
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;   Calculator &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   238
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   app   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   239
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; 0x10005902, calculator&lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   240
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;print&gt;Open calculator&lt;/print&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   241
<p style="style1"><manual formattype="Bold-Style-Removed"> &lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   242
<p style="style1">&lt;screenshot&gt; &#8230; &lt;/screenshot&gt;</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   243
<p style="style1"><manual formattype="Bold-Style-Removed">User Emulator can take a screenshot of the action that has the &lt;screenshot&gt; tag. The image file is stored with the name specified in the &lt;screenshot tag&gt; under the &lt;\Logs\script file name&gt; directory specified in the settings dialog. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   244
<p style="style1"><manual formattype="Bold-Style-Removed">During script recording, this tag can be automatically added at any stage of recording, by just clicking on the camera button once. The name of the screenshot is added automatically and has the following format:</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   245
<p style="style1"><manual formattype="Bold-Style-Removed">"app name in foreground"-"time stamp"</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   246
<p style="style1">Example:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   247
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;screenshot&gt; Menu-4563678 &lt;/screenshot&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   248
<p style="style1">Pointer Events</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   249
<p style="style1"><manual formattype="Bold-Style-Removed">User Emulator can simulate pointer events on the touch enabled devices. Following are the pointer events currently supported. The pointer events are added within the &lt;params&gt; tag.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   250
<p style="style1"><manual formattype="Bold-Style-Removed">pointerdownAt ,x, y: Simulates pointer down event. &break;x and y values are the co-ordinates of the pointer. (Start of a flick or tap, etc.)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   251
<p style="style1"><manual formattype="Bold-Style-Removed">pointerupAt, x,y: Simulates pointer up event. &break;x and y values are the co-ordinates of the pointer. (End of a flick or tap, etc.)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   252
<p style="style1"><manual formattype="Bold-Style-Removed">moveto x, y: Simulates pointer move event. &break;x and y values are the co-ordinates of the end of movement.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   253
<p style="style1"><manual formattype="Bold-Style-Removed">pointerdownAt, x, y, z:  Simulates finger down event. &break;x and y values are the co-ordinates of the finger. Z is a threshold value. (Added to every co-ordinates)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   254
<p style="style1"><manual formattype="Bold-Style-Removed">pointerupAt, x,y,z: Simulates finger up event. &break;x and y values are the co-ordinates of the finger. Z is a threshold value. (Added to every co-ordinates)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   255
<p style="style1"><manual formattype="Bold-Style-Removed">moveto x, y,z: Simulates finger move event. &break;x and y values are the co-ordinates of the end of movement. Z is a threshold value. (Added to every co-ordinates)</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   256
<p style="style1">Example:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   257
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   258
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;  xxx &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   259
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   pointerevent   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   260
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; pointerdownAt,560,320,5 &lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   261
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   262
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   263
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;  xxx &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   264
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   pointerevent   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   265
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; moveTo, 520,310,5 &lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   266
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   267
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   268
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;name&gt;  xxx &lt;/name&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   269
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;type&gt;   pointerevent   &lt;/type&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   270
<p style="style1"><manual formattype="Bold-Style-Removed">  &lt;params&gt; pointerupAt, 520,300,5 &lt;/params&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   271
<p style="style1"><manual formattype="Bold-Style-Removed">&lt;/action&gt;</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   272
<p style="style1">Note:</p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   273
<p style="style1"><manual formattype="Bold-Style-Removed">Since on software level there is no difference between stylus, finger tap, thumb tap, etc. all types of pointer events have general pointer event names with a threshold value.</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   274
<p style="style1"><manual formattype="Bold-Style-Removed">In order to get the same results during script execution, all the screens on the device should be reset to its initial state before script recording and playback. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   275
<p style="style1"><manual formattype="Bold-Style-Removed">Currently the tool supports basic reset functionality of resetting the Menu application's scroll bar, closing any open applications on the device and resetting the idle screen. </manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   276
<p style="style1"><manual formattype="Bold-Style-Removed">If there are any changes to the application position in the Menu application or any changes on the Home Screen, the script when played back may not produce the same results. This is a known limitation of the tool</manual></p>
3e07fef1e154 Initial EPL Contribution
Johnson Ma <johnson.ma@nokia.com>
parents:
diff changeset
   277
</ptml>