Loading

Extended Metadata (XMD) validation rules and errors

Дата публикации: Jul 11, 2024
Описание

Extended metadata (XMD) 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 shows the modified format.

Extended Metadata Validation

During operations that update dataset structure, user-generated Extended Metadata (User XMD) definitions for impacted datasets will be validated. For each validation rule, a corresponding set of errors exists if the rule is violated.
When reviewing XMD for errors, compare the error to the related rule and ensure your XMD adheres to the rule.

NOTE: If any part of an XMD definition file is invalid, none of the customizations in that definition will be applied. The validation errors must be corrected for customizations to apply to visualizations based on that dataset.

Correcting XMD Validation errors

Follow these steps to troubleshoot the situation:

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

Решение

XMD Validation Rules and Related Errors

 
RuleError Message
Dates Must Have Unique AliasFound a date with no 'alias' specified.
╙►Found multiple dates with the same 'alias' value: [alias]
Derived Dimension Custom Actions Have Mandatory FieldsFound a Custom Action in a derived dimension [derived-dimension-name] which does not have 'name' set.
╙►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 DimensionsFound 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 FieldsFound a Member in Derived Dimension [derived-measure-name] which does not have 'member' set.);
╙►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 DimensionsFound 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 DimensionsFound 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 FieldsFound a Salesforce Action in a derived dimension [derived-dimension-name] which does not have 'name' set.
╙►Found a Salesforce Action in a derived dimension [derived-dimension-name] which does not have 'enabled' set.
Derived Dimensions Have Unique FieldFound a derived dimension with no 'field' specified.
╙►Found multiple derived dimensions with the same 'field' value: [fieldName]
Derived Measure Field Names Do Not Exist In System MeasuresFound a Derived Measure which has the same field name as a non-derived Measure: [fieldName]
Derived Measures Have Unique FieldFound a derived measure with no 'field' specified.
╙►Found multiple derived measures with the same 'field' value: fieldName]
Dimension Custom Actions Have Mandatory FieldsFound a Custom Action in a dimension [dimension-name] which does not have 'name' set.
╙►Found a Custom Action in a dimension [dimension-name] which does not have 'enabled' set.
Dimension Fields Are Subset Of System FieldsCannot override 'dimensions' when the System XMD has none.
╙►Found Dimensions in User XMD which are not present in System XMD: fieldsInUserWhichArentInSystem
Dimension Members Have Mandatory FieldsFound a Member in Dimension [dimension-name] which does not have 'member' set.
╙►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 DimensionsFound 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 DimensionsFound a dimension [dimension-name] with a recordIdField [recordIdField] which does not reference a valid dimension or derived dimension.
Dimension Salesforce Actions Have Mandatory FieldsFound a Salesforce Action in a dimension [dimension-name] which does not have 'name' set.
╙►Found a Salesforce Action in a dimension [dimension-name] which does not have 'enabled' set.
Dimensions Have Field And Are UniqueFound a dimension with no 'field' specified.
╙►Found multiple dimensions with the same 'field' value: fieldName
Measure Fields Are Subset Of System FieldsCannot override 'measures' when the System XMD has none.
╙►Found Measures in User XMD which are not present in System XMD: fieldsInUserWhichArentInSystem
Measures Have Field And Are UniqueFound a measure with no 'field' specified.
╙►Found multiple measures with the same 'field' value: fieldName
New Dates Have Mandatory FieldsFound a Date [alias] in user which does not exist in system and is missing the required 'fields' entry.
╙►Found a Date [alias] in user which does not exist in system and is missing the required 'year' entry in 'fields'.
╙►Found a Date [alias] in user which does not exist in system and is missing the required 'month' entry in 'fields'.
╙►Found a Date [alias] in user which does not exist in system and is missing the required 'day' entry in 'fields'.
Organizations Have Actual OrgIdsFound an Organization which does not have a valid 'id' [orgId].
Organizations Have Mandatory FieldsFound an Organization which does not have 'id' set to a value.
╙►Found an Organization which does not have 'label' set to a value.
╙►Found an Organization which does not have 'instanceUrl' set to a value.
Show Details Default Fields Are Valid FieldsFound Dimension and/or Measures in User XMD.showDetailsDefaultFields which are not valid: fieldsInUserWhichArentValid
Дополнительные ресурсы

XMD Developer Guide

Номер статьи базы знаний

000383919

 
Загрузка
Salesforce Help | Article