XMD Resource

For full details on XMD, refer to the Analytics Extended Metadata (XMD) Reference.

XMD Date

Property Name	Type	Description	Filter Group and Version	Available Version
alias	String	Alias of the Date column.	Small, 36.0	36.0
fields	XMD Date Field	Formatting information for the date fields.	Small, 36.0	36.0
firstDayOfWeek	Integer	What the first day of the week is.	Small, 36.0	36.0
fiscalMonthOffset	Integer	Offset number of months for the fiscal year in relation to the calendar year.	Small, 36.0	36.0
fullyQualifiedName	String	Fully qualified name of the date.	Small, 39.0	39.0
label	String	Label of the Date column.	Small, 36.0	36.0

XMD Date Field

Property Name	Type	Description	Filter Group and Version	Available Version
day	String	The day of the month.	Small, 36.0	36.0
epoch​Day	String	Number of days that have elapsed since January 1, 1970 (midnight UTC).	Small, 36.0	36.0
epoch​Second	String	Number of seconds that have elapsed since January 1, 1970 (midnight UTC). Corresponds to _sec_epoch in datasets.	Small, 36.0	36.0
fiscal​Month	String	Month number in fiscal year. Corresponds to _Month_Fiscal in datasets.	Small, 36.0	36.0
fiscal​Quarter	String	Quarter number in fiscal year. Corresponds to _Quarter_Fiscal in datasets.	Small, 36.0	36.0
fiscal​Week	String	Week number in fiscal year. Corresponds to _Week_Fiscal in datasets.	Small, 36.0	36.0
fiscal​Year	String	The Fiscal year. Corresponds to _Year_Fiscal in datasets.	Small, 36.0	36.0
full​Field	String	The full-field field.	Small, 36.0	36.0
hour	String	Number of hours. If the date contains no hours, value is '0.' Corresponds to _Hour in datasets.	Small, 36.0	36.0
minute	String	Number of minutes. If the date contains no minutes, value is '0.' Corresponds to _Minute in datasets.	Small, 36.0	36.0
month	String	Month number in calendar year. Corresponds to _Month is datasets.	Small, 36.0	36.0
quarter	String	Quarter number in calendar year. Corresponds to _Quarter in datasets.	Small, 36.0	36.0
second	String	Number of seconds. If the date contains no seconds, value is '0.' Corresponds to _Second in datasets.	Small, 36.0	36.0
week	String	Week number in calendar year. Corresponds to _Week in datasets.	Small, 36.0	36.0
year	String	The calendar year. Corresponds to _Year in datasets.	Small, 36.0	36.0

XMD Dimension

Property Name	Type	Description	Filter Group and Version	Available Version
field	String	The field name of the dimension (used in queries).	Small, 36.0	36.0
label	String	Display name for the dataset field. Can be up to 40 characters.	Small, 36.0	36.0
link​Template	String	The URL to open when the user clicks the link in the actions menu. Overrides the default URL link, which is"/{{row.recordIdField}}". The default finds the Salesforce record with the record ID specified in the recordIdField XMD parameter. Must be 255 characters or less. To open a Salesforce recordfrom a multi-org environment, enter {{instanceUrl}} to populate the org URL specified in the“organizations” section of the XMD. Example: "/{{row.dimensionNameId}}".	Small, 36.0	36.0
link​Template​Enabled	Boolean	Display the link to open a Salesforce record or URL. If set to false or not set, the menu doesn't display the Open Record link option.	Small, 36.0	36.0
link​Tool​tip	String	The tooltip that a dashboard viewer sees when they hover over the link in an Analytics lens or dashboard.	Small, 36.0	36.0
members	XMD Dimension Member[]	Customizations for specific values of the dataset fields. For example, for the "Country" field, change the label of the "USA" to "United States." And change the color for this value in a chart to blue. When you change the label, the new label only appears in the user interface. You can’t use the label in queries, like a query filter. For this, the best practice is to modify the field values when you create the dataset. Note	Small, 36.0	36.0
record​Display​Fields	String[]	Ordered list of dimensions and measures. These dataset fields are used to help a dashboard viewer identify a Salesforce record when multiple records match the action. For each field, specify its API name. In some instances, a dimension value is associated with multiple IDs and isn’t unique. For example, an opportunity with the name “acme” has multiple opportunity IDs (and records). But the action or link can only be directed to one record.	Small, 36.0	36.0
record​Id​Field	String	The dataset field that contains the record ID of the Salesforce object that you want to perform the action on.	Small, 36.0	36.0
record​Organization​Id​Field	String	The record organization ID for this dimension.	Small, 36.0	36.0
salesforce​Actions	XMD Dimension Salesforce Action[]	Actions that appear in the action menu. You can only add actions that are defined in the page layouts for the corresponding Salesforce object. If left blank, Analytics shows all actions.	Small, 36.0	36.0
salesforce​Actions​Enabled	Boolean	Enables a Salesforce actions menu to appear on the field. If set to false or not set, the menu doesn't display any actions.	Small, 36.0	36.0
show​In​Explorer	Boolean	Determines whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses. Even if showInExplorer is false, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API.	Small, 36.0	36.0

