Common mediator parameters

This table contains the most common mediator parameters in alphabetic order. The table includes a brief description and information about how to edit each parameter.

Parameter Description How to Edit

AdvGrpTimeSeries

Enable and configure an Advanced Group Time Series (AGTS). If you do not enable an AGTS, a standard GTS is generated by using the statistics specified for the mediator.

Consider using the AGTS with the following:

  • Daily, weekly, monthly
  • Quarterly, yearly, 14 monthly, use it during off-peak hours or for scheduled reports

When you configure an AGTS, the statistics value for the mediator parameter of the reporter is ignored. AGTS statistics are defined through the AGTS window.

AGTS reports use raw data rather than previously aggregated data from the database. As a result, the amount of data that is queried and aggregated each time an AGTS report is run is proportional to the length of the report period.
  • Double-click AdvGrpTimeSeries to access the AGTS window.
  • Select the Enable Advanced Group Time Series check box to enable the advanced time series behavior and to activate the configuration options.
  • For Spatial Aggregation statistics, retain the default value of sum or choose one of the following valid options: avg, count, min, or max.
  • Click Select to access the Select Stats window.
  • For Time Aggregation statistics, retain the default value of avg or choose one (or more) of the following valid options: count, min, max, or sum. The statistics you choose for time aggregation are applied to the results of the spatial aggregation. For example, if you choose avg as the time aggregation after retaining the default value of sum for the spatial aggregation, the chart displays the average of the sum of the data for the specified granularity period.
  • Optional: If you check Temporal Aggregation First, the primary aggregation is temporal, and the secondary aggregation is spatial. The default is the reverse.
  • Click the box next to Enable Data Filtering to enable data filtering on the resource count. If enabled, one data point is received per resource. The number of data points in the sampling period must equal the number of resources in the group. If not enabled, all data points in the sampling period are aggregated regardless of the resource count.
  • You can set the Tolerance to any value between 1.00 and 2.00. The default is 1.00. Tolerance accommodates time-stamp shifting among the polled resources. When time stamps differ, samples can be shifted enough in time to cross the boundary from one polling interval to another.
  • The system calculates the time difference between neighboring data points. If the difference is greater than the polling period but less than the polling period multiplied by the tolerance, a time-stamp correction is made, based on the previous time stamp plus the polling period.

baseline

Set the baseline and choose the statistic to be displayed.
  • Expand baseline.
  • Double-click periods to access the text box.
  • Enter the number of periods you want included in the report, from 1 to 5.
  • Double-click stats to access the Select Stats window.
  • The statistics currently used in the report are listed in the right pane. Additional statistics that can be used are listed in the left pane.
  • Edit the statistic for this baseline.

busyHours

Display the busy hour of the reporting period in the table report.
  • Double-click busyHours to access the drop-down list of values.
  • Choose true if you want the busiest time of the reporting period to display in the table.
  • Choose false if you do not want the busiest time of the reporting period to display in the table.

filter

String used to filter the results displayed in the generated report (GST or RST) when first accessed on the portal.

Note for RST: Remove the paging (filtering) page control from the style sheet upon which the RST is based if you want to prevent the user from overriding the filtering criteria you enter here. Filtering information entered on the portal overwrites the criteria set in the reporter.

Note for Multi-Resource: When configuring line chart filters, the family criteria can be left empty, which allows any ubelement of the group - whatever its family - to match the filter.
  • For GST only, Expand group.
  • Double-click filter to access the text box.
  • Enter the string you want to use to filter results.

formulaN

A list of formulas displays, numbered formula1 through formula6. The formula titles include a number, which indicates the position of the formula in the report. You can report on up to six metrics per report.

Note: Resource Summary Tables can be configured to support up to 20 metrics.

  • Expand formula1.
  • Double-click metrics to access the Metrics selection dialog box.
  • Double-click stats.
  • The Select Stats dialog box opens.

groupRatio

Setting the group ratio to true applies the distribution report to a group.
  • Double-click groupRatio to access the value list.
  • Click the down arrow to display the value true.
  • Click true to select it.

groupTOPN

Choose whether to report on resources or groups.
  • Double-click groupTOPN to access the value list.
  • Click the down arrow to display both values.
  • Click true to select it.

metricFromUrl

If the report you are drilling down from can pass metrics to the URL, that metric is used. Otherwise the metric name you enter in the metrics field is used.

Enter $URL:METRIC in the metricFromUrl field:

If the report you are drilling down from can pass metrics to the URL, that metric is used. Otherwise the metric name you enter in the metrics field is used.

metrics

Result of a formula applied to resources. You can select the metric information you want to display in the report.
  • Double-click metrics to access the Metric selection window.

If you are editing a reporter that includes the metricFromURL parameter, but the report you are drilling down from cannot pass metrics to the URL, the metric name you enter here is used.

numberOfResults

Set the number of results displayed on a report page.
  • Double-click numberOfResults to access the text box.
  • Edit the default value of 10 to the number you want.
  • Press Enter.

