Dashboard Macro Reference

Related Tags: project administration dashboard

The list below is a comprehensive overview of the macros currently supported in GoodData.

  • Source examples are examples of what might actually be typed into an embedded web content widget or textbox.
  • Target examples are examples of macro outputs, or the sorts of dynamic project values that might replace a certain type of macro.

CURRENT_DASHBOARD_URI

NOTE: For use in embedded web content widgets only

DescriptionRepresents the (encoded) URI of the active dashboard
Parametersnone
Source example%CURRENT_DASHBOARD_URI%
Target example%2Fgdc%2Fmd%2FGoodSalesDemo%2Fobj%2F1952

CURRENT_DASHBOARD_TAB_URI

NOTE: For use in embedded web content widgets only

DescriptionRepresents the URI of the active dashboard tab
Parametersnone
Source example%CURRENT_DASHBOARD_TAB_URI%
Target example85f6945b672d

CURRENT_PROJECT_HASH

NOTE: For use in embedded web content widgets only

DescriptionRepresents the hash ID of the active project
Parametersnone
Source example%CURRENT_PROJECT_HASH%
Target examplewgx0zvz7489uys5vofom0o1aw1of3z9

CURRENT_USER_EMAIL_MD5

NOTE: For use in embedded web content widgets only

DescriptionRepresents the (encoded) email address of the active user (hashed to MD5)
Parametersnone
Source example%CURRENT_USER_EMAIL_MD5%
Target example 02b658338e9d004709a94c8b3b46f01b3

DATE_FILTER_VALUE

NOTE: For use in text boxes as well as embedded web content widgets

Description

Represents the value that is currently selected in some specified data attribute filter
Parameters:
  • Meta identifier of the date attribute that belongs to some specified date filter.
  • Time keyword: one of two values: {FROM, TO}. Determines whether the value returned by the macro is the start date of the filter’s time range (FROM) or the end date of the filter’s time range (TO).
Syntax%DATE_FILTER_VALUE(<date_attribute_identifier>,FROM|TO)%
Source example%DATE_FILTER_VALUE(closed.date,FROM)%
Target example2010-10-28

FILTER_TITLE

NOTE: For use in dashboard text boxes as well as embedded web content widgets

Description
  • Similar to the FILTER_VALUE macro, but represents the currently selected value of some specified attribute filter in human-readable language (the same way the value appears to users in the filter’s dropdown menu)
  • Unlike FILTER_VALUE, FILTER_TITLE does support multiple filter values. In the case where multiple values are selected, values are separated by commas in the macro output.
ParametersFor the FILTER_TITLE macro’s parameter, use the identifier of the filter’s attribute. e.g. For a filter that filters for level of educational attainment, use the identifier for the education attribute (attr.education), not the identifier for the filter itself.
Syntax %FILTER_TITLE(<attribute_identifier>)%
Source example%FILTER_TITLE(attr.education)%
Target example Consulting, Tech, Telecom

FILTER_VALUE

NOTE: For use in embedded web content widgets only

Description
  • Represents (encoded) URI of the attribute value that is currently selected in some specified attribute filter
  • Only returns one selected filter value – does not support multiple filter values selected simultaneously
Parametersmeta identifier of the attribute object that belongs to the attribute filter
Syntax%FILTER_VALUE(<attribute_identifier>)%
Source example%FILTER_VALUE(attr.education)%
Target example2gdc%2F%2FGoodSalesDemo%2obj%2F263%2Felements%3Fid%330

VARIABLE_VALUE

NOTE: For use in embedded web content widgets only

Description
  • Represents the (encoded) value that is currently selected in some specified variable filter
  • In the case where multiple values are selected, these values are separated by commas
  • Supports up to 15 selected variable filter values
Parameters: Meta identifier of the variable that belongs to the variable filter
Syntax %VARIABLE_VALUE(<variable_identifier>)%
Source example%VARIABLE_VALUE(assNNkQ0ZefWf)%
Target example%2Fgdc%2Fmd%2FGGoodSalesDemo%2Foj%2F23%2elements%3Fid%3D3

URL_PARAM

NOTE: For use in text boxes as well as embedded web content widgets

DescriptionRepresents the value of a URL parameter in the active dashboard’s URL. URL_PARAM macros could be useful in the case where a GoodData dashboard is being externally filtered with HTTP parameter filters and contains embedded web content that you’d like to filter by these same values. To pass the parameter filter values through to the embedded web content, you could add the URL parameter macro %URL_PARAM(<parameter_name>)% to web content widget’s iframe embed code. Once the widget is saved, the entire macro would be dynamically replaced by the parameter’s current value in the dashboard’s URL.
ParametersName of the URL parameter
Syntax%URL_PARAM(<parameter_name>)%
Source example%URL_PARAM(project)%
Target exampleSales_Management