WaveXmd

Represents the WaveXmd object in the Analytics application.

This type extends Metadata and inherits its fields.

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

Introduced in API version 39.0.

• Type: string
• Required: No
• Introduced: API version 43.0
• Description: The name of the Analytics application the XMD is associated with.

• Type: string
• Required: Yes
• Description: Required. Specifies the dataset associated with this XMD.

• Type: string
• Required: No
• Description: The name of the connector source for the dataset.

• Type: string
• Required: No
• Description: Specifies the fully qualified name of the dataset version associated with this XMD.

• Type: WaveXmdDate[]
• Required: No
• Description: List of dates, with formatting information.

• Type: WaveXmdDimension[]
• Required: No
• Description: List of dimensions, with formatting information.

• Type: WaveXmdMeasure[]
• Required: No
• Description: List of measures, with formatting information.

• Type: WaveXmdOrganization[]
• Required: No
• Description: List of organizations, for multi-organization support.

• Type: string
• Required: No
• Description: The origin of the dataset version.

• Type: string (enumeration of type string)
• Required: No
• Description: The XMD type. Available in API version 43.0 and later.
• Possible values:
  • System
  • User
  • Main
  • Asset

• Type: string (enumeration of type string)
• Required: No
• Description: The visualization behavior for Analytics assets. Available in API version 43.0 and later.
• Possible values:
  • dashboard
  • lens

WaveXmdDate represents a date.

• Type: string
• Required: Yes
• Description: Required. Alias of the Date column.

• Type: boolean
• Required: No
• Description: Indicates whether the date is displayed in compact form (true) or not (false).

• Type: string
• Required: No
• Description: The day field.

• Type: string
• Required: No
• Description: The epoch day field.

• Type: string
• Required: No
• Description: The epoch second field.

• Type: string
• Required: No
• Description: The fiscal month field.

• Type: string
• Required: No
• Description: The fiscal quarter field.

• Type: string
• Required: No
• Description: The fiscal week field.

• Type: string
• Required: No
• Description: The fiscal year field.

• Type: string
• Required: No
• Description: The full year field.

• Type: string
• Required: No
• Description: The hour field.

• Type: string
• Required: No
• Description: The minute field.

• Type: string
• Required: No
• Description: The month field.

• Type: string
• Required: No
• Description: The quarter field.

• Type: string
• Required: No
• Description: The second field.

• Type: string
• Required: No
• Description: The week field.

• Type: string
• Required: No
• Description: The year field.

• Type: string
• Required: No
• Description: The description of the date column.

• Type: int
• Required: Yes
• Description: Required. Represents the first day of the week.

• Type: int
• Required: Yes
• Description: Required. Offset number of months for the fiscal year in relation to the calendar year.

• Type: boolean
• Required: No
• Description: Indicates whether the year end is the fiscal year (true) or not (false).

• Type: string
• Required: No
• Description: The label of the date column.

• Type: boolean
• Required: No
• Description: Indicates whether the date is displayed in the explorer (true) or not (false).

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The type of date.
• Possible values:
  • Date — A legacy date type. Available when the time zone isn’t 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 represents a dimension.

• Type: WaveXmdFormattingProperty[]
• Required: No
• Introduced: API version 43.0
• Description: The conditional formatting property for the dimension.

• Type: WaveXmdDimensionCustomAction[]
• Required: No
• Description: Custom actions linked to this dimension.

• Type: boolean
• Required: No
• Description: Indicates whether the dimension has custom actions enabled (true) or not (false).

• Type: string
• Required: No
• Description: The format used for a date that is a dimension.

• Type: string
• Required: No
• Description: The default action assigned to a dimension. An action for a dimension can be openSfdcRecord, openActionsMenu, none, or a valid API name with dot notation like Global.LogACall or FeedItem.Post.

• Type: string
• Required: No
• Description: The description of the dimension.

• Type: string
• Required: Yes
• Description: Required. The field name of the dimension (used in queries).

• Type: string
• Required: No
• Description: The fully qualified name of the dimension.

