| Siebel CRM Performance Tuning Guide Siebel 2018 E24801-01 |
|
 Previous |
 Next |
View PDF |
| Siebel CRM Performance Tuning Guide Siebel 2018 E24801-01 |
|
Previous |
Next |
View PDF |
This topic describes how to analyze Siebel ARM files using the Siebel ARM Query Tool. This tool converts binary Siebel ARM files into readable output for analysis.
The following topics provide more information about using the Siebel ARM Query Tool:
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool".
The Siebel ARM Query Tool is a performance analysis command line tool that processes the binary Siebel ARM data produced by the Siebel Server. This tool provides many command-line options that allow you to create complex queries.
The Siebel ARM Query Tool is recommended for use over the Siebel ARM Analyzer Tool, which is described in "Analyzing Siebel ARM Files Using the Siebel ARM Analyzer Tool". The Siebel ARM Query Tool processes data faster than the Siebel ARM Analyzer Tool, allows you to create more complex queries, and offers many other benefits summarized in this topic.
Some of the features of the Siebel ARM Query Tool are described as follows:
Source data specification. You can specify individual Siebel ARM files or directories as input for the Siebel ARM Query Tool. For more information about the parameters that allow you to specify input data, see "Configuring Input for the Siebel ARM Query Tool".
Multiple output formats. You can specify that multiple types of output be produced simultaneously. Supported output formats include TXT, XML and CSV. For more information about how to specify the output format, see "Configuring Output from the Siebel ARM Query Tool".
Data filtering capability. You can specify selection filters that include or exclude data from analysis by the Siebel ARM Query Tool. Selection filters provide many ways to specify the types of records that you are interested in. Filters are generally not mutually exclusive. That is, you do not need to choose just one filter; you can use multiple filters, in any combinations that you require. For more information about using selection filters, see "Using Selection Filters with the Siebel ARM Query Tool".
Aggregating data. You can specify the order of aggregation for your output. This includes rollup calculations. Aggregation is the grouping of Siebel ARM records that share common attributes and the computing of statistics on the group. For more information about aggregation, see "Aggregating Siebel ARM Data with the Siebel ARM Query Tool".
Histograms. Histograms are a special type of aggregation. You can use a histogram to aggregate the results that the Siebel ARM Query Tool retrieves when you submit a query on Siebel ARM data that can return too many values if you do not use the histogram. For more information about using histograms, see "Generating Histograms with the Siebel ARM Query Tool".
Macro language. The Siebel ARM Query Tool supports the use of macros. For more information about using macros, see "Using Macros with the Siebel ARM Query Tool".
Configurable memory for statistical accuracy. By default, approximately 20 MB of memory is used by the Siebel ARM Query Tool's internal buffer used for statistical calculation. You can increase this amount of memory in order to increase the statistical accuracy of results. For example, increasing the amount of memory for the tool to 500 MB can reduce the statistical error level from 1% to 0.2%. For more information about configuring memory allocation for the Siebel ARM Query Tool, see "Configuring the Siebel ARM Query Tool".
For more command-line options for the Siebel ARM Query Tool, see "General Commands for the Siebel ARM Query Tool" and "Configuring the Siebel ARM Query Tool".
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool". It describes the general options for use with the Siebel ARM Query Tool.
Siebel ARM Query Tool options include commands to display online help and to display progress information to the command window. Table 15-1 describes these commands.
Table 15-1 General Flags for the Siebel ARM Query Tool
| Flag | Description |
|---|---|
-help |
Prints help. |
-copyright |
Prints copyright information about the Siebel ARM Query Tool. |
-tips |
Prints the command-line syntax to accomplish common aggregations, reports, and conversions. |
-macrosyntax |
The Siebel ARM Query Tool supports a macro language. This flag prints the syntax of the macro language. For more information about using macros, see "Using Macros with the Siebel ARM Query Tool". |
-planonly |
Prints an execution plan for a query, without executing the query. |
-quiet |
Prints results only to the output console. No progress information appears when you specify this flag. You can also specify to save progress information to a file, as noted in "Configuring the Siebel ARM Query Tool". The following example saves progress information to the file verbose.txt: > sarmquery –output verbose=verbose.txt –input data.sarm -aggregate time=1 |
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 15-2 describes the flags that you can use to configure the Siebel ARM Query Tool. All of the listed options must be preceded by the option -config.
Table 15-2 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
-config file=macro_file_name
|
gmt=0 |
Parse all time stamps (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 –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=seconds
|
Specifies the maximum number of seconds that the Siebel ARM Query Tool can execute. When the maximum number of seconds elapses, the tool exits. The Siebel ARM Query Tool processes in two phases:
|
memlimit=memory
|
Specifies the amount of memory, in megabytes, that the Siebel ARM Query Tool can allocate to an internal buffer which the tool uses to compute aggregated statistics. The more memory that the internal buffer can use, the more accurate are the statistics returned. The default memory limit is 20 MB. You can allocate a value between 5 MB and 500 MB. The value that you specify does not affect performance; it only applies to the buffer that the Siebel ARM query uses for statistical calculation. |
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool". It describes how you can specify the Siebel ARM file(s) that the Siebel ARM Query Tool uses. The Siebel ARM Query Tool converts binary Siebel ARM files into readable output for analysis.
Table 15-3 describes the available input options. All of the listed options must be preceded by the option -input.
Table 15-3 Input Flags for the Siebel ARM Query Tool
| Flag | Description |
|---|---|
sarmfile
|
Specifies a binary Siebel ARM file (.sarm). |
directory
|
Specifies a directory that contains Siebel ARM files. The Siebel ARM Query Tool processes all of the Siebel ARM files that it finds in the specified directory. |
stdin |
A literal keyword that tells Siebel ARM query to read a list of Siebel ARM file names from standard input. You specify one Siebel ARM file or a directory name per line. The following are examples of valid input using > sarmquery . > sarmquery –input d:\sarmdata > sarmquery d:\sarmdata\srvr1 d:\sarmdata\srvr2 sarmfile1.data > dir /s /b *.sarm | sarmquery –input stdin |
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool".
This topic discusses the output options that are available to you when you use the Siebel ARM Query Tool. Table 15-4 describes the flags that you can use to configure output.
The Siebel ARM Query Tool can simultaneously write output to files in the TXT, XML and CSV formats. The following example shows using the Siebel ARM Query Tool to write different types of information to different files.
> sarmquery –input d:\sarmdata –select subarea=infra_entry –select resp=1000 –output header=hdr.csv –output sarm=sarm.csv -aggregate area –output agg=agg.xml
The preceding command writes:
Information about the header metadata from the Siebel ARM files to the file hdr.csv
Siebel ARM data to the file sarm.csv
Aggregate information about the area to the file agg.xml
You can also specify a maximum number of lines to write to a file. When the file contains the maximum number of lines specified, the Siebel ARM Query Tool creates a new file with the same filename plus N, where N equals a number. The following example illustrates the use of this option:
> sarmquery –output sarm=sarmdata.csv#20000
This command writes Siebel ARM data in comma-separated values (CSV) format to the file named sarmdata.csv. The optional value #20000 writes a maximum of 20,000 lines to sarmdata.csv. Once sarmdata.csv contains 20,000 lines, the Siebel ARM Query Tool writes to a new file with the name sarmdata_0002.csv, and so on, until all of the applicable data is output.
All flags in Table 15-4 must be preceded by the option -output.
Table 15-4 Output Flags for the Siebel ARM Query Tool
| Flag | Description |
|---|---|
fdr=filename
|
Converts all FDR files (specified using Note: For more information about FDR (flight data recorder) files, see Siebel System Monitoring and Diagnostics Guide. |
fdrhdr=filename
|
Converts all of the FDR headers to CSV and write them to the specified file. |
error=filename
|
By default, the Siebel ARM Query Tool writes output to the file stderr.txt. This command redirects error messages to the specified file. |
debug=filename
|
By default, Siebel ARM query does not write debug messages. This command enables the Siebel ARM Query Tool to write debug messages to the file specified file. |
dbglines=filename
|
This command enables the Siebel ARM Query Tool to write more debug information. |
verbose=filename
|
By default, the Siebel ARM Query Tool writes to the file stderr.txt. This command redirects verbose output to the specified file. |
map=filename
|
Creates a file which lists all areas and subareas for Siebel ARM. |
header=filename appheader=filename cliheader=filename |
The available flags are:
The following example writes information about all headers to all.csv and then writes information for each specific part to a different file: > sarmquery –input dir –output header=all.csv –output appheader=app.csv –output cliheader=cli.csv |
sarm=filename appsarm=filename clisarm=filename |
The available flags are:
The following example writes Siebel ARM data generated by the Siebel Server: > sarmquery –output appsarm=app.csv |
agg=filename iagg=filename sagg=filename |
The available flags are:
To use the options, you must have aggregated Siebel ARM data by using the flag |
avginclresp=filename pctcount=filename pctinclresp=filename pctselftime=filename |
The available flags are:
> sarmquery –histogram resp=100,500,1000,2000,5000
– out pctcount=stdout.txt
|
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool". It describes how to use selection filters with the Siebel ARM Query Tool to constrain the data that the tool retrieves.
Siebel ARM files contain one or more segments. Each segment has a header and a body section. The header section contains metadata describing the data contained in the body section. For example, the metadata describes the time range when the data in the body section was collected and the amount of data in the body section.
You can use selection filters to filter the metadata and the actual performance data.
Table 15-5 describes the filters that you can use for the metadata in Siebel ARM files
Table 15-6 describes the filters that you can use for data in Siebel ARM files
Note the following points when you formulate queries:
String filter searches are case insensitive and accept wild cards. For example, the following query retrieves Siebel ARM records associated with the users johndoe, JOHNDOE, and JoHnDoE:
> sarmquery –select user=JohnDoe
String filters also accept leading and trailing wild cards. For example, each of the following queries retrieves records associated with the same users, and possibly others:
> sarmquery –select user="*doe" > sarmquery –select user="john*" > sarmquery –select user="*hndo*"
|
Note: Wild cards can only be leading or trailing. Wild cards in the middle of a pattern do not retrieve results. For example, the patternjo*ndoe does not retrieve johndoe. |
You can combine selection filters to retrieve records that match multiple conditions. For example, the following selection filter retrieves all script execution records that executed for at least 5 seconds:
> sarmquery –select area=script –select resp=5000
All of the options listed in Table 15-5 must be preceded by the option -select.
Table 15-5 Siebel ARM Query Tool Header Filter Flags
| Flag | Description |
|---|---|
component=componentname
|
Selects headers from Siebel ARM files that were generated by the named component. |
fillfactor=percent
Or: fillfactor=minpct,maxpct |
Use this flag to specify a percentage value; the Siebel ARM Query Tool retrieves headers that are percent full. Alternatively, you can specify two arguments, a minimum percentage minpct and a maximum percentage maxpct to retrieve a range of values. Generally, headers have a capacity to hold a certain number of Siebel ARM records. The percentage value is the ratio of actual number of records to that capacity. |
host=hostname
|
Selects headers from Siebel ARM files generated on the named host. |
procid=integer
|
Selects headers from Siebel ARM files generated by a process whose ID (process ID) is inter. |
segcapacity=nrecs
Or: segcapacity=min,max |
Selects headers whose capacity to hold Siebel ARM records matches the number of records specified by nrecs. Alternatively, you can specify two arguments, a minimum number of records and a maximum number of records, to retrieve a range of values. |
segduration=nsecs
Or:
segduration=min,max
|
Selects headers whose duration matches the number of seconds specified. A header duration is the number of seconds the file segment was in memory before it was flushed. Alternatively, you can specify two arguments, min and max, to retrieve a range of values. |
segid=min Or:
segid=min,max
|
Specify a single argument to retrieve the headers with an internal segment ID of at least min. Alternatively, you can specify two arguments, min and max, to retrieve a range of values. |
segsize=size
Or:
segsize=min,max
|
A segment size is the size of the header and body in bytes. Specify a single argument of size to retrieve all headers whose segment size is size bytes. Alternatively, you can specify two arguments, min and max, to retrieve a range of values. |
server=servername
|
Retrieve headers from Siebel ARM files generated on the specified Siebel Server servername. |
sourcetype=value
|
Retrieves headers from Siebel ARM files generated by the specified type of server or process. Specify one of the following parameters in place of value to retrieve the headers:
|
threshold=min Or:
threshold=min,max
|
A threshold is a value represented in milliseconds. In the Siebel ARM framework, any performance record whose total response time duration is less that the threshold amount is discarded. The threshold setting at the time the Siebel ARM file was generated is saved in the header. Specify a single argument to retrieve all headers that contain Siebel ARM records whose threshold was least min milliseconds. Alternatively, you can specify two arguments, min and max, to retrieve a range of values. |
starttime=start
|
Specify a start time to retrieve headers that contain Siebel ARM records that ended after the specified start time. Note: Time filters are compared against the generation start time for Siebel ARM records. You can specify the start time in the following ways:
|
endtime=end
|
Specify an end time to retrieve headers that contain Siebel ARM records that were generated before the specified time end. Note: Time filters are compared against the generation end time for Siebel ARM records. You can specify the end time in the following ways:
|
Table 15-6 describes the filter options that you can use when you formulate a query to retrieve Siebel ARM data. All of the options must be preceded by the option -select.
Table 15-6 Siebel ARM Query Tool Flags for Record Selection
| Flag | Description |
|---|---|
foreign |
Use this flag to retrieve records whose parent records are from a different process. This is frequently the case for Siebel ARM data generated from batch mode components. |
orphan |
Select records that are not root records and whose parent record was not found in the input Siebel ARM file(s). |
level=level
Or:
level=min,max
|
Specify one argument to retrieve records whose Application Program Interface (API) level is at least equal to level. Alternatively, specify two arguments to retrieve a range of values between the minimum and maximum level specified. The API level indicates the importance of a Siebel ARM record as follows:
|
parentid=ID
|
Selects Siebel ARM records whose parent ID is ID. |
rootid=ID
|
Selects Siebel ARM records whose root ID (also known as request ID in interactive mode components) is ID. |
sarmid=sarmid
Or: sarmid=procid.sarmid Or: sarmid=segid.procid.sarmid |
Retrieves Siebel ARM records primary ID where:
|
sessionid=sessid
|
All session based component performance data contain an attribute known as the session ID. All performance data from all processes that have the same session ID are assumed to belong to a single session of a single user. The Siebel ARM Query Tool does a case-insensitive search using sessid. Wild cards are acceptable. |
taskid=taskid
|
Selects all records that associated with task taskid. |
threadid=threadid
|
Selects all records that were created by the thread whose operating system thread ID is threadid. |
user=username
|
Selects all records that were created by user named username, which is typically the login name. The search is case-insensitive and wild cards are acceptable. |
area=area area=areacode subarea=sub subarea=subcode pararea=parea pararea=pareacode parsubarea=psarea parsubarea=pscode |
Two filters, The area and subarea are logical sections of the Siebel Server. For example, the Siebel Web Engine (SWE) area creates Web pages. Siebel ARM records associated with the SWE describe Web page creation performance. Similarly, the database connector (DBC) area represents the connection to the enterprise database. Siebel ARM records associated with DBC indicate the performance of database queries. For example, the following command retrieves all Siebel ARM records associated with database queries: > sarmquery –select area=DBC You can retrieve a complete list of areas, subareas, and descriptions from the Siebel ARM Query Tool. For example, the following command saves the complete list to the file map.csv: > sarmquery –output map=map.csv If you know the numeric area or subarea codes, then you can use them directly in this command. Otherwise, you can use the string form of the symbol. When using the string form, you do not need to use the entire text string. You can use a partial text string, provided that it uniquely identifies the area or subarea. The filters > sarmquery –select pararea=swe |
children=0 |
Use this flag to retrieve Siebel ARM records that have no child records. |
children=count
Or: children=min,max |
Specify one argument to retrieve Siebel ARM records that have child records equal to at least count. Specify two arguments to retrieve the records that have child records between min and max. |
cputime=ms
Or:
cputime=min,max
|
Specify one argument to retrieve Siebel ARM records that spent at least ms milliseconds on the CPU. Specify two arguments to retrieve the Siebel ARM records that spent between min and max milliseconds on the CPU. |
depth=depth
Or: depth=min,max |
Specify one integer argument to retrieve Siebel ARM records that are no more than depth from the root node. Specify two arguments to retrieve a range of records. |
descendants=count
Or: descendants=min,max |
Specify one integer argument to retrieve Siebel ARM records that have at least count descendants. Specify two arguments to retrieve a range of values. |
instance=string detail=string int1=int |
Use these filters to retrieve Siebel ARM records where the filter is as follows:
Note: The values that the preceding metadata fields reference depend on the associated area or subarea. |
memusage=excl
Or:
memusage=min,max
|
Specify one argument to retrieve all Siebel ARM records where memory allocated or deallocated was larger than excl bytes. Specify two arguments to retrieve a range of Siebel ARM records that record the memory allocation or deallocation events within the specified range. For example, the following command retrieves all Siebel ARM records where the associated event recorded a memory allocation of 1 MB (or larger) or a deallocation of 1 MB or larger > sarmquery –select memusage=1000000 |
pctcpu=percent
Or:
pctcpu=min,max
|
Specify a single argument to retrieve Siebel ARM records that indicate a CPU consumption of the percentage percent. Specify two arguments to retrieve a range between min and max percent. |
resptime=ms
Or:
resptime=min,max
|
Specify one argument to retrieve Siebel ARM records where the inclusive wall clock time consumed is ms milliseconds. Specify two arguments to retrieve a range between min and max. An inclusive wall clock time is the time spent in a specific part of the architecture and includes the time spent in all of its descendants. For example, the response time of a SWE area would be the time spent in constructing a Web page, including the time to evaluate business component events and database access. |
selftime=ms Or:
selftime=min,max
|
With one argument, select Siebel ARM records where the exclusive time consumed is ms milliseconds. With two arguments, min and max specify a range. An exclusive time is time spent in an area, and only in that area, excluding the time spent in its descendants. Hence, the self time of a SCRIPT area would be the time spent in the scripting engine, and not including time spent in the database, object manager, workflow, and so on. |
starttime=start
Or:
endtime=end
|
The semantics and syntax are similar to the time filters described for headers, except that the filters select Siebel ARM records based on the time stamps. |
tree=all parent=parent tree=ancestor tree=children tree=descendent |
These are a specialized set of selection filters that do not just operate on a single record basis but on record sets. In most cases, they serve to replace a performance record with an entire set. In order to understand these operators, it is important to realize that Siebel ARM records form a tree of an execution thread with parent and children nodes:
|
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool". It describes the aggregation options available to you when you use the Siebel ARM Query Tool. Aggregation is the grouping of Siebel ARM records that share a common attribute and the computing statistics on the group.
Multiple –aggregate options can be specified, which are interpreted as sub-aggregations.
The Siebel ARM Query Tool can compute the total, maximum, minimum, average, and the count of contributing records for the following items:
Inclusive Response Time
Exclusive Response Time (self time)
Inclusive CPU Time
Exclusive CPU Time
Inclusive Memory Usage
Exclusive Memory Usage
|
Note: Aggregation is computed on Siebel ARM records that are retrieved by the selection filters. |
All of the options listed in Table 15-7 must be preceded by the option -aggregate.
Table 15-7 Siebel ARM Query Tool Flags for Aggregation
| Flag | Description |
|---|---|
area |
Siebel ARM records that have the same value for |
subarea |
Siebel ARM records that have the same value for > sarmquery -aggregate area -aggregate subarea > sarmquery –select area=DBC -aggregate subarea |
instance |
Siebel ARM records that have the same value of instance metadata are grouped together. Instance metadata typically contains names of things such as scripts, workflows, and views. This means that the value for the instance metadata depends on the area or subarea. As a result, aggregate instance must either be preceded by an aggregation of area or subarea or a filter on area or subarea, as with the following example: > sarmquery -aggregate area -aggregate instance > sarmquery –select area=script -aggregate instance |
server component host procid |
Aggregates Siebel ARM records that have the same value for:
|
user |
Aggregates Siebel ARM records that have the same value for user name. User name is case sensitive. |
sessionid |
Aggregates Siebel ARM records that have the same value for session ID. Tip: This flag can be useful when used in conjunction with the flag for > sarmquery -aggregate user -aggregate sessionid > sarmquery –select user=andy -aggregate sessionid |
clickid |
Aggregates Siebel ARM records that have the same value for Typically in an interactive component, a user has multiple sessions and a session has multiple requests. Sometimes a single user action on the client (browser) results in multiple requests. In such cases, each of those requests is associated with the same unique ID, known as the clickid. This ID is generated and associated with requests even if a user action results in a single request. Tip: Use this flag in conjunction with > sarmquery -aggregate user -aggregate sessionid -aggregate clickid > sarmquery –select user=andy -aggregate sessionid -aggregate clickid |
time=interval
|
Aggregates Siebel ARM records by their time stamps over the interval specified by interval, where interval is a value in minutes. For example, if you specify 5, then Siebel ARM records with time stamps of 12:00 to 12:05 form one aggregation, those with time stamps of 12:05 to 12:10 form another aggregation, and so on. The following example command displays a report to the command window that shows the average response time of the Siebel Server over intervals of 15 minutes: > sarmquery –select source=app –select subarea=infra_entry -aggregate time=15 |
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool".
Histograms are a special type of aggregation. You can use a histogram to aggregate the results that the Siebel ARM Query Tool retrieves when you submit a query on Siebel ARM data that might return too many values if you do not use the histogram.
For example, note the following query:
> sarmquery -aggregate resptime
This query might retrieve millions of rows as the first row returns the requests that completed in one millisecond, the second row returns the number of requests that completed in two milliseconds, and so on.
A more effective query generates a histogram as in the following example:
> sarmquery –histogram resptime=100,200,300,400,500
This query returns six rows. The first row aggregates the number of requests that complete in less than 100 milliseconds, the second row aggregates the number of requests that completed between 100 and 200 milliseconds, and so on.
In the preceding example, the values 100, 200, 300 and so on are known as bin endpoints.
Table 15-8 describes the flag options that you can use with the histogram parameter. All of the listed options must be preceded by the option -histogram.
Table 15-8 Flag Options for the Histogram Parameter
| Flag | Description |
|---|---|
resptime=val1,val2 … valN |
Creates a histogram of response (inclusive) times, where the arguments val1 and val2 specify the bin endpoints. val1 and val2 are expressed in milliseconds. |
selftime=val1,val2 … valN
|
Creates a histogram of self time (exclusive) times, where val1 and valN specify the endpoints. The values are expressed in milliseconds. |
pctcpu=val1,val2 … valN
|
Creates a histogram of the percentage of CPU time consumed. The arguments are expressed as integers between 0 and 100. |
children=val1,val2 … valN
|
Creates a histogram of the width of the execution trees. |
depth=val1,val2 … valN
|
Creates a histogram of the depth of the execution trees. |
This topic is part of "Analyzing Siebel ARM Files Using the Siebel ARM Query Tool".
The Siebel ARM Query Tool supports the use of macros. A macro allows you to save complex queries to a file, which you can subsequently use as input for the Siebel ARM Query Tool.
To create a macro, you need to:
Write the syntax of your query in a CFG file (for example, macro.cfg).
Each part of the query must appear on a separate line in the CFG file.
Define a name for the macro, which you insert before the first line of your query in the CFG file.
For example, the following query, which retrieves data on the average login time for users, can be input as one entry from the command line:
> sarmquery –input d:\sarmdata –select source=app -select subarea=objmgr_sess_relogin -select tree=all -select depth=1 -aggregate user -output avginclresp=stdout.txt
However, in the CFG file the preceding query is assigned the macro name [Login] and appears as follows:
[Login] –input d:\sarmdata -select source=app -select subarea=objmgr_sess_relogin -select tree=all -select depth=1 -aggregate user -output avginclresp=stdout.txt
For the Siebel ARM Query Tool to use a macro, you need to specify two parameters:
The location of the CFG file that contains the macro
|
Note: A CFG file can contain multiple macros. |
The name of the macro to execute
The following example requests that the Siebel ARM Query Tool execute the Login macro, which is saved in the macro.cfg file.
> sarmquery –config file=macro.cfg –config macro=Login
The Siebel ARM Query Tool reads the input arguments for the macro as if you had specified the individual parts of the macro on the command line. This means that you can specify additional arguments that might not be in your macro. The following example executes the Login macro and in addition specifies a time slice:
> sarmquery –config file=macro.cfg –config macro=Login –select starttime="2017-06-10 10:00:00" –sel endtime="2017-06-11 09:59:59"
For more information about configuration commands, see "Configuring the Siebel ARM Query Tool".
For a complete description of the macro language syntax and other options, execute the following command from the command line:
> sarmquery –macrosyntax
