Siebel Performance Tuning Guide > Analyzing Siebel ARM Data > Analyzing Siebel ARM Files Using the Siebel ARM Query Tool >

Configuring the Siebel ARM Query Tool


This topic is part of Analyzing Siebel ARM Files Using the Siebel ARM Query Tool. It describes how you can configure the Siebel ARM Query Tool. An example of configuring the Siebel ARM Query Tool is modifying the amount of memory that the Siebel ARM query uses, to improve statistical accuracy.

Table 17 describes the flags that you can use to configure the Siebel ARM Query Tool. All the listed options are preceded by the option -config.

Table 17. Configuration Flags for the Siebel ARM Query Tool
Flag
Description

file=macro_file_name

Specifies the file that contains a macro. For more information about using macros, see Using Macros with the Siebel ARM Query Tool.

macro=macro_name(string)

Executes the specified macro and passes the specified string as the first argument to the macro.

Before you can use this flag, you must specify the file that contains the macro, by using the file flag:

> sarmquery -config file=macro_file_name

gmt=0

Parses all timestamps (on the command line) and displays all time in Greenwich Mean Time (GMT) to the command window. If you do not specify this flag, then the Siebel ARM Query Tool uses local time.

gmt=[+-]HHMM

Parses and reports all times as an offset from GMT. Offsets are specified in the HHMM notation, where HH is the hours (0023) and MM is the minutes (00 to 59).

For example, to report Pacific Standard Time (PST), use the following flag:

> sarmquery -config gmt=-0800

datalimit=limit

Specifies a maximum number of records to return, where limit is the maximum number. When the maximum number is exceeded, an error message (data limit exceeded) appears, and the Siebel ARM Query Tool terminates.

timelimit=e

 

Specifies the maximum number of seconds that the Siebel ARM Query Tool can execute during the data processing phase. When the maximum number of seconds elapses, the Siebel ARM Query Tool exits.

The Siebel ARM Query Tool processes in two phases:

  • File collection phase. The tool identifies all required files. The value that you specify for the timelimit flag does not affect this phase; the time that the Siebel ARM Query Tool takes for this phase cannot be constrained.
  • Data processing phase. The value that you specify for the timelimit flag affects the length of this phase.

memlimit=memory

Specifies the amount of memory, in megabytes, that the Siebel ARM Query Tool can allocate to an internal buffer that the Siebel ARM Query Tool uses to compute aggregated statistics.

You can increase the amount of memory for the buffer in order to increase statistical accuracy for the results returned by the tool.

By default, the Siebel ARM Query Tool uses approximately 20 MB of memory. You can allocate a value between 5 MB and 500 MB.

With the default memory allocation, a statistical error level of approximately 1% can be expected in the output results. Increasing the amount of memory to 500 MB reduces the statistical error level to 0.2%.

NOTE:  It is impossible to completely eliminate statistical error.

The amount of memory that you allocate for the Siebel ARM Query Tool does not affect the performance of the tool. Any additional memory that you allocate is applied to the buffer that the Siebel ARM Query Tool uses for statistical calculation.

Siebel Performance Tuning Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.