Reports:Templates:Parameters

Help : Reports : Templates : Parameters

The following table list the actions and arguments recognized in a report template:

Action	Arguments	Description
action=include	file	Process specified template file and insert results.
action=set		Set the specified <key>=<value> pairs so that they can be used as default values in subsequent commands in this document. Note: Subsequent commands can also refer named variables defined by a set action. The syntax used for this type of reference is $<key>. For example, the statements: <inmon>action=set; server=10.0.0.1</inmon> <inmon>action=report; serverAddress=$server</inmon> would result in serverAddress=10.0.0.1
action=clear		Clear the values assigned by set actions.
action=print	variable	Insert the value assigned to the specified variable. e.g. variable=valueColumn will print the value of the valueColumn variable.
action=ask	askCategory	Prompt for parameters and their values. Once values have been obtained the ask block is converted into a set block with the supplied values. Note: The ask action can only be used in Interactive Reports.
	askName
	askDescription
	askTitle
	<param>.<attr>
action=date	date	Print the date range in the specified format.
	TZ
	format
action=index	category	Create an index entry for this report in the Scheduled Reports list. The reports will be grouped by category, and listed by their names and descriptions.
	name
	description
action=toc	category	Create a table of contents listing all the reports by their index entries. If category is omitted, all reports will be listed. If specified, only reports in the specified category will be listed. Note: Typically the toc action will only be used in the index.shtml template, since this template is guaranteed to be evaluated last. If the toc action is used in other templates it will result in an incomplete listing of reports, listing only those reports that have already been evaluated.
action=report	host	Insert a chart or table as specified by the parameters.
	reportName
	reportFormat
	width
	height
	categoryColumn
	valueColumn
	includeLinks
	includeDelta
	chartType

askCategory

The category for this report on the Interactive Reports page.

askName

The name of this report on the Interactive Reports page.

askDescription

The description of this report on the Interactive Reports page.

askTitle

The title of the form when prompting for parameters.

<parameter>.<attribute>

Prompt for a value for a parameter. Different attributes can be supplied:

	prompt The prompt string to be used when asking for the parameter.
	default The default value of the parameter.
	options A list of possible parameter values. Certain option lists are predefined and can be referred to by name. These include dateOptions, groupPeriodOptions and tableTypeOptions
	required Set to YES if a value must be supplied before the report can be evaluated.

For example, the statements:

serverAddress.prompt=Server IP Address;

serverAddress.default=10.0.0.1;

serverAddress.options=10.0.0.1,10.0.0.2,10.0.0.3,10.0.0.4;

serverAddress.required=yes;

would result in the following request:

	range Print the date interval as a range (e.g. [start - end])
	start Print the start of the date range.
	end Print the end of the date range.

category

The category for this report on the Scheduled Reports page.

name

The name of this report on the Scheduled Reports page.

description

The description of this report on the Scheduled Reports page.

host

The Traffic Server to which the Report query will be addressed. Default is localhost.

reportName

The following reports are defined:

reportName	Description	Parameters
TopN	Top N chart using data from the Site Traffic and Site Service queries.	tableType, categoryColumn, valueColumn, sourceAddress, sourcePort, destinationAddress, destinationPort, serverAddress, serverPort, clientAddress, clientPort, date, TZ, day, hour, groupPeriod, groupMask, resultTruncate
Trend	Time series chart using data from the Site Traffic and Site Service queries.	tableType, valueColumn, sourceAddress, sourcePort, destinationAddress, destinationPort, serverAddress, serverPort, clientAddress, clientPort, date, TZ, day, hour, groupPeriod
Stats	Report on data from the Interface query.	agent, interface, valueColumn, date, TZ, day, hour
Events	Report on data from the Event Counts query.	categoryColumn, type, severity, name, value, address, interface, enterprise, site, zone, subnet, port, date, TZ, day, hour, groupPeriod, resultTruncate
SLA	Report on interfaces that fail to meet service level objectives.	date
Congestion	Report on most congested interfaces.	date
Errors	Interfaces with worst error rates.	date
Status	Delay or packet loss rate to remote sites.	address, resultSort, trendType, date

reportFormat

The following formats are available:

	chart Insert a chart specified of type chartType
	table Insert results as an html table.

width

The width of the chart gif in pixels.

height

The height of the chart gif in pixels.

categoryColumn

The name of the attribute that will be used to create chart categories. For example, setting categoryColumn=sourceAddress will create a chart with a bar for each source address in the data.

categoryColumn names depend on the type of query generating the report data. The category column must be taken from the list of Key Fields:

	Site Traffic
	Site Service
	Events

valueColumn

The name of the attribute that will be used to create chart values. For example, setting valueColumn=bytes will create a chart in which each bar represents the number of bytes.

valueColumn names depend on the type of query generating the report data. The value column must be taken from the list of Value Fields:

	Site Traffic
	Site Service
	Interface Counters

includeLinks

The name of the attribute that will be used to create chart values. For example, setting valueColumn=bytes will create a chart in which each bar represents the number of bytes.

valueColumn names depend on the type of query generating the report data. The value column must be taken from the list of Value Fields:

includeDelta

If reportFormat is a table then setting includeDelta to YES creates an additional column in the table representing the delta between the current position in the table and the position the last reporting interval. The delta column contains the following symbols:

(M)	A rise of M positions since the last report.
(-N)	A decline of N positions since the last report.
	Position unchanged.
	New in the list.

chartType

The following chart types are supported:

	horizontalBar
	bar
	pie

	today
	yesterday
	thisWeek
	lastWeek
	thisMonth
	lastMonth
	last24Hours
	last7Days
	last30Days