AnalyticsVisualization

Represents a Tableau Next visualization.

Parent Type

This type extends Metadata and inherits its fields.

File Suffix and Directory Location

AnalyticsVisualization components have the suffix .uaviz and are stored in the analyticsVisualizations folder.

Version

Introduced in API version 64.0.

Limits

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

Fields

actions

Type: AnalyticsAssetAction[]
Required: No
Description: The actions for the visualization. A visualization has 0 or more actions.

analyticsWorkspace

Type: string
Required: Yes
Description: Required.

The Tableau Next workspace the visualization belongs to.

creationSource

Type: AnalyticsVizCreationSource
Required: No
Description: The creation source for the visualization.

dataSource

Type: string
Required: Yes
Description: Required.

The data source for the visualization.

description

Type: string
Required: No
Description: The description for the visualization.

fields

Type: AnalyticsVizField[]
Required: No
Description: A list of data fields for the visualization. A visualization has 0 or more fields.

lastDraftModifiedDate

Type: dateTime
Required: No
Description: The date and time the workspace draft was last modified.

lastPublishedDate

Type: dateTime
Required: No
Description: The date and time the workspace was last published.

masterLabel

Type: string
Required: Yes
Description: Required.

The name of the visualization.

templateAssetSourceName

Type: string
Required: No
Description: If the visualization was created from a template, the name of the source visualization in the template.

templateSource

Type: string
Required: No
Description: If the visualization was created from a template, the name of the source template.

version

Type: double
Required: No
Description: The API version of the visualization.

views

Type: AnalyticsVizViewDef[]
Required: No
Description: A list of views for the visualization. A visualization has 0 or more views.

visualSpecification

Type: base64Binary
Required: Yes
Description: Required.

The visual specification for the visualization.

workspaceAssetRelationships

Type: AnalyticsWorkspaceAsset[]
Required: No
Description: A list of analytics assets in the workspace this visualization is associated with. A visualization has 0 or more workspace asset relationships.

AnalyticsVizField Type

Represents a data field in a visualization.

Fields

adHocCalc

Type: string
Required: No
Description: The expression to do an ad-hoc calculation with.

analyticsVizVersion

Type: string
Required: No
Description: The version of the visualization the field is associated with.

computeUsing

Type: string
Required: No
Description: The expression to compute the field value with.

displayCategory

Type: VisualizationFieldDisplayCategoryType (enumeration of type string)
Required: No
Description: The display category type for the visualization field.

Values are:
Possible values:
- Continuous
- Discrete

fieldKey

Type: string
Required: Yes
Description: Required.

The key for the field.

fieldName

Type: string
Required: No
Description: The name of the field.

function

Type: VisualizationFieldFunctionType (enumeration of type string)
Required: No
Description: The function type of the visualization field.

Values are:
Possible values:
- Attr
- Avg
- Count
- CountD
- DatePartDay
- DatePartHour
- DatePartMinute
- DatePartMonth
- DatePartQuarter
- DatePartSecond
- DatePartWeek
- DatePartWeekDay
- DatePartYear
- DateTruncDay
- DateTruncHour
- DateTruncMinute
- DateTruncMonth
- DateTruncQuarter
- DateTruncSecond
- DateTruncWeek
- DateTruncYear
- FiscalDatePartMonth
- FiscalDatePartQuarter
- FiscalDatePartWeek
- FiscalDatePartYear
- FiscalDateTruncMonth
- FiscalDateTruncQuarter
- FiscalDateTruncWeek
- FiscalDateTruncYear
- Max
- Mdy
- Median
- Min
- My
- Stdev
- Stdevp
- Sum
- UserAgg
- Var
- Varp

hierarchyLevel

Type: int
Required: No
Description: The hierarchy level for the field.

hierarchyName

Type: string
Required: No
Description: The hierarchy name for the field.

label

Type: string
Required: No
Description: The label for the field.

latitudeOrY

Type: string
Required: No
Description: The latitude or Y value for the field.

longitudeOrX

