Charts: Using Macros in Titles

This will require Builder privileges for setup and implementation.

Macros are a feature within iDashboards that allow for a dynamic substitution of values. Macros are useful when you would like to indicate a value that changes over time or by context as the criteria for the filter. You can add macros to a chart title enabling that chart title to display dynamic content. Not all macros are applicable. Please see the attached documentation.

Please Note: Charts with macros in their title should NOT be allowed to be saved by individual users. Macros DO NOT work within the chart Name or Description fields or in a dashboard title.

Value Macros

The Value Parameter macro takes the following format: ${value:AxisName}

The Value Macro drilldown axis values is: ${value:} This macro will return the value of the axis named  . The axis name is case sensitive. If the user drills down by clicking on Detroit data point, the destination chart, which was originally saved with chart title Sales in ${value:city} can now display title Sales in Detroit. The Value Macro will only work on charts that are drilled down to, not charts that are newly opened. This is due to the fact the the Value Macro will have no context at initial load but will have context upon drilldown. When a datetime data type is used in a drilldown to Value Macro the time will be displayed.

Param Macros

The Input Parameter macro takes the following format: ${param:ParameterName}

Input Parameters provide the ability to create charts and dashboards whose displayed data is dependent on Input Parameter values provided by the user. Input Parameters can be defined at both the chart and dashboard level. Chart Input Parameters only affect their associated chart. Dashboard Input Parameters can affect every chart contained in the associated dashboard. Dashboard Input Parameters effectively pass their values down to the Chart Input Parameters of the charts within the dashboard. The parameter name is case sensitive. If the chart creator utilizes an Input Parameter with chart title:

Product Returns for ${param:start_year} to ${param:end_year}

and the Input Parameters are chosen as:

start_year=’2009’ and end_year=’2012’

then the title can now display:

Product Returns for 2009 to 2012

The Param Macro will work on charts that are both drilled down to and to charts that are newly opened. This is due to the fact the the Param Macro will have context at initial load and will have context upon drilldown. The value may be blank if an initial parameter value is not supplied to the macro. When a datetime data type is used in a drilldown to Param Macro the time will be displayed.

Date Macros

The date macro takes the following format:

${keyword:shifter +/- modifier, format}

The shifter will set the keyword value to a specific point, generally the first or last day of a month or year. The modifier is a whole number that can be added or subtracted from the result of the keyword or keyword:shifter value. The format determines how the date or time format will look. The shifter name is case sensitive.

If the chart creator utilizes an Date Macro with chart title:

Call Center Total Costs YTD to Three Months Ago: ${currmonth:begin - 3, "MMMM d, yyyy"}

and the date is May 25, 2012 the title will now display

Call Center Total Costs YTD to Three Months Ago: February 1, 2012

The Date Macro will work on charts that are both drilled down to and to charts that are newly opened. This is due to the fact the the Date Macro will have context at initial load and will have context upon drilldown.

For More Information:

• iDashboards Builder Manual 10.7 Adding Macros to Chart Titles

If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.