ReferencedDashboard

Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.

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 

ReferencedDashboard components have the suffix .refdash and are stored in the wave folder.

Version 

Introduced in API version 57.0.

Special Access Rules 

To view referenced dashboards, you need the Enables Tableau Dashboards in CRM Analytics permission.

Fields 

application 

  • Type: string
  • Required: Yes
  • Description: Required. The internal name of the Analytics app.

description 

  • Type: string
  • Required: No
  • Description: The dashboard description that appears in the user interface.

embedUrl 

  • Type: string
  • Required: Yes
  • Description: Required. The URL to the referenced dashboard.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The dashboard name that appears in the user interface.

templateAssetSourceName 

  • Type: string
  • Required: No
  • Description: Links the dashboard to the template used to create it. Null for assets not created from a template.

visibility 

  • Type: string
  • Required: Yes
  • Description: The visibility of the dashboard. Valid values are: ALL and LIMITED.

Declarative Metadata Sample Definition 

The following is an example of a WaveDashboard component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ReferencedDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <application>my_app</application>
4    <masterLabel>ReferencedDashboard1</masterLabel>
5    <description>My Tableau Dashboard</description>
6    <embedUrl>https://public.tableau.com/views/Superstore_24/Overview</embedUrl>
7    <visibility>ALL</visibility>
8</ReferencedDashboard>

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.