trace/traceviewer/com.nokia.traceviewer.help/html/tasks/advancedfilter.htm
author Matti Laitinen <matti.t.laitinen@nokia.com>
Wed, 23 Jun 2010 14:49:59 +0300
changeset 11 5b9d4d8641ce
permissions -rw-r--r--
TraceViewer 2.6.0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     2
<html>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     3
<head>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     4
<title>Setting filtering options</title>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     5
<link href="../../book.css" type="text/css" rel="stylesheet"></head>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     6
<body>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     7
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     8
<h2>Setting filtering options</h2>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     9
<p>TraceViewer provides various options for setting up filtering. 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    10
In some cases, it may also be necessary to use an external filter 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    11
application to modify the results. For instructions, 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    12
see <a href="externalfilter.htm">Using an external filter application</a>.</p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    13
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    14
<h3><a name="basic"></a>Basic options</h3>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    15
<p>You can create new filter rules in the basic <b>Rules</b> dialog, as for 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    16
other items. For instructions, see <a href="setup_rules.htm">Setting up rules 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    17
and filters</a>.</p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    18
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    19
<p>To set filtering-specific options: </p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    20
<ol>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    21
<li>After the rules are defined, select one or more of them from the tree.</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    22
<li>Select either <b>Hide</b> or <b>Show</b>, to make the selected rules visible
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    23
on the tree. <p><img src="images\filterDialog.png" alt="Special fields in Filter Rules dialog"></p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    24
<li>Select either the <b>OR</b> or <b>AND</b> operator:
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    25
<ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    26
<li>OR means that if a trace hits just one rule, it is applied. </li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    27
<li>AND means that the trace must hit all the selected rules for it to be
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    28
applied. </li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    29
</ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    30
</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    31
<li>To take the selected rules to use, click <b>Apply</b>.</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    32
</ol>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    33
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    34
<h3><a name="advanced"></a>Creating rule statements</h3>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    35
<p>You can make also more complicated filtering rules by setting advanced options. The point
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    36
is to make an effective and reasonable filter rule set, which will then be
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    37
used when filtering traces.</p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    38
<p>A rule set is written the form of a statement such as this: </p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    39
<p><i>(rule AND rule2) OR (smallRule AND NOT filterRule)</i></p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    40
<p>where traces are included or excluded based on this criterion. </p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    41
<p><b>Tip:</b> You can also type the rule set statement manually into
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    42
the text field. </p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    43
<p>To set advanced options: </p>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    44
<ol>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    45
<li>In the <b>Filter Rules</b> dialog, click <b>Advanced</b>. <p>The <b>Advanced
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    46
Filter Rules</b> dialog is displayed, showing the basic rules already created. 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    47
</p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    48
<li>To start creating a new rule set, click <b>Start Set</b>. <p>An opening
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    49
parenthesis ( is inserted into the text field to indicate the beginning.</p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    50
<li>To edit the rule set, select rules from the tree and combine them with
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    51
each other by clicking any of the following buttons: 
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    52
<ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    53
<li><b>AND:</b> Indicates logical AND. Is used between two rules or rule sets
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    54
and means that both rules / sets will have to hit the rule for it to be true.
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    55
</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    56
<li><b>OR:</b> Indicates logical OR. Is used between two rules or rule sets
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    57
and means that either rule / set will have to hit the rule for it to be true.
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    58
</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    59
<li><b>NOT:</b> Indicates logical NOT. Is used before a rule or rule set.
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    60
Indicates that the rule / rule set after the NOT can not hit the rule for
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    61
it to be true.</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    62
</ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    63
<p>The <b>Back</b> button removes the last word from the text field,
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    64
starting from the caret position. </p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    65
<li>(Optional) To quickly add all the rules from a group to the set, click
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    66
the group name on the tree. <p>From the pop-up, select OR or AND. After choosing,
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    67
all the rules from this group are added to the text field, separated by the
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    68
selected logical operation. </p><p><img src="images/advancedFilterDialogGroup.png"
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    69
alt="Selecting all rules from a group"></p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    70
<li>Click <b>End Set</b> to insert a closing parenthesis ) into the field. <p><b>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    71
Note:</b> TraceViewer automatically checks that the rule is reasonable and
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    72
well-formed, that is, contains as many start brackets as end brackets. The
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    73
following is an example of a reasonable filter rule set that is correct and
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    74
ready to be applied: </p><p><img src="images/advancedFilterDialogReady.png"
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    75
alt="Filter rule ready to be applied"></p></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    76
<li>(Optional) To hide or show a trace that hits this filter rule, change
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    77
the value of <b>Show</b> and <b>Hide</b> selection as needed.</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    78
<li>Click <b>OK</b> to save the rule set. </li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    79
</ol>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    80
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    81
<ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    82
<li>To clear the rule text field and start creating a new one, click <b>Clear
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    83
</b>. </li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    84
<li>To return to the <b>Basic</b> dialog, click <b>Simple</b>.</li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    85
</ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    86
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    87
<h5>Related tasks</h5>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    88
<ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    89
<li><a href="setup_rules.htm">Setting up rules and filters</a></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    90
<li><a href="externalfilter.htm">Using an external filter application</a></li>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    91
</ul>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    92
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    93
<div id="footer">Copyright &copy; 2007-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.</div>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    94
</body>
5b9d4d8641ce TraceViewer 2.6.0
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    95
</html>