Analytics Extended Metadata (XMD) Developer Guide

Extended Metadata (XMD) Overview
Basic Structure of the XMD JSON File
Packaging Considerations for XMD
Configure the XMD for a Dataset
Format Dataset Fields and Field Values with XMD
Extended Metadata (XMD) Reference
Dates in XMD
Dimensions and Derived Dimensions in XMD
Measures and Derived Measures in XMD
Organizations in XMD
ShowDetailsDefaultFields in XMD
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Dimensions and Derived Dimensions in XMD

You can add an action menu to a dimension value in Analytics lens and dashboard charts and tables. Users can then open a record and perform record-level actions. The available XMD parameters are the same for dimensions and derived dimensions.

This XMD snippet shows the parameters used with dimensions.

The dimensions and derived dimensions sections can have the following parameters.
Parameter Description
description

Description of the dataset field, no more than 1,000 characters.

Example: "description": "Region tracks where the sale was made."
field Identifier for the dataset field, which is the API name.
label

Display name for the dataset field, up to 40 characters.

Example: "label": "Sales Manager"
linkTemplateEnabled (Boolean) Indicates whether to display the link to open a Salesforce record or URL. If false or not set, the menu doesn’t display the Open Record link
linkTemplate

The URL to open when the user clicks the link in the actions menu, up to 255 characters. This setting overrides the default URL link, which is "/{{row.recordIdField}}". The default locates the Salesforce record with the record ID specified in the recordIdField XMD parameter.

To open a Salesforce record in a multi-org environment, enter {{instanceUrl}} to populate the org URL specified in the XMD organizations section.

Example: "linkTemplate": "/{{row.dimensionNameId}}"
linkTooltip

The tooltip that a dashboard viewer sees when hovering over the link in a CRM Analytics lens or dashboard.

Example: "linkTooltip": "Click to open the record"
members
Array of display customizations for specific values of a dataset field. For example, for the Country field, change the label from USA to United States. And change the color for this value in a chart to blue.

When you change the label, the new label appears only in the UI. You can’t use the label in queries, such as a query filter. Best practice is to modify the actual field values when you create the dataset.

Note

Example:
recordIdField The dataset field that contains the record ID of the Salesforce object that you want to perform the action on.
recordOrganizationField The dataset field that contains the Salesforce org ID used to apply record-level actions on a record from a multi-org environment. Analytics uses the org ID to look up the org URL in the XMD organizations section of the XMD.
recordDisplayFields

Array of dataset fields to help a dashboard viewer identify a Salesforce record when multiple records match the action. For each field, specify its API name. The fields appear in the order in which they are listed in the array.

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. In this scenario, the user is given a choice of associated records in a modal. This example specifies the record fields to display.

Custom menu modal
salesforceActionsEnabled

(Boolean) Indicates whether the Salesforce actions menu appears on the field. If false or not set, the menu doesn’t display any actions.

Example: "salesforceActionsEnabled": true
salesforceActions

Array of 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.

Example:
showInExplorer

(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, you can still use the field for SAQL queries, manually adding it in JSON, and accessing it using the Analytics REST API.

Example: "showInExplorer": true

For more information, see Perform Actions on a Salesforce Record from Analytics.