• Type: string
• Required: No
• Description: The image template.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the dimension is derived (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether the dimension is multi-value (true) or not (false).

• Type: string
• Required: No
• Description: The label for the dimension.

• Type: string
• Required: No
• Description: The template for formatting a link.

• Type: boolean
• Required: No
• Description: Indicates whether the dimension has link templates enabled (true) or not (false).

• Type: string
• Required: No
• Description: The tooltip to be displayed for links.

• Type: WaveXmdDimensionMember[]
• Required: No
• Description: The member overrides for a dimension.

• Type: string
• Required: No
• Description: The origin of this dimension.

• Type: WaveXmdRecordDisplayLookup[]
• Required: No
• Description: Ordered list of dimensions. The list defines the default order in which to display the dimensions in the user interface.

• Type: string
• Required: No
• Description: The record ID for this dimension.

• Type: string
• Required: No
• Description: The record organization ID for this dimension.

• Type: WaveXmdDimensionSalesforceAction[]
• Required: No
• Description: Salesforce actions linked to this dimension.

• Type: boolean
• Required: No
• Description: Indicates whether the dimension has Salesforce actions enabled (true) or not (false).

• Type: int
• Required: No
• Description: Default order in which to show the dimensions in the user interface.

• Type: boolean
• Required: No
• Description: Indicates whether the dimension is displayed in the explorer (true) or not (false).

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdDimensionCustomAction represents a custom action in a dimension.

• Type: string
• Required: Yes
• Description: Required. The name of this custom action.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the action is enabled for a specific dimension (true) or not (false).

• Type: string
• Required: No
• Description: The icon for the action.

• Type: string
• Required: No
• Description: The method for the action.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

• Type: string
• Required: No
• Description: The target for the action.

• Type: string
• Required: No
• Description: The tooltip for the action.

• Type: string
• Required: No
• Description: The URL for the action.

WaveXmdDimensionMember represents a dimension.

• Type: string
• Required: No
• Description: The color for the member.

• Type: string
• Required: No
• Description: The label for the member.

Multi-line text isn’t supported

• Type: string
• Required: Yes
• Description: Required. The member value.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdDimensionSalesforceAction represents an action in a dimension.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the action is enabled for a specific dimension (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The name of the action.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdFormatttingBin represents an XMD formatting bin for conditional formatting.

• Type: string
• Required: Yes
• Description: Required. The formatting bin.

• Type: string
• Required: Yes
• Description: Required. The format value for the bin.

• Type: string
• Required: Yes
• Description: Required. The label for the bin.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdFormattingPredicate represents an XMD formatting predicate for conditional formatting.

• Type: string
• Required: Yes
• Description: Required. The format value for the predicate.

• Type: string
• Required: Yes
• Description: Required. The operator for the predicate.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

• Type: string
• Required: Yes
• Description: Required. The value for the predicate.

WaveXmdFormattingProperty represents an XMD formatting property for conditional formatting.

• Type: WaveXmdFormattingBin[]
• Required: No
• Description: The formatting bins for this property.

• Type: WaveXmdFormattingPredicate[]
• Required: No
• Description: The formatting predicates for this property.

• Type: string
• Required: Yes
• Description: Required. The property name.

• Type: string
• Required: Yes
• Description: Required. The reference field for this property.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

• Type: string
• Required: Yes
• Description: Required. The property type.

WaveXmdMeasure represents a measure.

• Type: WaveXmdFormattingProperty[]
• Required: No
• Introduced: API version 43.0
• Description: The conditional formatting for the measure.

• Type: WaveXmdMeasure[]
• Required: No
• Description: The list of currency formats for multiple currencies. Use this field to set the format for each currency used in the dataset.

• Type: string
• Required: No
• Description: The default currency code for the dataset.

• Type: string
• Required: No
• Description: The format used for a date that is a measure.

• Type: string
• Required: No
• Description: The description of the measure.

• Type: string
• Required: Yes
• Description: Required. The field name of the measure (used in queries).

• Type: string
• Required: No
• Description: The original (XMD 1.1) format array as a single string.

• Type: int
• Required: No
• Description: The number of digits displayed after the decimal place.

• Type: string
• Required: No
• Introduced: API version 48.0
• Description: The custom separator for the decimal place.

• Type: boolean
• Required: No
• Description: Indicates whether to display negative numbers with parentheses, rather than a minus sign (true) or not (false).

• Type: string
• Required: No
• Description: The prefix placed before the field value.

• Type: string
• Required: No
• Description: The suffix placed after the field value.

• Type: string
• Required: No
• Introduced: API version 48.0
• Description: The custom separator for the thousands place.

• Type: string
• Required: No
• Description: The unit string for the measure. For example, ‘cm’.

• Type: double
• Required: No
• Description: The multiplier for the unit.

• Type: string
• Required: No
• Description: The fully qualified name of the measure.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the measure is derived (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether multiple currencies are available for this dataset (true) or not (false).

• Type: string
• Required: No
• Description: The label for the measure.

• Type: string
• Required: No
• Description: The origin of the measure.

• Type: int
• Required: No
• Description: Default order in which to show the measures in the user interface.

• Type: boolean
• Required: No
• Description: Indicates whether the measure is displayed in the explorer (true) or not (false).

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdOrganization represents a Salesforce organization.

• Type: string
• Required: Yes
• Description: Required. The instance URL for the organization.

• Type: string
• Required: Yes
• Description: Required. The label for the organization.

• Type: string
• Required: Yes
• Description: Required. The ID of the organization.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

WaveXmdDimensionRecordDisplayLookup represents a record display field.

• Type: string
• Required: Yes
• Description: Required. The field to display.

• Type: int
• Required: Yes
• Description: Required. The index value the system assigns to indicate where the item appears in a list.

The following is an example of a WaveXmd component for an Asset XMD belonging to a dashboard.