List of macro variables

In many description fields, for example, graph labels, you can either input a fixed string or use macro-variables so that the final output will automatically reflect the contents.

Macro variables are delimited in the text flow by two percentage signs (%) that tell TrueSight Capacity Optimization where to insert the associated value. For example, the string: CPU Load - (%RESLY%)

will be automatically completed with the adverb explaining the time resolution used within the analysis (e.g. hourly, daily, or monthly). The output might be: CPU Load - (hourly)

The following tables list the macro variables that can be used in TrueSight Capacity Optimization to customize the displayed entities with names and titles from the represented data. For instance, you can use these variables in the Editing an analysis to automatically label the chart name, axis, or legend.

Variable Name

Description

%ENTNAME%

System or business driver name (for example, DB SRV33)

%OBJNAME%

Metric name (for example, CPU LOAD)

%ENTOBJECT%

%ENTNAME% - %OBJNAME%

%LOCATIONNAME%

Location of the series.

%SUBOBJNAME%

Sub metric name if the metric is not "global"

%STATNAME%

Name of the used statistic (for example, min, max, avg, . . . )

%RES%

Time resolution (for example, hour, day, . . . )

%RESLY%

Time resolution in adverbial form (for example, hourly, monthly, . . . )

%SERIESNAME%

Complete series name (for example, sys1-Disk Util % by disk-disk001)

%METRIC%

Name of the metric (for example, CPU Utilization %)

%UNIT%

Measurement unit (for example, seconds, number of events, . . . )

%SERIESTZ%

Timezone of a series if collected by the datasource

%REMAPTZ%

Timezone of the chart, if series were shifted to an user selected timezone

%DATERANGE%

Time range of the series shown in the chart. (for example, from 25/12/2010 to 27/12/2010)

%TFRANGE%

Time range of the time filter used to build the chart. It might be different from %DATERANGE% if some data is missing or when a summary chart is produced

%CHART_SPLIT%

An automatic description based on the "chart split" analysis property. (for example, if chart split by parent is selected, it is the name of the parent system)

%TFDESCR%Time Filter description chosen to build the analysis or model. It can only be used in analyses and model descriptions.
%TAG%Associate this tag to fields on the Editing chart options for an analysis to display all the tags added to the entity, while creating an analysis.
%TAG{TAG_TYPE}%Associate this tag to fields on the Editing chart options for an analysis to display specific tag types added to the entity, while creating an analysis.
%TEMPLATENAME%Name of the template.
%TEMPLATEDESCRIPTION%Description of the template.
%RESOLUTION%Time resolution of the analysis.
%DOMAINNAME%Name of the domain.
%TFDDESCR%Description of the time filter.

The following macro variables can be used only in correlation analyses:

Variable Name

Description

%XENTNAME%

Name of the system or business driver that is plot on the x-axis

%XOBJNAME%

Name of the metric on the x-axis

%XENTOBJECT%

%XENTNAME%-%XOBJNAME%

%XSUBOBJNAME%

Sub metric name if the metric is not "global" on the x-axis

%XLOCATIONNAME%

Location on the x-axis

%XSTATNAME%

Name of the used statistic (for example, min, max, avg, . . . ) on the x-axis

%YENTNAME%

Name of the system or business driver that is plot on the y-axis

%YOBJNAME%

Name of the metric on the y-axis

%YENTOBJECT%

%YENTNAME%-%YOBJNAME%

%YSUBOBJNAME%

Sub metric name if the metric is not "global" on the y-axis

%YLOCATIONNAME%

Location on the y-axis

%YSTATNAME%

Name of the used statistic (for example, min, max, avg) on the y-axis

Was this page helpful? Yes No Submitting... Thank you

Comments