Xmd Resource

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

• LWC — lightning/analyticsWaveApi getXmd()
• LWC — lightning/analyticsWaveApi updateXmd()

The following JSON shows a PUT request to update measures in the User Xmd. The PUT request cannot be used to update System or Main Xmd types.

Xmd​Date​Representation

Property Name	Type	Description	Filter Group and Version	Available Version
alias	String	The alias of the Date column.	Small, 36.0	36.0
compact	Boolean	Indicates whether the date should be displayed as compact or not.	Small, 36.0	36.0
description	String	The description of the Date column.	Small, 36.0	36.0
fields	Xmd​Date​Field​Representation	The formatting information for the date fields.	Small, 36.0	36.0
first​Day​Of​Week	Integer	Denotes the first day of the week.	Small, 36.0	36.0
fiscal​Month​Offset	Integer	The offset number of months for the fiscal year in relation to the calendar year.	Small, 36.0	36.0
format	String	The format for date field.	Small, 53.0	53.0
fully​Qualified​Name	String	The fully qualified name of the date.	Small, 39.0	39.0
is​Converted​Date​Time	Boolean	Indicates if the DateTime type is from timezone auto conversion or not.	Small, 44.0	44.0
is​Year​End​Fiscal​Year	Boolean	Indicates if the year end is the fiscal year or not.	Small, 36.0	36.0
label	String	The label of the Date column.	Small, 36.0	36.0
show​In​Explorer	Boolean	Indicates 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
type	Connect​Wave​Date​Type	The Date type. Valid values are: Date DateOnly DateTime	Small, 43.0	43.0

Xmd​Date​Field​Representation

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	The number of days that have elapsed since January 1, 1970 (midnight UTC).	Small, 36.0	36.0
epoch​Second	String	The 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	The month number in fiscal year. Corresponds to _Month_Fiscal in datasets.	Small, 36.0	36.0
fiscal​Quarter	String	The quarter number in fiscal year. Corresponds to _Quarter_Fiscal in datasets.	Small, 36.0	36.0
fiscal​Week	String	The 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	The number of hours. If the date contains no hours, value is '0.' Corresponds to _Hour in datasets.	Small, 36.0	36.0
minute	String	The number of minutes. If the date contains no minutes, value is '0.' Corresponds to _Minute in datasets.	Small, 36.0	36.0
month	String	The month number in calendar year. Corresponds to _Month is datasets.	Small, 36.0	36.0
quarter	String	The quarter number in calendar year. Corresponds to _Quarter in datasets.	Small, 36.0	36.0
second	String	The number of seconds. If the date contains no seconds, value is '0.' Corresponds to _Second in datasets.	Small, 36.0	36.0
week	String	The 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​Representation

Property Name	Type	Description	Filter Group and Version	Available Version
conditional​Formatting	Conditional​Formatting​Property​Representation	The conditional formatting for a dimension.	Small, 42.0	42.0
custom​Actions	Xmd​Dimension​Custom​Action​Representation	The custom actions linked to this dimension.	Small, 36.0	36.0
custom​Actions​Enabled	Boolean	Indicates whether the dimension has custom actions enabled or not.	Small, 36.0	36.0
default​Action	String	The default action for the dimension.	Small, 50.0	50
field	String	The field name of the dimension (used in queries).	Small, 36.0	36.0
label	String	The 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 record from 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	Indicates whether to 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​Representation[]	Any 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[]	An 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​Representation" []	The 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	Indicates if the Salesforce actions menu is enabled 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	Indicates 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​Custom​Action​Representation

Property Name	Type	Description	Filter Group and Version	Available Version
icon	String	The icon for the custom action.	Small, 36.0	36.0
method	String	The method for the custom action.	Small, 36.0	36.0
target	String	The target for the custom action.	Small, 36.0	36.0
tooltip	String	The tooltip for the custom action.	Small, 36.0	36.0
url	String	The URL for the custom action.	Small, 36.0	36.0

Xmd​Dimension​Member​Representation

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​Representation

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​Representation

Property Name	Type	Description	Filter Group and Version	Available Version
conditional​Formatting	Conditional​Formatting​Property​Representation	The conditional formatting for the measure.	Small, 42.0	42.0
field	String	The identifier (API name) for the dataset field.	Small, 36.0	36.0
format	Xmd​Measure​Format​Representation	The format details for the measure.	Small, 36.0	36.0
label	String	The 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	Indicates 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​Representation

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
delimiters	Numeric​Separators​Representation	The separators for the thousands and decimal places in the format.	Small, 48.0	48.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​Representation

Property Name	Type	Description	Filter Group and Version	Available Version
id	String	The ID of the org.	Small, 36.0	36.0
instance​Url	String	The org’s My Domain login URL in the format https://MyDomainName.my.salesforce.com.	Small, 36.0	36.0
label	String	The display name for the Salesforce org. Can be up to 40 characters.	Small, 36.0	36.0