Substitution Variable Syntax

Substitution variables (bind variables) can be used in metrics, including internal and external URLs, data sources, charts, and state model components. Wildcard characters are not supported.

The syntax for using variables is as follows:

${variableName:variableArg}

Some variables have fixed arguments. For example:

${USR:TOKEN}

Other variables require you to provide an argument such as a global variable or a metric field name. For example, when formatting an external URL, you can pass the value of a metric instance’s Ticker field to a target page as follows:

http://finance.yahoo.com/q?s=${VAR:Ticker}
Substitution (Bind) Variable Syntax
Type Argument Description
SYS NOW A timestamp of the current date and time, formatted using yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2010-05-03T16:38:45.785-0700.
TODAY A timestamp of the current day, formatted using yyyy-MM-dd. For example, 2010-05-03.
STARTOFDAY A timestamp, indicating the beginning of the day, formatted using yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2010-05-03T00:00:00.000-0700.
ENDOFDAY A timestamp, indicating the end of the day, formatted using yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2010-05-03T23:59:59.999-0700.
YESTERDAY A timestamp indicating the prior day, formatted using yyyy-MM-dd. For example, 2010-05-03.
STARTOFYESTERDAY A timestamp indicating the beginning of the previous day, formatted using yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2010-05-03T16:38:45.785-0700.
ENDOFYESTERDAY A timestamp indicating the end of the previous day, formatted using yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2010-05-03T16:38:45.785-0700.
USR NAME The user’s ID.
ROLE The user’s current role
TOKEN The token that authenticates the user to Dashboard.
ENV EnvVariable Passes the value of the specified environment variable. Variable arguments can be any property accessible via System.getProperty().
PROP CDDProperty Passes the value of a property defined in the Dashboard agent class in the CDD. You can add properties specifically to be used in TIBCO BusinessEvents Views such as in URL links.
VAR MetricField Passes the value of the specified metric field.

This variable is required when you configure internal URL links. See Internal Links Configuration.

Note
: the VAR substitution variable can be used only when the relevant metric instance data is available. It cannot be used in the context of using a data source when defining a chart.
GVAR GVarName Passes the value of the specified global variable.