WaveDataset Metadata Type Guide

Architectural Overview#

The WaveDataset metadata type represents a curated analytical data container within CRM Analytics. Datasets in CRM Analytics are highly compressed, column-oriented inverted-index data stores engineered to execute complex multi-dimensional queries across millions of records in sub-second response times.

From a metadata and DevOps architecture standpoint, a WaveDataset component specifies the architectural container for the dataset: its developer name, user-facing label, organizational application folder, and optional templating bindings. It does not contain the physical data rows or edgemart files. Instead, the data layer is populated asynchronously through data sync routines, recipes (WaveRecipe), dataflows (WaveDataflow), or the external data upload API.

Architects managing multi-org release strategies must understand this metadata versus data boundary to avoid creating empty dataset shells in test environments that cause dashboard queries to fail.

Directory and File Suffix#

In Salesforce DX project source structure, WaveDataset components reside in the wave/ directory and use the .wds-meta.xml file suffix:

• Source File Path: force-app/main/default/wave/<DatasetName>.wds-meta.xml

force-app/
└── main/
    └── default/
        └── wave/
            ├── Global_Sales_Metrics.wds-meta.xml
            └── Service_Operations_Store.wds-meta.xml

Key Metadata Fields#

The .wds-meta.xml XML manifest exposes the following configuration fields:

Declarative XML Examples#

Complete WaveDataset Descriptor (wave/Global_Sales_Metrics.wds-meta.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<WaveDataset xmlns="http://soap.sforce.com/2006/04/metadata">
    <application>Global_Commercial_Intelligence</application>
    <description>Consolidated global sales dataset aggregating opportunity history, lead progression, and quota attainment.</description>
    <masterLabel>Global Sales Metrics</masterLabel>
</WaveDataset>

Manifest Definition (package.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Global_Commercial_Intelligence</members>
        <name>WaveApplication</name>
    </types>
    <types>
        <members>Global_Sales_Metrics</members>
        <name>WaveDataset</name>
    </types>
    <version>68.0</version>
</Package>

Retrieval and Deployment#

Retrieving Datasets with Salesforce CLI#

Retrieve the dataset metadata descriptor from your connected development environment:

# Retrieve a single WaveDataset definition
sf project retrieve start --metadata "WaveDataset:Global_Sales_Metrics"

# Retrieve all datasets alongside their parent application containers
sf project retrieve start --metadata "WaveApplication,WaveDataset"

Deploying across Release Pipelines#

Deploy the dataset metadata into your testing sandboxes or production org:

# Validate dataset deployment in staging
sf project deploy validate \
    --metadata "WaveDataset:Global_Sales_Metrics" \
    --target-org staging-sandbox

# Deploy the dataset into production
sf project deploy start \
    --metadata "WaveDataset:Global_Sales_Metrics" \
    --target-org production-org

Querying Dataset Records via Tooling API#

Inspect deployed dataset definitions and identify internal storage identifiers using the Tooling API:

sf data query --use-tooling-api --query \
    "SELECT Id, DeveloperName, MasterLabel, FolderId, CreatedDate, LastModifiedDate FROM WaveDataset WHERE DeveloperName = 'Global_Sales_Metrics'"

Architect Deployment Best Practices & Gotchas#

Frequently asked questions

Does deploying a WaveDataset component migrate underlying record rows?

No, deploying WaveDataset only provisions the metadata container and folder reference. Data rows must be populated by running a recipe, dataflow, or CSV upload in the target org.

Where are WaveDataset components stored in the project structure?

WaveDataset components are stored under the wave directory in your Salesforce DX project using the wds-meta.xml file naming convention.

Why does WaveDataset deployment fail with missing application errors?

The application element points to a parent WaveApplication developer name. The referenced WaveApplication must exist in the target org or be included in the deployment manifest.

How does WaveDataset link with WaveXmd metadata?

WaveXmd provides extended metadata customization such as custom labels, colors, and number formatting for dimensions and measures defined in the corresponding WaveDataset.