AnalyticsWorkspace | Metadata API Developer Guide

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

AnalyticsWorkspace components have the suffix .analtyicsWorkspace and are stored in the analyticsWorkspaces folder.

Version

AnalyticsWorkspace components are available in API version 64 and later.

Fields

Field Name	Description
description	Field Type string Description The workspace description.
masterLabel	Field Type string Description Required. The name of the workspace.
workspaceAssetRelationships	Field Type AnalyticsWorkspaceAsset[] Description The workspace assets associated with the workspace. A workspace has 1 or more assets.

AnalyticsWorkspaceAsset

Represents a Tableau Next analytics asset.

Field Name	Description
asset	Field Type string Description Required. The name of workspace asset
assetType	Field Type AnalyticsWorkspaceAssetType (enumeration of type string) Description Required. The workspace asset type Values are: `AnalyticsDashboard` (Tableau Next Dashboard) `AnalyticsVisualization` (Tableau Next Visualization) `MktCalculatedInsightObject` (Data Cloud Calculated Insight Object) `MktDataLakeObject` (Data Cloud Data Lake Object) `MktDataModelObject` (Data Cloud Data Model Object) `SemanticModel` (Semantic Model)
assetUsageType	Field Type AnalyticsWorkspaceAssetUsageType (enumeration of type string) Description Required. The workspace asset usage type. Values are: `Created` `Referenced`
workspace	Field Type string Description Required. The workspace the asset belongs to.

Declarative Metadata Sample Definition

The following is an example of an AnalyticsWorkspace component.

1<?xml version="1.0" encoding="UTF-8"?>
2  <AnalyticsWorkspace xmlns="http://soap.sforce.com/2006/04/metadata">
3  <description>An example for Analytics Workspace</description>
4  <masterLabel>Analytics Workspace</masterLabel>
5  <workspaceAssetRelationships>
6  	  <asset>My Test Dashboard</asset>
7  	  <assetType>AnalyticsDashboard</assetType>
8  	  <assetUsageType>Created</assetUsageType>
9  	  <workspace>Analytics Workspace</workspace>
10  </workspaceAssetRelationships>
11</AnalyticsWorkspace>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3  <types>
4    <members>*</members>
5    <name>AnalyticsWorkspace</name>
6  </types>
7  <version>64.0</version>
8</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.