AnalyticsDatasetDefinition

Represents the datasets used for analytics, such as those in CRM Analytics and Tableau.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

AnalyticsDatasetDefinition components have the suffix .analyticsDatasetDefinition and are stored in the analyticsDatasetDefinitions folder.

Version

AnalyticsDatasetDefinition components are available in API version 65.0 and later.

Special Access Rules

You must enable the Loyalty Analytics permission in your org to access this metadata.

Fields

Field Name	Field Type	Description
`datasetCategory`	string	Required. The type of metric that the dataset supports.
`datasetName`	string	Required. Name of the dataset.
`masterLabel`	string	Required. A user-friendly name for the analytics dataset definition, which is defined when the metadata component is created.
`usageCategory`	string	Required. The category of usage that uniquely identifies an agent topic.

Declarative Metadata Sample Definition

The following is an example of an AnalyticsDatasetDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticsDatasetDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <datasetCategory>1</datasetCategory>
4    <datasetName>analytics</datasetName>
5    <masterLabel>sample</masterLabel>
6    <usageCategory>PromotionPerformanceInsights</usageCategory>
7</AnalyticsDatasetDefinition>

The following is an example package.xml that references the previous definition.

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <members>*</members>
4        <name>AnalyticsDatasetDefinition</name>
5    </types>
6    <version>[ftest]</version>
7</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.