Dashboard Macro Reference

This article lists the supported dashboard macros. For more information about the macros, see Dashboard Macros.

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

Contents:

HOST_NAME

DescriptionThe URL of the currently used domain
Can be used inEmbedded web content widgets only
Syntax%HOST_NAME%
Source example%HOST_NAME%
Target examplesecure.gooddata.com

CURRENT_PROJECT_HASH

DescriptionThe ID of the currently selected project
Can be used inEmbedded web content widgets only
Syntax%CURRENT_PROJECT_HASH%
Source example%CURRENT_PROJECT_HASH%
Target examplee863ii0azrnng2zt4fuu81ifgqtyeoj21

CURRENT_DASHBOARD_URI

DescriptionThe URI of the currently selected dashboard (in encoded form)
Can be used inEmbedded web content widgets only
Syntax%CURRENT_DASHBOARD_URI%
Source example%CURRENT_DASHBOARD_URI%
Target example%2Fgdc%2Fmd%2Fe863ii0azrnng2zt4fuu81ifgqtyeoj21%2Fobj%2F1952

CURRENT_DASHBOARD_TAB_URI

DescriptionThe identifier of the currently selected dashboard tab
Can be used inEmbedded web content widgets only
Syntax%CURRENT_DASHBOARD_TAB_URI%
Source example%CURRENT_DASHBOARD_TAB_URI%
Target example85f6945b672d

CURRENT_USER_EMAIL_MD5

DescriptionThe MD5-hashed email address of the current user
Can be used inEmbedded web content widgets only
Syntax%CURRENT_USER_EMAIL_MD5%
Source example%CURRENT_USER_EMAIL_MD5%
Target example02b658338e9d004709a94c8b3b46f01b3

DATE_FILTER_VALUE

DescriptionThe value that is currently selected in a date filter
Can be used inEmbedded web content widgets and text boxes
Syntax

%DATE_FILTER_VALUE({date_attribute_identifier},FROM|TO)%

  • {date_attribute_identifier} is the identifier of the date attribute that is used in the associated date filter.
  • FROM|TO is the time keyword that 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).
Source example%DATE_FILTER_VALUE(closed.date,FROM)%
Target example2010-10-28

FILTER_VALUE

Description

The URI of the value that is currently selected in an attribute filter (in encoded format)

This macro returns a single filter value and does not support multiple values selected in the filter simultaneously.

Can be used inEmbedded web content widgets only
Syntax

%FILTER_VALUE({attribute_identifier})%

{attribute_identifier} is the identifier of the attribute that is used in the associated attribute filter.

Source example%FILTER_VALUE(attr.education)%
Target example%2Fgdc%2Fmd%2Fe863ii0azrnng2zt4fuu81ifgqtyeoj21%2Fobj%2F263%2Felements%3Fid%3D30

FILTER_TITLE

Description

The value that is currently selected in an attribute filter

If multiple values are selected in the attribute filter, the values are returned separated by comma.

Can be used inEmbedded web content widgets and text boxes
Syntax

%FILTER_TITLE({attribute_identifier})%

{attribute_identifier} is the identifier of the attribute that is used in the associated attribute filter.

Source example%FILTER_TITLE(attr.education)%
Target exampleConsulting, Tech, Telecom

VARIABLE_VALUE

Description

The value that is currently selected in a variable filter

  • If multiple (up to 15) values are selected in the variable filter, the values are returned separated by comma.
  • If all values are selected in the variable filter, the macro returns All.
Can be used inEmbedded web content widgets only
Syntax

%VARIABLE_VALUE({variable_identifier})%

{variable_identifier} is the identifier of the variable that is used in the associated variable filter.

Source example

https://s3.amazonaws.com/gd-images.gooddata.com/customtext/magic.html?text=%VARIABLE_VALUE(assNNkQ0ZefWf)%

Use the URL of the GoodData's Amazon S3 bucket and not your project URL when using the VARIABLE_VALUE macro.

Target exampleConsulting, Tech, Telecom

URL_PARAM

Description

The value of a URL parameter in the current dashboard URL

This macro could be useful when your dashboard is externally filtered by HTTP parameter filters and contains embedded web content that you want to filter by the same values. To pass the parameter filter values through to the embedded web content, add the macro to the code in the embedded web content widget. Once the widget is saved, the macro is dynamically replaced by the current value of the parameter from the dashboard URL.

Can be used inEmbedded web content widgets and text boxes
Syntax

%URL_PARAM({url_parameter_name})%

{url_parameter_name} is the name of the URL parameter.

Source example%URL_PARAM(project)%
Target exampleSales_Management
Powered by Atlassian Confluence and Scroll Viewport.