Type: string
Required: No
Description: The longitude or X value for the field.

objectName

Type: string
Required: No
Description: The name of the data source object for the field.

positional

Type: base64binary
Required: No
Description: The positional data for the field.

REMOVED in v68.0.

positionName

Type: string
Required: No
Description: The position name for the field.

quickTableCalc

Type: string
Required: No
Description: The expression to do a quick table calculation with.

role

Type: VisualizationFieldRoleType (enumeration of type string)
Required: No
Description: The role type of the visualization field.

Values are:
Possible values:
- Dimension
- Measure

type

Type: VisualizationFieldType (enumeration of type string)
Required: No
Description: The type of the visualization field.

Values are:
Possible values:
- Field
- MapPosition
- MeasureNames
- MeasureValues

AnalyticsVizViewDef Type

Represents a view definition for a Tableau Next visualization.

Fields

analyticsVizVersion

Type: string
Required: No
Description: The version of the visualization the view is associated with.

fullName

Type: string
Required: Yes
Description: Required.

The full name of the view definition.

isOriginal

Type: boolean
Required: Yes
Description: Required.

Indicates whether the view is original (true) or not (false).

masterLabel

Type: string
Required: Yes
Description: Required.

The name of the view definition.

version

Type: double
Required: No
Description: The API version of the visualization view.

viewSpecification

Type: string
Required: No
Description: The specification for the view definition.

Declarative Metadata Sample Definition

The following is an example of an AnalyticsVisualization component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticsVisualization xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3  <analyticsWorkspace>My_Workspace</analyticsWorkspace>
4  <description>A visualization</description>
5  <dataSource>My_Semantic_Model</dataSource>
6  <fields>
7    <displayCategory>Discrete</displayCategory>
8    <fieldKey>Field1</fieldKey>
9    <fieldName>Lead_Source18</fieldName>
10    <objectName>Opportunity_Home</objectName>
11    <role>Dimension</role>
12     <type>Field</type>
13  </fields>
14  <fields>
15    <fieldKey>Field2</fieldKey>
16    <displayCategory>Continuous</displayCategory>
17    <fieldName>Amount</fieldName>
18    <function>Sum</function>
19    <objectName>Opportunity_Home</objectName>
20    <role>Measure</role>
21    <type>Field</type>
22  </fields>
23  <views>
24    <fullName>default</fullName>
25    <masterLabel>My_Visualization_default</masterLabel>
26    <viewSpecification>
27      {&quot;filters&quot;:[{&quot;fieldKey&quot;:&quot;Field1&quot;,&quot;filterInfos&quot;:[{&quot;isCustom&quot;:false,&quot;isExcludes&quot;:false,&quot;type&quot;:&quot;In&quot;,&quot;useAll&quot;:false,&quot;values&quot;:[&quot;NewBusiness&quot;]},{&quot;includeAllValuesWhenEmpty&quot;:true,&quot;isExcludes&quot;:false,&quot;operator&quot;:&quot;Contains&quot;,&quot;type&quot;:&quot;WildCard&quot;,&quot;value&quot;:&quot;&quot;}],&quot;isContext&quot;:false}],&quot;sorts&quot;:[{&quot;byField&quot;:&quot;Field2&quot;,&quot;fieldKey&quot;:&quot;Field1&quot;,&quot;order&quot;:&quot;Ascending&quot;,&quot;type&quot;:&quot;Nested&quot;}]}</viewSpecification>
28    <isOriginal>true</isOriginal>
29  </views>
30  <masterLabel>My_Visualization</masterLabel>
31  <version>64.0</version>
32  <templateSource></templateSource>
33  <templateAssetSourceName></templateAssetSourceName>
34  <workspaceAssetRelationships>
35    <asset xsi:nil="true"/>
36    <assetType>AnalyticVisualization</assetType>
37    <assetUsageType>Created</assetUsageType>
38    <workspace>My_Workspace</workspace>
39  </workspaceAssetRelationships>
40</AnalyticsVisualization>

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

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

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!