WaveXmd | Metadata API Developer Guide

File Suffix and Directory Location

WaveXmd components have the suffix .xmd and are stored in the wave folder.

Version

WaveXmd components are available in API version 39.0 and later.

Fields

Field Name	Field Type	Description
dataset	string	Specifies the dataset associated with this Xmd.
datasetConnector	string	The name of the connector source for the dataset.
datasetFullyQualifiedName	string	Specifies the fully qualified name of the dataset version associated with this Xmd.
dates	WaveXmdDate	List of dates, with formatting information.
dimensions	WaveXmdDimension	List of dimensions, with formatting information.
measures	WaveXmdMeasure	List of measures, with formatting information.
organizations	WaveXmdOrganization	List of organizations, for multi-organization support.
origin	string	The origin of the dataset version.

WaveXmdDate

WaveXmdDate represents a date.

Field	Field Type	Description
alias	string	Alias of the Date column.
compact	boolean	Whether the date should be displayed in compact form.
dateFieldDay	string	The day field.
dateFieldEpochDay	string	The epoch day field.
dateFieldEpochSecond	string	The epoch second field.
dateFieldFiscalMonth	string	The fiscal month field.
dateFieldFiscalQuarter	string	The fiscal quarter field.
dateFieldFiscalWeek	string	The fiscal week field.
dateFieldFiscalYear	string	The fiscal year field.
dateFieldFullYear	string	The full year field.
dateFieldHour	string	The hour field.
dateFieldMinute	string	The minute field.
dateFieldMonth	string	The month field.
dateFieldQuarter	string	The quarter field.
dateFieldSecond	string	The second field.
dateFieldWeek	string	The week field.
dateFieldYear	string	The year field.
description	string	The description of the date column.
firstDayOfWeek	int	Represents the first day of the week.
fiscalMonthOffset	int	Offset number of months for the fiscal year in relation to the calendar year.
isYearEndFiscalYear	boolean	Whether the year end is the fiscal year.
label	string	The label of the date column.
showInExplorer	boolean	Whether or not the date should be shown in the explorer.
sortIndex	int	Whether or not to sort.
type	string	The type of date. Values are: Date—A legacy date type. Available when the time zone is not enabled. DateOnly—A date type without an associated time. Available when the time zone is enabled. DateTime—A date type that contains both date and time parts. Available when the time zone is enabled.

WaveXmdDimension

WaveXmdDimension represents a dimension.

Field	Field Type	Description
customActions	WaveXmdDimensionCustomAction	Custom actions linked to this dimension.
customActionsEnabled	boolean	Indicates whether the dimension has custom actions enabled.
dateFormat	string	The format used for a date that is a dimension.
description	string	The description of the dimension.
field	string	The field name of the dimension (used in queries).
fullyQualifiedName	string	The fully qualified name of the dimension.
imageTemplate	string	The image template.
isDerived	boolean	Whether this is a derived dimension.
isMultiValue	boolean	Indicates whether the dimension is multi-value.
label	string	The label for the dimension.
linkTemplate	string	The template for formatting a link.
linkTemplateEnabled	boolean	Indicates whether the dimension has link templates enabled.
linkTooltip	string	The tooltip to be displayed for links.
members	WaveXmdDimensionMember	The member overrides for a dimension.
origin	string	The origin of this dimension.
recordDisplayFields	WaveXmdRecordDisplayLookup	Ordered list of dimensions. The list defines the default order in which to display the dimensions in the user interface.
recordIdField	string	The record ID for this dimension.
recordOrganizationIdField	string	The record organization ID for this dimension.
salesforceActions	WaveXmdDimensionSalesforceAction	Salesforce actions linked to this dimension.
salesforceActionsEnabled	boolean	Indicates whether the dimension has Salesforce actions enabled.
showDetailsDefaultFieldIndex	int	Default order in which to show the dimensions in the user interface.
showInExplorer	boolean	Indicates whether the dimension is displayed in the explorer.
sortIndex	int	Whether or not to sort.

WaveXmdDimensionCustomAction

WaveXmdDimensionCustomAction represents a custom action in a dimension.

Field	Field Type	Description
customActionName	string	The name of this custom action.
enabled	boolean	Indicates whether the action is enabled for a specific dimension.
icon	string	The icon for the action.
method	string	The method for the action.
sortIndex	int	Whether or not to sort.
target	string	The target for the action.
tooltip	string	The tooltip for the action.
url	string	The URL for the action.

WaveXmdDimensionMember

WaveXmdDimensionMember represents a dimension.

Field	Field Type	Description
color	string	The color for the member.
label	string	The label for the member.
member	string	The member value.
sortIndex	int	Whether or not to sort.

WaveXmdRecordDisplayLookup

WaveXmdDimensionRecordDisplayLookup represents a record display field.

Field	Field Type	Description
recordDisplayField	string	The field to display.

WaveXmdDimensionSalesforceAction

WaveXmdDimensionSalesforceAction represents an action in a dimension.

Field	Field Type	Description
enabled	boolean	Indicates whether the action is enabled for a specific dimension.
salesforceActionName	string	The name of the action.
sortIndex	int	Whether or not to sort.

WaveXmdMeasure

WaveXmdMeasure represents a measure.

Field	Field Type	Description
dateFormat	string	The format used for a date that is a measure.
description	string	The description of the measure.
field	string	The field name of the measure (used in queries).
formatCustomFormat	string	The original (XMD 1.1) format array as a single string.
formatDecimalDigits	int	The number of digits displayed after the decimal place.
formatIsNegativeParens	boolean	Indicates whether to display negative numbers with parentheses, rather than a minus sign.
formatPrefix	string	The prefix placed before the field value.
formatSuffix	string	The suffix placed after the field value.
formatUnit	string	The unit string for the measure. For example, 'cm'.
formatUnitMultiplier	double	The multiplier for the unit.
fullyQualifiedName	string	The fully qualified name of the measure.
isDerived	boolean	Whether this is a derived measure.
label	string	The label for the measure.
origin	string	The origin of the measure.
showDetailsDefaultFieldIndex	int	Default order in which to show the measures in the user interface.
showInExplorer	boolean	Indicates whether the measure is displayed in the explorer.
sortIndex	int	Whether or not to sort.

WaveXmdOrganization

WaveXmdOrganization represents a Salesforce organization.

Field	Field Type	Description
instanceUrl	string	The instance URL for the organization.
label	string	The label for the organization.
organizationIdentifier	string	The ID of the organization.
sortIndex	int	Whether or not to sort.