DashboardTranslation | 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

This type extends the Metadata metadata type and inherits its fullName field. The ability to translate dashboard labels is part of the Translation Workbench.

Declarative Metadata File Suffix and Directory Location

Local translations are stored in a file with a format of lang.translation, where lang is the translation language. A sample file name for Jananese translations is ja.translation.

Dashboard translations are stored in the translations folder in the corresponding package directory.

Version

DashboardTranslation components are available in API version 67.0 and later.

Fields

Field	Field Type	Description
description	string	The translated description for dashboard.
label	string	The translated label for dashboard.
name	string	Required. The translated name for dashboard.

Declarative Metadata Sample Definition

This sample XML definition shows a DashboardTranslation for the testDashboardFolder/TestDashboard dashboard in Japanese. The name and location of the file containing this definition would be translations/ja.translation

1<?xml version="1.0" encoding="UTF-8"?>
2<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
3  <dashboards>
4        <name>TestDashboardFolder/TestDashboard</name>
5        <label>テスト コンポーネント</label>
6        <description>テスト コンポーネント 説明</description>
7  </dashboards>
8</Translations>

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>ja</members>
5    <name>Translations</name>
6  </types>
7  <version>v67.0</version>
8</Package>

The following is an example of the TestDashboard dashboard the translation is referencing.

1<?xml version="1.0" encoding="UTF-8"?>
2<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
3  <backgroundEndColor>#FFFFFF</backgroundEndColor>
4  <backgroundFadeDirection>Diagonal</backgroundFadeDirection>
5  <backgroundStartColor>#FFFFFF</backgroundStartColor>
6  <dashboardType>LoggedInUser</dashboardType>
7  <description>Test Dashboard Description</description>
8  <leftSection>
9  <columnSize>Medium</columnSize>
10  <components>
11  <chartAxisRange>Auto</chartAxisRange>
12  <componentType>Bar</componentType>
13  <displayUnits>Auto</displayUnits>
14  <footer>Component Footer</footer>
15  <header>Component Header</header>
16  <report>TestReportFolder/TestReport</report>
17  <sortBy>RowLabelAscending</sortBy>
18  <title>TestComponent</title>
19  </components>
20  </leftSection>
21  <rightSection>
22  <columnSize>Medium</columnSize>
23  </rightSection>
24  <textColor>#000000</textColor>
25  <title>Test Dashboard Title</title>
26  <titleColor>#000000</titleColor>
27  <titleSize>12</titleSize>
28</Dashboard>

Wildcard Support in the Manifest File

This metadata type doesn’t support 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.