pageSize

Set the number of resources displayed on a report page.
  • Double-click pageSize:50 to access the text box.
  • Edit the default value of 50 to the number you want.

propertyN

Enter up to three properties (property1, property2, and property3) for a Trouble Ticket reporter.

Although you can include all three properties in the reporter, you can apply a filter to only one of them. (If you include more than one, the filter for the property with the lower number is used.)

Filter string values include the trouble ticket status codes P: and T:. You can enter one or both values to indicate that you want either one or the other value returned. Separate the values by using a semicolon. For example, to return the rows that contain only a P: or only a T:, enter:

P:;T:

You can then decide whether the filter string is inclusive or exclusive. Inclusive means to filter based on the values entered; exclusive means do not return the results for the values entered.
  • Expand propertyN (1, 2, or 3).
  • Double-click properties to access the Property Selection window.
  • Expand filter.
  • Double-click string to access the text box.
  • Enter the string on which to filter.

properties

Display resource properties in the report. A property is any attribute or characteristic that defines a resource more precisely and provides additional resource information. Properties can be customer attributes and technical attributes.

The properties option does not apply to group reports because groups do not have properties.
  • Double-click properties to access the Property Selection window.

provideAllRanges

Set the provideAllRanges parameter to true if you want the maximum 10 ranges to display, even if you only set some of them.
  • Double-click provideAllRanges to access the list of values.
  • Click the down arrow to display the value true. If you retain the default value of false, only the ranges you have set display.
  • Click true to select it. All ranges display (including those ranges you set.)

rangeN

Distribute resources or groups across specific ranges.
  • Expand range0.
  • Double-click valueOver to access the text box.
  • Enter a number to set the lowest value of the range. For example, enter 5.
  • Double-click valueUnder to set the highest value of the range. For example, enter 30. The first range you set is from 5 to 30 inclusive. If only one parameter is defined, a range is created based on that one definition. For example, if you set valueOver at 50 and leave valueUnder blank, the range includes only values over 50. If you enter 50 for valueUnder and leave valueOver blank, the range includes only values less than 50.
  • Repeat steps for each range you want to set. You can set a maximum of 10.

sort

Indicate the order by which you want to sort information in Trouble Ticket reports. Sort options include:

  • Name
  • Metric1
  • Metric2
  • Metric3
  • Metric4
  • Metric5
  • Metric6
  • Property1
  • Property2
  • Property3

Also indicate whether to list the results in ascending or descending order.
  • Expand sort.
  • Double-click ascending to display both values, true and false.
  • Highlight the value false and left-click if you want the sort results to display in descending order rather than ascending.
  • Double-click orderBy to display the list of values.
  • Highlight the value you want to use as the sort criterion and left-click.

stats

Values of the formula for the given time period
  • Double-click stats to access the Select Stats window.
  • Edit the statistics for this metric.

topRank

Enable or disable the top rank
  • Double-click topRank enable field to access the drop-down list.
  • Click the down arrow to display both values, true and false.
  • Highlight the value you want and left-click.

UseLookup

Indicate whether to use a lookup table to retrieve the string representation of a Problem Type metric for display in a Trouble Ticket report.

Because the database cannot store the string representation of metric values, a lookup table in the DataView registry stores the map of the metric to the associated string representation.

During Trouble Ticket report generation, the lookup table is used to map the numeric value with the string value for display in the report.
  • Double-click the UseLookup field to access the drop down list.
  • Click the down arrow to display both values, true and false.
  • Highlight the value you want and left-click to select it.

valueOver

Display all resources (or groups if a group TopN reporter) over or equal to the value you enter here.

Value over entries are applied to the statistic's values from the previous and the current period. If those values exceed the value you set here, they display on the report.

The valueOver parameters apply to the first statistic entered in the stats parameter.

If the report you are drilling down to can pass metrics to the URL, these parameter values are used to filter the results. Otherwise the number entered in the value field is used.
  • Expand valueOver.
  • Enter $URL:VO in the default field.
  • Enter a number you want to use as the filtering criteria in the value field.

This number is used if the report you are drilling down to does not pass metrics to the URL.

Note: If editing parameters for resource distribution report (ResDistribMediator1 range 0-9,) you enter a number into the valueOver fields for each range.

valueUnder

Display all resources (or groups if a group TopN) under or equal to the value you enter here.

Value under entries you make here are applied to the statistic's values from the previous and the current period. If those values fall short of the value you set here, they display on the report. The valueUnder parameters apply to the first statistic entered in the stats parameter.

If the report you are drilling down to can pass metrics to the URL, these parameter values are used to filter the results. Otherwise the number entered in the value field is used.
  • Expand valueUnder.
  • Enter $URL:VU in the default field.
  • Enter a number you want to use as the filtering criteria in the value field. This number is used if the report you are drilling down to does not pass metrics to the URL.

Note: If editing parameters for resource distribution report (ResDistribMediator1 range 0-9,) you enter a number into the valueOver fields for each range.