CRM Analytics: Extended Metadata (XMD) Dataset Validation Rules and Error Messages

Overview

Extended Metadata (XMD) in CRM Analytics (formerly known as Einstein Analytics and Tableau CRM) enables you to customize the formatting of dataset fields and their values in CRM Analytics dashboards and lenses. If you modify the XMD for a dataset, every UI visualization that uses the dataset reflects the modified format.

Extended Metadata Validation

During operations that update dataset structure, user-generated Extended Metadata (User XMD) definitions for impacted datasets are validated. For each validation rule, a corresponding set of error messages exists if the rule is violated. When reviewing XMD for errors, compare the error message to the related validation rule and ensure your XMD definition adheres to the rule.
Important: If any part of an XMD definition file is invalid, none of the customizations in that definition are applied. All validation errors must be corrected before customizations take effect in visualizations based on that dataset.

Correcting XMD Validation Errors

Follow these steps to troubleshoot XMD validation errors:

Review the Fields panel while exploring the dataset, or retrieve the user XMD definition from the dataset's edit screen.
Review the parameters associated with the affected dimension or measure to determine what is missing or needs correction. In the Fields panel, the impacted measure or dimension may be marked with a warning flag. A tooltip contains more details about that field.
Make the correction in the XMD syntax. If the Fields panel is used to correct the issue, the errorMessage parameter is automatically cleaned up. If editing the JSON definition directly, remove the errorMessage parameter and its associated value from the XMD definition, then upload the corrected file.
Validation is performed when Save (in the Fields panel) or Update Dataset (in the Edit screen) is clicked. Any failures appear in an error message.

XMD Validation Rules and Related Error Messages

The following table lists all XMD validation rules and their corresponding error messages. Where a rule has more than one error condition, the additional error rows are labeled as "Continued rule" for clarity.

Rule	Error Message
Dates Must Have Unique Alias	Found a date with no 'alias' specified.
Dates Must Have Unique Alias (continued)	Found multiple dates with the same 'alias' value: [alias]
Derived Dimension Custom Actions Have Mandatory Fields	Found a Custom Action in a derived dimension [derived-dimension-name] which does not have 'name' set.
Derived Dimension Custom Actions Have Mandatory Fields (continued)	Found a Custom Action in a derived dimension [derived-dimension-name] which does not have 'enabled' set.
Derived Dimension Field Names Do Not Exist In System Dimensions	Found a Derived Dimension which has the same field name as a non-derived Dimension: [derived-dimension-name]
Derived Dimension Link Template Must Start with /, http://, https://	'linkTemplate' [linkTemplate] is invalid.
Derived Dimension Members Have Mandatory Fields	Found a Member in Derived Dimension [derived-measure-name] which does not have 'member' set.
Derived Dimension Members Have Mandatory Fields (continued)	Found a Member [member-name] in Derived Dimension [derived-measure-name] which does not have 'color' or 'label' set. At least one of these fields must have a value.
Derived Dimension Record Display Fields Reference Measures Or Dimensions	Found a derived dimension [derived-dimension-name] with a recordDisplayField [recordDisplayField] which does not reference a valid dimension, derived dimension, measure or derived measure.
Derived Dimension Record Id Fields Reference Actual Dimensions	Found a derived dimension [derived-dimension-name] with a recordIdField [recordDisplayField] which does not reference a valid dimension or derived dimension.
Derived Dimension Salesforce Actions Have Mandatory Fields	Found a Salesforce Action in a derived dimension [derived-dimension-name] which does not have 'name' set.
Derived Dimension Salesforce Actions Have Mandatory Fields (continued)	Found a Salesforce Action in a derived dimension [derived-dimension-name] which does not have 'enabled' set.
Derived Dimensions Have Unique Field	Found a derived dimension with no 'field' specified.
Derived Dimensions Have Unique Field (continued)	Found multiple derived dimensions with the same 'field' value: [fieldName]
Derived Measure Field Names Do Not Exist In System Measures	Found a Derived Measure which has the same field name as a non-derived Measure: [fieldName]
Derived Measures Have Unique Field	Found a derived measure with no 'field' specified.
Derived Measures Have Unique Field (continued)	Found multiple derived measures with the same 'field' value: [fieldName]
Dimension Custom Actions Have Mandatory Fields	Found a Custom Action in a dimension [dimension-name] which does not have 'name' set.
Dimension Custom Actions Have Mandatory Fields (continued)	Found a Custom Action in a dimension [dimension-name] which does not have 'enabled' set.
Dimension Fields Are Subset Of System Fields	Cannot override 'dimensions' when the System XMD has none.
Dimension Fields Are Subset Of System Fields (continued)	Found Dimensions in User XMD which are not present in System XMD: fieldsInUserWhichArentInSystem
Dimension Members Have Mandatory Fields	Found a Member in Dimension [dimension-name] which does not have 'member' set.
Dimension Members Have Mandatory Fields (continued)	Found a Member [member-name] in Dimension [dimension-name] which does not have 'color' or 'label' set. At least one of these fields must have a value.
Dimension Record Display Fields Reference Measures Or Dimensions	Found a dimension [dimension-name] with a recordDisplayField [recordDisplayField] which does not reference a valid dimension, derived dimension, measure or derived measure.
Dimension Record Id Fields Reference Actual Dimensions	Found a dimension [dimension-name] with a recordIdField [recordIdField] which does not reference a valid dimension or derived dimension.
Dimension Salesforce Actions Have Mandatory Fields	Found a Salesforce Action in a dimension [dimension-name] which does not have 'name' set.
Dimension Salesforce Actions Have Mandatory Fields (continued)	Found a Salesforce Action in a dimension [dimension-name] which does not have 'enabled' set.
Dimensions Have Field And Are Unique	Found a dimension with no 'field' specified.
Dimensions Have Field And Are Unique (continued)	Found multiple dimensions with the same 'field' value: fieldName
Measure Fields Are Subset Of System Fields	Cannot override 'measures' when the System XMD has none.
Measure Fields Are Subset Of System Fields (continued)	Found Measures in User XMD which are not present in System XMD: fieldsInUserWhichArentInSystem
Measures Have Field And Are Unique	Found a measure with no 'field' specified.
Measures Have Field And Are Unique (continued)	Found multiple measures with the same 'field' value: fieldName
New Dates Have Mandatory Fields	Found a Date [alias] in user which does not exist in system and is missing the required 'fields' entry.
New Dates Have Mandatory Fields (continued)	Found a Date [alias] in user which does not exist in system and is missing the required 'year' entry in 'fields'.
New Dates Have Mandatory Fields (continued)	Found a Date [alias] in user which does not exist in system and is missing the required 'month' entry in 'fields'.
New Dates Have Mandatory Fields (continued)	Found a Date [alias] in user which does not exist in system and is missing the required 'day' entry in 'fields'.
Organizations Have Actual OrgIds	Found an Organization which does not have a valid 'id' [orgId].
Organizations Have Mandatory Fields	Found an Organization which does not have 'id' set to a value.
Organizations Have Mandatory Fields (continued)	Found an Organization which does not have 'label' set to a value.
Organizations Have Mandatory Fields (continued)	Found an Organization which does not have 'instanceUrl' set to a value.
Show Details Default Fields Are Valid Fields	Found Dimension and/or Measures in User XMD.showDetailsDefaultFields which are not valid: fieldsInUserWhichArentValid

General Information

Required Cookies

Functional Cookies

Advertising Cookies