trace/traceanalyser/com.nokia.s60tools.traceanalyser.help/html/tasks/creating_rules.htm
author Matti Laitinen <matti.t.laitinen@nokia.com>
Wed, 23 Jun 2010 13:57:56 +0300
changeset 9 14dc2103a631
permissions -rw-r--r--
TraceAnalyser 1.0.5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     1
<!--Arbortext, Inc., 1988-2004, v.4002-->
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     2
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     3
<html>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     4
<head>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     5
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     6
<title>Creating tracing rules</title>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     7
<link href="../../book.css" type="text/css" rel="stylesheet"></head>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     8
<body><h2>Creating tracing rules</h2> <h5>Before you start</h5><p>Before you
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     9
can create tracing rules, check that you have: </p><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    10
<li>compiled your code, </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    11
<li>and loaded the generated dictionary file to TraceViewer. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    12
</ul><p>See <a href="../gettingstarted/traceanalyser_basic_walkthrough.htm">
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    13
TraceAnalyser basic walk-through</a> for the complete steps. </p><p>To create
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    14
tracing rules, do the following: </p><ol>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    15
<li>Start TraceAnalyser from the <b>Carbide > TraceAnalyser</b> menu item. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    16
</li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    17
<li>Click <b>Create new rule</b>. <p>The <b>Edit Rule</b> dialog is displayed.
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    18
</p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    19
<li>From the <b>Rule Type</b> list box, select which kind of rule you are
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    20
creating: <ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    21
<li><b>Timing rule</b> for detecting if an operation can be executed within
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    22
a specified time limit. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    23
<li><b>Trace parameter rule</b> for detecting if parameters are beyond a desireable
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    24
value range. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    25
</ul></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    26
<li>In the <b>Rule Name</b> field, type in a name for the rule. <p>For example: <i>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    27
Camera Test</i>. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    28
<li>(Optional) In the <b>Description</b> field, type in a free-form description
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    29
of what the rule is about. <p> For example, for a timing rule: <i>Test that
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    30
the Camera application is able to capture a picture within 1000ms time limit.
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    31
</i></p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    32
<li>Configure the rule-specific settings. <p>For instructions, see either <a
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    33
href="#timing">To define timing rules</a> or <a href="#parameter">To define
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    34
parameter rules</a> below. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    35
<li>Connect your PC to the device by using the connection settings defined
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    36
in TraceViewer (USB or XTI). </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    37
<li>In TraceViewer, activate the traces you want to receive.  </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    38
<li>Run your application on the device. <p>During execution, TraceAnalyser
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    39
lists both passed and failed events to the main view, along with other information
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    40
such as the pass rate. See the following example: </p><p><img src="images\dg_mainview.png"
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    41
alt="Sample of the main view, showing rules and activated/deactivated cases."></p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    42
</ol><p>After the rules have been executed, you can do either of the following: 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    43
</p><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    44
<li><a href="viewing_failed_cases.htm">View the log of failed rules</a>, and
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    45
together with TraceViewer determine which codeline caused the rule violation. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    46
</li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    47
<li><a href="viewing_the_history.htm">View the rule history graph</a> to see
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    48
how the performance of the application has changed over time. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    49
</ul><p></p><h3><a name="timing"></a>To define timing rules:</h3><ol>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    50
<li>To select which trace should be monitored as the first part of this rule
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    51
(Trace A), click <b>Select Trace</b>. <p>The <b>Select Trace for Rule</b> dialog
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    52
is opened, showing the trace dictionaries that you loaded in TraceViewer earlier. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    53
</p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    54
<li>Select the traces you want to use and click <b>OK. </b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    55
<li>Repeat the above steps for Trace B. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    56
<li>In the <b>Time Limit</b> fields, enter the range the values in milliseconds
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    57
for Trace A and Trace B. <ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    58
<li>For <b>Time Limit A</b>, the value means that Trace B must arrive after
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    59
this. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    60
<li>For <b>Time Limit B</b>, the value means that Trace B must arrive before
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    61
this. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    62
</ul><p>The following figure shows an example of how a tracing rule could
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    63
look like: </p><p><img src="images\dg_timingRule.png" alt="Sample of the Edit Rule dialog with the sample values filled in."></p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    64
<li>To finish, click <b>OK</b>. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    65
</ol><h3><a name="parameter"></a>To define parameter rules:</h3><ol>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    66
<li>To select which trace should be monitored as the first part of this rule,
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    67
click <b>Select Trace</b>. <p>The <b>Select Trace for Rule</b> dialog is opened,
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    68
showing the trace dictionaries that you loaded in TraceViewer earlier. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    69
<li>Select the traces you want to use and click <b>OK. </b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    70
<li>From the <b>Trace parameter should be</b> list box, select the behavior
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    71
what you want the parameter and values to be: <?Pub Caret><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    72
<li><b>Greater than/Equal to</b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    73
<li><b>Less than/Equal to</b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    74
<li><b>Between</b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    75
<li><b>Equal to</b> </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    76
</ul><p>The following figure shows an example of how a tracing rule could
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    77
look like: </p><p><img src="images\ParameterRuleDialog.png" alt="Sample of the UI showing values for parameter rule type"></p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    78
<li>To finish, click <b>OK</b>. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    79
</ol><h5>Related tasks</h5><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    80
<li><a href="modifying_rules.htm">Modifying rules</a></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    81
<li><a href="viewing_failed_cases.htm">Viewing the log of failed rules</a></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    82
<li><a href="viewing_the_history.htm">Viewing the rule history</a></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    83
</ul>   <div id="footer">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    84
License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div> </body></html>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    85
<?Pub *0000004916>