XMD Dimension Member

Property Name	Type	Description	Filter Group and Version	Available Version
color	String	The color for the member. For example, set to “Blue”.	Small, 36.0	36.0
label	String	The label for the member. For example, set to “United States”.	Small, 36.0	36.0
member	String	The member value. For example, set to “USA”.	Small, 36.0	36.0

XMD Dimension Salesforce Action

Property Name	Type	Description	Filter Group and Version	Available Version
enabled	Boolean	Indicates whether the action is enabled for a specific dimension.	Small, 36.0	36.0
name	String	The name of the action.	Small, 36.0	36.0

XMD Measure

Property Name	Type	Description	Filter Group and Version	Available Version
field	String	Identifier (API name) for the dataset field.	Small, 36.0	36.0
format	XMD Measure Format	The format details for the measure.	Small, 36.0	36.0
label	String	Display name for the dataset field. Can be up to 40 characters. For example, “Sales Amount".	Small, 36.0	36.0
show​In​Explorer	Boolean	Determines whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses. Even if showInExplorer is false, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API.	Small, 36.0	36.0

XMD Measure Format

Property Name	Type	Description	Filter Group and Version	Available Version
custom​Format	String	When customizing the display, you can add a prefix, suffix, grouping separator, decimal separator, and leading and trailing zeros. You can also configure the number of digits. You can include any characters in prefixes and suffixes, including minus signs or currency symbols. You can use the following symbols to specifying a format. 0. One digit. Use to add leading or trailing 0s. For example, if you apply custom format #,###.00 to 56375, the result is 56,375.00. #. Adds zero or one digit. Use to show digits when applicable. For example, if you apply custom format #,###.## to 56375.56, the result is 56,375.56. .(period). Symbol used as the decimal separator, like in the number 375.56. Analytics currently only supports the decimal symbol (.) as a decimal separator. ,(comma). Symbol used as the grouping separator, like in 56,375. Analytics currently only supports the comma symbol (,) as a grouping separator. Example: [\"-$#,###.00$\",1]	Small, 36.0	36.0
unit​Multiplier	Double	The multiplier for the unit. The multiplier changes a field’s values by the same factor—like multiplying by 100 to convert decimals to percents.The multiplier must be a positive number.	Small, 36.0	36.0

XMD Organization

Property Name	Type	Description	Filter Group and Version	Available Version
id	String	The ID of the organization.	Small, 36.0	36.0
instance​Url	String	URL of the Salesforce org. If a custom domain name is set up for the org, it’s the domain name for the org.	Small, 36.0	36.0
label	String	Display name for the Salesforce org. Can be up to 40 characters.	Small, 36.0	36.0