AnalyticsWorkspace

Represents a Tableau Next workspace.

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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 64.0.

Limits 

DefinitionLimit
The maximum number of AnalyticsWorkspace components in a single deploy operation.50
The maximum number of AnalyticsWorkspace components in a single retrieve operation.100
The maximum number of AnalyticsWorkspace components across all deploy operations in a 24-hour window.100
The maximum number of AnalyticsWorkspace components across all retrieve operations in a 24-hour window.200

Fields 

description 

  • Type: string
  • Required: No
  • Description: The workspace description.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the workspace.

workspaceAssetRelationships 

  • Type: AnalyticsWorkspaceAsset[]
  • Required: No
  • Description: The workspace assets associated with the workspace. A workspace has 1 or more assets.

AnalyticsWorkspaceAsset Type 

Represents a Tableau Next analytics asset.

Fields 

asset 

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of workspace asset

assetType 

  • Type: AnalyticsWorkspaceAssetType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The workspace asset type

    Values are:

  • Possible values:

    • AnalyticsDashboard — (Tableau Next Dashboard)
    • AnalyticsVisualization — (Tableau Next Visualization)
    • MktCalculatedInsightObject — (Data 360 Calculated Insight Object)
    • MktDataConnection — (Data 360 Connection)
    • MktDataLakeObject — (Data 360 Data Lake Object)
    • MktDataModelObject — (Data 360 Data Model Object)
    • SemanticModel — (Semantic Model)

assetUsageType 

  • Type: AnalyticsWorkspaceAssetUsageType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The workspace asset usage type.

    Values are:

  • Possible values:

    • Created
    • Referenced

metadataSourceType 

  • Type: AnalyticsWorkspaceAssetMetadataSourceType (enumeration of type string)

  • Required: No

  • Description: The workspace asset metadata source type.

    Values are:

  • Possible values:

    • Promoted
    • Reused

workspace 

  • Type: string

  • Required: Yes

  • 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  	  <metadataSourceType>Promoted</metadataSourceType>
10  	  <workspace>Analytics Workspace</workspace>
11  </workspaceAssetRelationships>
12</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.