ReportTranslation | 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 report 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.

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

Version

ReportTranslation components are available in API version 67.0 and later.

Fields

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

Declarative Metadata Sample Definition

This sample XML definition shows a ReportTranslation for the testReportFolder/TestReport report 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  <reports>
4    <name>TestReportFolder/TestReport</name>
5    <label>テスト コンポーネント</label>
6    <description>テスト コンポーネント 説明</description>
7  </reports>
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 TestReport report the translation is referencing.

1<?xml version="1.0" encoding="UTF-8"?>
2<Report xmlns="http://soap.sforce.com/2006/04/metadata">
3    <columns>
4        <field>FIRST_NAME</field>
5    </columns>
6    <columns>
7        <field>LAST_NAME</field>
8    </columns>
9    <description>This is a test report description.</description>
10    <format>Tabular</format>
11    <name>TestReport</name>
12    <reportType>User</reportType>
13    <showDetails>true</showDetails>
14</Report>

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.