Dashboard

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

ダッシュボードは、対応するパッケージディレクトリの dashboards ディレクトリに保存されます。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboard です。

ダッシュボードの取得

package.xml ではダッシュボードにワイルドカード (*) 記号を使用できません。明示的な名前を package.xml に入力するためにダッシュボードのリストを取得するには、listMetadata() をコールし、DashboardFolder をデータ型として渡します。DashboardFolder は describeMetadata() ではデータ型として返されません。ダッシュボードは、inFolder の関連付けられている属性が true に設定された describeMetadata() から返されます。この属性が true に設定されている場合は、DashboardFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。

次の例では、package.xml 内のフォルダを示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>MyDBFolder/MyDBName</members>
5        <name>Dashboard</name>
6    </types>
7    <types>
8        <members>MyDocumentFolder/MyDocumentName</members>
9        <name>Document</name>
10    </types>
11    <types>
12        <members>unfiled$public/MarketingProductInquiryResponse</members>
13        <members>unfiled$public/SalesNewCustomerEmail</members>
14        <name>EmailTemplate</name>
15    </types>
16    <types>
17        <members>MyReportFolder/MyReportName</members>
18        <name>Report</name>
19    </types>
20    <version>39.0</version>
21</Package>

バージョン

Dashboard コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

項目	データ型	説明
backgroundEndColor	string	必須。ダッシュボードでは、グラフにグラデーションの色の変化を適用できます。この項目は、グラデーションの 2 つ目の色を定義し、backgroundStartColor は、最初の色を定義します。背景で単色を使用する場合、またはグラデーションの色の変化を使用しない場合は、この項目と backgroundStartColor に同じ色を選択してください。色は、16 進形式で表記されます (#FF6600 など)。
backgroundFadeDirection	ChartBackgroundDirection (string 型の列挙)	必須。backgroundStartColor 項目と backgroundEndColor 項目で定義される、グラデーションの色の変化の方向。有効な値は、次のとおりです。 `diagonal` `leftToRight` `topToBottom`
backgroundStartColor	string	必須。ダッシュボードのグラフでのグラデーションの色の変化の開始色。詳細は、「backgroundEndColor」を参照してください。色は、16 進形式で表記されます (#FF6600 など)。
dashboardFilters	DashboardFilters[]	ダッシュボードの検索条件のリスト。この項目は API バージョン 23.0 以降で使用できます。
dashboardGridLayout	DashboardGridLayout	含まれている DashboardGridComponent オブジェクトをリストし、ダッシュボードの列数を指定し、各ダッシュボードの行の高さをピクセル単位で設定します。この項目は、API バージョン 35.0 以降で使用できます。
dashboardType	DashboardType (string 型の列挙)	ダッシュボードの表示設定を設定する方法を決定します。有効な値は、次のとおりです。 `SpecifiedUser` — すべてのユーザは、個々のセキュリティ設定に関係なく、runningUser 項目に指定された、1 人の特定の実行ユーザのアクセスレベルでデータを表示します。 `LoggedInUser` — 各ログインユーザは、個々のアクセスレベルに従ってデータを表示します。 `MyTeamUser` — マネージャは、ロール階層におけるその部下の視点でダッシュボードを参照するように選択できます。この値は、API バージョン 20.0 以降で使用できます。この項目は API バージョン 19.0 以降で使用できます。
description	string	ダッシュボードの説明。最大 255 文字です。
folderName	string	ダッシュボードが保存されるフォルダの名前。この項目は、API バージョン 35.0 以降で使用できます。
fullName	string	Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`create()`」を参照してください。この項目は、フォルダとダッシュボードのタイトルを指定します。たとえば、folderSales/California です。
isGridLayout	boolean	ダッシュボードが Lightning Experience レイアウトを使用するか (`true`)、否か (`false`) を指定します。 Lightning Experience では、サイズが複数の列と行にまたがったコンポーネントを含む 4 列以上のダッシュボードをサポートしています。この項目は、API バージョン 35.0 以降で使用できます。
leftSection	DashboardComponentSection	必須。ダッシュボードの左セクションまたは列。
middleSection	DashboardComponentSection	ダッシュボードの中央セクションまたは列。
rightSection	DashboardComponentSection	必須。ダッシュボードの右セクションまたは列。
runningUser	string	ダッシュボードに表示されるデータを決定するために使用されるロールと共有設定を所有するユーザのユーザ名。ダッシュボードをリリースするときに、この項目の値が定義されていないか有効なユーザに対応していない場合、項目にはリリースを実行するユーザのユーザ名が入力されます。ダッシュボードは常に特定のユーザのセキュリティ設定を使用して実行されるため、各ユーザのセキュリティ設定に関係なく、ダッシュボードを参照するすべてのユーザにまったく同一のデータが表示されます。機密データの不適切な開示を避けるには、適切なユーザにのみ表示されるフォルダにダッシュボードを保存します。ヒント
textColor	string	必須。ダッシュボードの各グラフのテキストの色。色は、16 進形式で表記されます (#FF6600 など)。
title	string	必須。ダッシュボードのタイトル。
titleColor	string	必須。各サッシュボードコンポーネントのタイトルの色。色は、16 進形式で表記されます (#FF6600 など)。
titleSize	int	必須。タイトルテキストの文字のサイズ。たとえば、12 という値は 12pt のテキストを示します。

DashboardComponentSection

DashboardComponentSection は、ダッシュボードの 1 つのセクションまたは列を表します。

項目	データ型	説明
columnSize	DashboardComponentSize (string 型の列挙)	必須。ダッシュボードの列のサイズ。有効な値についての詳細は、「DashboardComponentSize」を参照してください。
components	DashboardComponent[]	ダッシュボード列の DashboardComponent オブジェクトのリスト。

DashboardComponentSize

DashboardComponentSize は、異なるサイズカテゴリをリストする string 型の列挙です。有効な値のリストを下の表に示します。

列挙値	説明
medium	中サイズのコンポーネント。
narrow	最小サイズのコンポーネント。
wide	最大サイズのコンポーネント。

DashboardComponent

データを表示する異なるコンポーネントまたは要素のグループで構成されるダッシュボード。各コンポーネントは、経営指標または重要業績評価指標 (KPI) を表示するためのデータソースとして、カスタムレポートまたはカスタム Sコントロールを使用できます。複数のダッシュボードコンポーネントを作成し、最大 3 列のダッシュボード 1 つにすべてを表示できます。

項目	データ型	説明
chartAxisRange	ChartRangeType (string 型の列挙)	棒グラフまたは折れ線グラフの手動または自動設定の軸範囲。有効な値は、次のとおりです。 `auto` `manual`
chartAxisRangeMax	double	表示する最大軸範囲。これは、chartAxisRange 項目について `manual` の軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。
chartAxisRangeMin	double	表示する最小軸範囲。これは、chartAxisRange 項目について `manual` の軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。
chartSummary	ChartSummary	グラフデータの集計項目を指定します。isAutoSelectFromReport が `false` に設定されている場合は必須です。この項目は API バージョン 25.0 以降で使用できます。
componentType	DashboardComponentType (string 型の列挙)	必須。ダッシュボードコンポーネントの種類。有効な値は、次のとおりです。 `Bar` `BarGrouped` `BarStacked` `BarStacked100` `Column` `ColumnGrouped` `ColumnLine` `ColumnLineGrouped` `ColumnLineStacked` `ColumnLineStacked100` `ColumnStacked` `ColumnStacked100` `Donut` `Funnel` `Gauge` `Line` `lineCumulative` `LineGrouped` `lineGroupedCumulative` `Metric` `Pie` `Scatter` `ScatterGrouped` `Scontrol` `Table`
dashboardFilterColumns	DashboardFilterColumns[]	ダッシュボードの検索条件列のリスト。各レポートベースのコンポーネントには、検索条件が適用される列を定義するダッシュボード検索条件列が必要です。この項目は API バージョン 23.0 以降で使用できます。
dashboardTableColumn	DashboardTableColumn[]	カスタマイズされたダッシュボードテーブルコンポーネントの列のリストを表します。
displayUnits	ChartUnits (string 型の列挙)	グラフの単位。有効な値は、次のとおりです。 `Auto` `Integer` `Hundreds` `Thousands` `Millions` `Billions` `Trillions`
drillDownUrl	string	グラフで、ユーザがダッシュボードコンポーネントをクリックしたときに移動先となる URL を指定します。このオプションを使用して、別のダッシュボード、レポート、レコード詳細ページ、または Web インターフェースを使用するその他のシステムにユーザを送信します。この項目は、drillEnabled 項目と drillToDetailEnabled 項目より優先されます。
drillEnabled	boolean	ユーザがダッシュボードコンポーネントをクリックしたときに、完全なソースレポートまたは絞り込まれたソースレポートにユーザを移動するかどうかを指定します。完全なソースレポートにドリルするには `false` を設定し、ユーザがクリックした項目によって絞り込まれたソースレポートにドリルするには `true` を設定します。`true` に設定すると、ユーザは、個々のグループ、軸の値、または凡例のエントリをクリックできます。これは、drillToDetailEnabled 項目より優先されます。この項目は API バージョン 17.0 以降で使用できます。
drillToDetailEnabled	boolean	有効である場合、ユーザがテーブルまたはグラフのレコード名、レコード所有者、またはフィード投稿をクリックすると、レコード詳細ページに移動します。`true` に設定すると、ユーザは軸、凡例値、グラフ要素、およびテーブルエントリをクリックできます。drillDownUrl 項目と drillEnabled 項目は、この項目より優先されます。この項目は API バージョン 20.0 以降で使用できます。
enableHover	boolean	グラフにマウスを重ねたとき、値、表示ラベル、およびパーセントを表示するかどうかを指定します。詳細のフロート表示はグラフの種類によって異なります。パーセントは、円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。この項目は API バージョン 17.0 以降で使用できます。
expandOthers	boolean	合計の 3% 以下のグループをすべて 1 つの「その他」系列または区分グループにまとめるかどうかを指定します。円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。グラフにすべての値を個別に表示する場合は `true` を設定し、小さなグループを「その他」にまとめるには `false` に設定します。この項目は API バージョン 17.0 以降で使用できます。
footer	string	ダッシュボードコンポーネントの下部に表示されるフッター。最大 255 文字です。
gaugeMax	double	ゲージの最大値。ゲージは、ゴール達成までの距離を表示するために使用されます。自動車の速度計のようなものです。
gaugeMin	double	ゲージの最小値。
groupingColumn	string	データのグルーピングの基準となる項目を指定します。このデータは、縦棒グラフの場合は X 軸に、横棒グラフの場合は Y 軸に表示されます。この項目は API バージョン 25.0 以降で使用できます。
header	string	ダッシュボードコンポーネントの上部に表示されるヘッダー。最大 80 文字です。
indicatorBreakpoint1	double	ダッシュボードの indicatorMiddleColor と indicatorLowColor を区切る値。
indicatorBreakpoint2	double	ダッシュボードの indicatorHighColor と indicatorMiddleColor を区切る値。
indicatorHighColor	string	ゲージで高い数値の範囲を表す色。
indicatorLowColor	string	ゲージで低い数値の範囲を表す色。
indicatorMiddleColor	string	ゲージで中位の数値の範囲を表す色。
legendPosition	ChartLegendPosition (string 型の列挙)	グラフに対する凡例の位置。有効な値は、次のとおりです。 `Bottom` `OnChart` `Right`
maxValuesDisplayed	int	横棒グラフでの横軸、縦棒グラフでの縦軸、または積み上げ棒グラフでの選択した軸の上位グループに含める要素の最大数。たとえば、上位 5 名の営業担当者のみを表示する場合は、所有者別の合計商談額を表す商談レポートを作成し、この項目に「`5`」と入力します。
metricLabel	string	指標を説明した表示ラベル `metric` が componentType 項目の値である場合に関連します。
page	string	コンポーネントに関連付けられた Visualforce ページ。
pageHeightInPixels	int	Visualforce ページの表示の高さ (ピクセル単位)。
report	string	コンポーネントに関連付けられたレポートの名前。
scontrol	string	`scontrol` が componentType 項目の値である場合に、コンポーネントに関連付けられる Sコントロール。詳細は、Salesforce オンラインヘルプの「カスタム Sコントロールの定義」を参照してください。
scontrolHeightInPixels	int	Sコントロールの表示の高さ (ピクセル単位)。
showPercentage	boolean	円グラフ、ドーナツグラフ、およびじょうごグラフのゲージ、系列、および区分の領域にパーセント値を表示するか (`true`)、否か (`false`) を示します。
showPicturesOnCharts	boolean	ユーザまたはグループの名前項目によってソースレポートがグループ化されている横棒グラフコンポーネントに、最大 20 レコードの Chatter 写真を表示します。写真を含むレコードが 20 件より多くある場合は、写真ではなくレコード名が表示されます。写真を表示するには、[グルーピング表示] で `[なし]` に設定します。[ドリルダウン先] オプションを `[レコード詳細ページ]` に設定すると、写真をクリックしたときにユーザプロファイルやグループページに直接移動できます。写真を表示するには、Chatter を有効にする必要があります。組織の設定に応じて、テーブルやグラフで写真が表示されない場合があります。
showPicturesOnTables	boolean	ユーザまたはグループの名前項目によってソースレポートがグループ化されている横棒グラフコンポーネントに、最大 20 レコードの Chatter 写真を表示します。写真を含むレコードが 20 件より多くある場合は、写真ではなくレコード名が表示されます。写真を表示するには、[グルーピング表示] で `[なし]` に設定します。[ドリルダウン先] オプションを `[レコード詳細ページ]` に設定すると、写真をクリックしたときにユーザプロファイルやグループページに直接移動できます。写真を表示するには、Chatter を有効にする必要があります。組織の設定に応じて、テーブルやグラフで写真が表示されない場合があります。
showTotal	boolean	ゲージとドーナツグラフですべての系列の合計を表示するか (`true`)、否か (`false`) を示します。
showValues	boolean	グラフの個々のレコードまたはグループの値が表示されるか (`true`)、否か (`false`) を示します。
sortBy	DashboardComponentFilter (string 型の列挙)	ダッシュボードコンポーネントの並び替えオプション。
title	string	ダッシュボードコンポーネントのタイトル。最大 40 文字です。
useReportChart	boolean	ソースレポートに定義されたグラフをこの dashboard コンポーネントで使用するかどうかを指定します。ソースレポートのグラフの設定によって、ダッシュボードでのグラフの表示方法が決定します。また、ダッシュボードに定義したグラフ設定はすべて上書きされます。ソースレポートに組み合わせグラフを定義した場合、このオプションを使用して、このダッシュボードで組み合わせグラフを使用します。

DashboardFilters

DashboardFilters は、ダッシュボードの検索条件を表します。

項目	データ型	説明
dashboardFilterOptions	DashboardFilterOptions[]	[検索条件を追加] ダイアログの [検索条件オプション] セクションで選択できる項目のリスト。
name	string	必須。検索条件の表示ラベル。

DashboardFilterColumns

DashboardFilterColumns は、ダッシュボードの検索条件列を表します。

項目	データ型	説明
column	string	必須。検索条件のレポート列コード。

DashboardFilterOptions

DashboardFilterOptions は、ダッシュボードの検索条件オプションを表します。

項目	データ型	説明
operator	DashboardFilterOperation (string 型の列挙)	必須。この検索条件項目の絞り込み操作を表します。有効な値は、DashboardFilterOperation に列挙されています。この項目は API バージョン 24.0 以降で使用できます。 API バージョン 23.0 での有効な値は、FilterOperation に列挙されています。
value	string	必須。[検索条件を追加] ダイアログの [検索条件オプション] 領域の値。この項目は API バージョン 23.0 で使用できます。
values	string[]	必須。[検索条件を追加] ダイアログの [検索条件オプション] 領域の 1 つ以上の値。この項目は API バージョン 24.0 以降で使用できます。

DashboardFilterOperation

これは、ダッシュボードの絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。

equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes
between

"between" 演算子には、2 つのオペランドが必要です ("between MinimumValue, MaximumValue" など)。また、最小値にはその値自体が含まれますが、最大値にはその値自体は含まれません。その他すべてのダッシュボード絞り込み操作では、1 つのオペランドのみが必要です。
メモ

DashboardTableColumn

DashboardTableColumn は、ダッシュボードのカスタマイズされたテーブルコンポーネントの列を表します。

項目	データ型	説明
aggregateType	ReportSummaryType[] (string 型の列挙)	テーブル列の集計種別を指定します。
column	string	必須。テーブルで使用する列の表示ラベル。
showTotal	boolean	ダッシュボードテーブルに集計可能な各列の合計を表示します。この項目は API バージョン 19.0 以降で使用できます。
sortBy	DashboardComponentFilter (string 型の列挙)	ダッシュボードテーブルコンポーネントの並び替えオプション。テーブルあたり 1 つの列で並び替えます。

DashboardComponentFilter

DashboardComponentFilter は、ダッシュボードコンポーネントの並び替え値をリストする string 型の列挙です。有効な値は、次のとおりです。

列挙値	説明
RowLabelAscending	表示ラベルを基準にしてアルファベット順に並び替えます。
RowLabelDescending	表示ラベルを基準にしてアルファベット降順に並び替えます。
RowValueAscending	値を基準にして最小値から最大値の順に並び替えます。
RowValueDescending	値を基準にして最大値から最小値の順に並び替えます。

DashboardGridComponent

Lightning Experience には、サイズが複数の列と行にまたがったコンポーネントを含む 4 列以上のダッシュボードが備えられています。DashboardGridComponent は、指定されたダッシュボードコンポーネントの場所とサイズを指定します。

項目	データ型	説明
colSpan	int	必須。ダッシュボードコンポーネントの幅 (列単位)。たとえば、colSpan が 5 の場合、ダッシュボードコンポーネントは 5 列にまたがります。
columnIndex	int	必須。ダッシュボードコンポーネントが占める最も左の列。
dashboardComponent	DashboardComponent	必須。サイズ設定および配置中のダッシュボードコンポーネント。
rowIndex	int	必須。ダッシュボードコンポーネントが占める最も上の行。
rowSpan	int	必須。ダッシュボードコンポーネントの高さ (行単位)。

DashboardGridLayout

Lightning Experience には、サイズが複数の列と行にまたがったコンポーネントを含む 4 列以上のダッシュボードが備えられています。DashboardGridLayout では、含まれているダッシュボードコンポーネントをリストし、ダッシュボードの列数を指定し、各ダッシュボードの行の高さをピクセル単位で設定します。

項目	データ型	説明
dashboardGridComponents	DashboardGridComponent[]	ダッシュボードの DashboardGridComponent オブジェクトのリスト。
numberOfColumns	int	必須。ダッシュボードの列の合計数。
rowHeight	int	必須。各行の高さ (ピクセル単位)。

宣言的なメタデータの定義のサンプル — 条件設定済みダッシュボード

条件設定済みダッシュボードの XML 定義のサンプルを以下に示します。この例がサポートされているのは、API バージョン 24.0 以降です。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboard です。

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    <dashboardFilters>
7        <dashboardFilterOptions>
8            <operator>equals</operator>
9            <values>Media</values>
10        </dashboardFilterOptions>
11        <dashboardFilterOptions>
12            <operator>lessThan</operator>
13            <values>Working</values>
14        </dashboardFilterOptions>
15        <dashboardFilterOptions>
16            <operator>between</operator>
17            <values>ABC</values>
18            <values>XYZ</values>
19        </dashboardFilterOptions>
20        <name>Industry</name>
21    </dashboardFilters>
22    <dashboardFilters>
23        <dashboardFilterOptions>
24            <operator>equals</operator>
25            <values>Analyst,Partner</values>
26        </dashboardFilterOptions>
27        <dashboardFilterOptions>
28            <operator>startsWith</operator>
29            <values>Integrator</values>
30        </dashboardFilterOptions>
31        <name>Account Type</name>
32    </dashboardFilters>
33    <dashboardType>SpecifiedUser</dashboardType>
34    <leftSection>
35        <columnSize>Medium</columnSize>
36        <components>
37            <chartAxisRange>Auto</chartAxisRange>
38            <componentType>Bar</componentType>
39            <dashboardFilterColumns>
40                <column>INDUSTRY</column>
41            </dashboardFilterColumns>
42            <dashboardFilterColumns>
43                <column>TYPE</column>
44            </dashboardFilterColumns>
45            <displayUnits>Auto</displayUnits>
46            <drillEnabled>false</drillEnabled>
47            <drillToDetailEnabled>false</drillToDetailEnabled>
48            <enableHover>false</enableHover>
49            <expandOthers>false</expandOthers>
50            <legendPosition>Bottom</legendPosition>
51            <report>unfiled$public/SampleReportofAccounts</report>
52            <showPercentage>false</showPercentage>
53            <showPicturesOnCharts>false</showPicturesOnCharts>
54            <showValues>false</showValues>
55            <sortBy>RowLabelAscending</sortBy>
56            <useReportChart>false</useReportChart>
57        </components>
58    </leftSection>
59    <middleSection>
60        <columnSize>Medium</columnSize>
61        <components>
62            <chartAxisRange>Auto</chartAxisRange>
63            <componentType>Funnel</componentType>
64            <dashboardFilterColumns>
65                <column>ACCOUNT_INDUSTRY</column>
66            </dashboardFilterColumns>
67            <dashboardFilterColumns>
68                <column>ACCOUNT.TYPE</column>
69            </dashboardFilterColumns>
70            <displayUnits>Auto</displayUnits>
71            <drillEnabled>false</drillEnabled>
72            <drillToDetailEnabled>false</drillToDetailEnabled>
73            <enableHover>false</enableHover>
74            <expandOthers>false</expandOthers>
75            <legendPosition>Bottom</legendPosition>
76            <report>unfiled$public/SampleReportofCases</report>
77            <showPercentage>false</showPercentage>
78            <showValues>true</showValues>
79            <sortBy>RowLabelAscending</sortBy>
80            <useReportChart>false</useReportChart>
81        </components>
82    </middleSection>
83    <rightSection>
84        <columnSize>Medium</columnSize>
85        <components>
86            <chartAxisRange>Auto</chartAxisRange>
87            <componentType>Column</componentType>
88            <dashboardFilterColumns>
89                <column>INDUSTRY</column>
90            </dashboardFilterColumns>
91            <dashboardFilterColumns>
92                <column>ACCOUNT_TYPE</column>
93            </dashboardFilterColumns>
94            <displayUnits>Auto</displayUnits>
95            <drillEnabled>false</drillEnabled>
96            <drillToDetailEnabled>false</drillToDetailEnabled>
97            <enableHover>false</enableHover>
98            <expandOthers>false</expandOthers>
99            <legendPosition>Bottom</legendPosition>
100            <report>unfiled$public/SampleReportofOpportunities</report>
101            <showPercentage>false</showPercentage>
102            <showValues>false</showValues>
103            <sortBy>RowLabelAscending</sortBy>
104            <useReportChart>false</useReportChart>
105        </components>
106    </rightSection>
107    <runningUser>admin@TESTORGNUM</runningUser>
108    <textColor>#000000</textColor>
109    <title>My Dashboard</title>
110    <titleColor>#000000</titleColor>
111    <titleSize>12</titleSize>
112</Dashboard>

宣言的なメタデータの定義のサンプル — 条件設定解除されたダッシュボード

条件設定が解除されたダッシュボードの XML 定義のサンプルを次に示します。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboard です。

1<?xml version="1.0" encoding="UTF-8"?>
2<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
3    <backgroundEndColor>#FFFFFF</backgroundEndColor>
4    <backgroundFadeDirection>LeftToRight</backgroundFadeDirection>
5    <backgroundStartColor>#FFFFFF</backgroundStartColor>
6    <description>Dashboard with all possible chart types</description>
7    <leftSection>
8        <columnSize>Medium</columnSize>
9        <components>
10            <chartAxisRange>Auto</chartAxisRange>
11            <componentType>BarStacked100</componentType>
12            <displayUnits>Auto</displayUnits>
13            <drillEnabled>true</drillEnabled>
14            <enableHover>true</enableHover>
15            <report>testFolder/sourceRep</report>
16            <sortBy>RowLabelAscending</sortBy>
17        </components>
18        <components>
19            <componentType>Table</componentType>
20            <dashboardTableColumn>
21                <column>CLOSE_DATE</column>
22                <sortBy>RowLabelAscending</sortBy>
23            </dashboardTableColumn>
24            <dashboardTableColumn>
25                <aggregateType>Sum</aggregateType>
26                <column>AMOUNT</column>
27                <showTotal>true</showTotal>
28            </dashboardTableColumn>
29            <dashboardTableColumn>
30                <column>STAGE_NAME</column>
31            </dashboardTableColumn>
32            <dashboardTableColumn>
33                <column>PROBABILITY</column>
34                <aggregateType>Maximum</aggregateType>
35            </dashboardTableColumn>
36            <displayUnits>Integer</displayUnits>
37            <header>Opportunities Table</header>
38            <indicatorHighColor>#54C254</indicatorHighColor>
39            <indicatorLowColor>#C25454</indicatorLowColor>
40            <indicatorMiddleColor>#C2C254</indicatorMiddleColor>
41            <maxValuesDisplayed>10</maxValuesDisplayed>
42            <report>testFolder/sourceRep</report>
43        </components>
44        <components>
45            <chartAxisRange>Auto</chartAxisRange>
46            <componentType>Bar</componentType>
47            <displayUnits>Auto</displayUnits>
48            <drillEnabled>true</drillEnabled>
49            <enableHover>true</enableHover>
50            <report>testFolder/sourceRep</report>
51            <sortBy>RowLabelAscending</sortBy>
52        </components>
53        <components>
54            <chartAxisRange>Auto</chartAxisRange>
55            <componentType>Column</componentType>
56            <displayUnits>Auto</displayUnits>
57            <drillEnabled>true</drillEnabled>
58            <legendPosition>Bottom</legendPosition>
59            <report>testFolder/sourceRep</report>
60            <sortBy>RowLabelAscending</sortBy>
61            <useReportChart>true</useReportChart>
62        </components>
63        <components>
64            <chartAxisRange>Auto</chartAxisRange>
65            <componentType>Funnel</componentType>
66            <displayUnits>Auto</displayUnits>
67            <drillEnabled>true</drillEnabled>
68            <enableHover>true</enableHover>
69            <expandOthers>true</expandOthers>
70            <legendPosition>Bottom</legendPosition>
71            <report>testFolder/sourceRep</report>
72            <sortBy>RowLabelAscending</sortBy>
73        </components>
74    </leftSection>
75    <middleSection>
76        <columnSize>Medium</columnSize>
77        <components>
78            <chartAxisRange>Auto</chartAxisRange>
79            <componentType>ColumnStacked100</componentType>
80            <displayUnits>Auto</displayUnits>
81            <drillEnabled>true</drillEnabled>
82            <enableHover>true</enableHover>
83            <report>testFolder/sourceRep</report>
84            <sortBy>RowLabelAscending</sortBy>
85        </components>
86        <components>
87            <chartAxisRange>Auto</chartAxisRange>
88            <componentType>ColumnStacked</componentType>
89            <displayUnits>Auto</displayUnits>
90            <drillEnabled>true</drillEnabled>
91            <enableHover>true</enableHover>
92            <report>testFolder/sourceRep</report>
93            <sortBy>RowLabelAscending</sortBy>
94        </components>
95        <components>
96            <chartAxisRange>Auto</chartAxisRange>
97            <componentType>ColumnStacked</componentType>
98            <displayUnits>Auto</displayUnits>
99            <drillEnabled>true</drillEnabled>
100            <enableHover>true</enableHover>
101            <report>testFolder/sourceRep</report>
102            <sortBy>RowLabelAscending</sortBy>
103        </components>
104        <components>
105            <chartAxisRange>Auto</chartAxisRange>
106            <componentType>ColumnGrouped</componentType>
107            <displayUnits>Auto</displayUnits>
108            <drillEnabled>true</drillEnabled>
109            <enableHover>true</enableHover>
110            <report>testFolder/sourceRep</report>
111            <sortBy>RowLabelAscending</sortBy>
112        </components>
113        <components>
114            <chartAxisRange>Auto</chartAxisRange>
115            <componentType>Column</componentType>
116            <displayUnits>Auto</displayUnits>
117            <drillEnabled>true</drillEnabled>
118            <enableHover>true</enableHover>
119            <report>testFolder/sourceRep</report>
120            <sortBy>RowLabelAscending</sortBy>
121        </components>
122    </middleSection>
123    <rightSection>
124        <columnSize>Medium</columnSize>
125        <components>
126            <chartAxisRange>Auto</chartAxisRange>
127            <componentType>Bar</componentType>
128            <displayUnits>Auto</displayUnits>
129            <drillEnabled>true</drillEnabled>
130            <enableHover>true</enableHover>
131            <report>testFolder/sourceRep</report>
132            <sortBy>RowLabelAscending</sortBy>
133        </components>
134        <components>
135            <chartAxisRange>Auto</chartAxisRange>
136            <componentType>Pie</componentType>
137            <displayUnits>Auto</displayUnits>
138            <drillEnabled>true</drillEnabled>
139            <enableHover>true</enableHover>
140            <expandOthers>true</expandOthers>
141            <report>testFolder/sourceRep</report>
142            <sortBy>RowLabelAscending</sortBy>
143        </components>
144        <components>
145            <chartAxisRange>Auto</chartAxisRange>
146            <componentType>LineGroupedCumulative</componentType>
147            <displayUnits>Auto</displayUnits>
148            <drillEnabled>true</drillEnabled>
149            <enableHover>true</enableHover>
150            <report>testFolder/sourceRep</report>
151            <sortBy>RowLabelAscending</sortBy>
152        </components>
153        <components>
154            <chartAxisRange>Auto</chartAxisRange>
155            <componentType>LineGrouped</componentType>
156            <displayUnits>Auto</displayUnits>
157            <drillEnabled>true</drillEnabled>
158            <enableHover>true</enableHover>
159            <report>testFolder/sourceRep</report>
160            <sortBy>RowLabelAscending</sortBy>
161        </components>
162        <components>
163            <chartAxisRange>Auto</chartAxisRange>
164            <componentType>LineCumulative</componentType>
165            <displayUnits>Auto</displayUnits>
166            <drillEnabled>true</drillEnabled>
167            <enableHover>true</enableHover>
168            <report>testFolder/sourceRep</report>
169            <sortBy>RowLabelAscending</sortBy>
170        </components>
171        <components>
172            <chartAxisRange>Auto</chartAxisRange>
173            <componentType>Donut</componentType>
174            <displayUnits>Auto</displayUnits>
175            <drillEnabled>true</drillEnabled>
176            <enableHover>true</enableHover>
177            <expandOthers>true</expandOthers>
178            <report>testFolder/sourceRep</report>
179            <sortBy>RowLabelAscending</sortBy>
180        </components>
181    </rightSection>
182    <runningUser>admin@TESTORGNUM</runningUser>
183    <textColor>#000000</textColor>
184    <title>Db Title</title>
185    <titleColor>#000000</titleColor>
186    <titleSize>12</titleSize>
187</Dashboard>

宣言的なメタデータの定義のサンプル — isGridLayout が true である Lightning Experience ダッシュボード

isGridLayout が true である Lightning Experience ダッシュボードの XML 定義のサンプルを次に示します。この例がサポートされているのは、API バージョン 35.0 以降です。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboard です。

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>SpecifiedUser</dashboardType>
7    <gridLayout>
8        <dashboardGridComponents>
9            <colSpan>3</colSpan>
10            <columnIndex>0</columnIndex>
11            <dashboardComponent>
12                <autoselectColumnsFromReport>false</autoselectColumnsFromReport>
13                <chartAxisRange>Auto</chartAxisRange>
14                <chartSummary>
15                    <axisBinding>y</axisBinding>
16                    <column>RowCount</column>
17                </chartSummary>
18                <componentType>Donut</componentType>
19                <drillEnabled>false</drillEnabled>
20                <drillToDetailEnabled>false</drillToDetailEnabled>
21                <enableHover>false</enableHover>
22                <expandOthers>false</expandOthers>
23                <groupingColumn>TITLE</groupingColumn>
24                <legendPosition>Bottom</legendPosition>
25                <report>unfiled$public/lead_rpt</report>
26                <showPercentage>false</showPercentage>
27                <showTotal>false</showTotal>
28                <showValues>true</showValues>
29                <sortBy>RowLabelAscending</sortBy>
30                <useReportChart>false</useReportChart>
31            </dashboardComponent>
32            <rowIndex>0</rowIndex>
33            <rowSpan>3</rowSpan>
34        </dashboardGridComponents>
35        <dashboardGridComponents>
36            <colSpan>3</colSpan>
37            <columnIndex>0</columnIndex>
38            <dashboardComponent>
39                <autoselectColumnsFromReport>false</autoselectColumnsFromReport>
40                <chartAxisRange>Auto</chartAxisRange>
41                <chartSummary>
42                    <axisBinding>y</axisBinding>
43                    <column>RowCount</column>
44                </chartSummary>
45                <componentType>Pie</componentType>
46                <drillEnabled>false</drillEnabled>
47                <drillToDetailEnabled>false</drillToDetailEnabled>
48                <enableHover>false</enableHover>
49                <expandOthers>false</expandOthers>
50                <groupingColumn>TITLE</groupingColumn>
51                <legendPosition>Bottom</legendPosition>
52                <report>unfiled$public/lead_rpt</report>
53                <showPercentage>false</showPercentage>
54                <showValues>true</showValues>
55                <sortBy>RowLabelAscending</sortBy>
56                <useReportChart>false</useReportChart>
57            </dashboardComponent>
58            <rowIndex>3</rowIndex>
59            <rowSpan>3</rowSpan>
60        </dashboardGridComponents>
61        <dashboardGridComponents>
62            <colSpan>3</colSpan>
63            <columnIndex>0</columnIndex>
64            <dashboardComponent>
65                <autoselectColumnsFromReport>false</autoselectColumnsFromReport>
66                <chartAxisRange>Auto</chartAxisRange>
67                <chartSummary>
68                    <axisBinding>y</axisBinding>
69                    <column>RowCount</column>
70                </chartSummary>
71                <componentType>Column</componentType>
72                <drillEnabled>false</drillEnabled>
73                <drillToDetailEnabled>false</drillToDetailEnabled>
74                <enableHover>false</enableHover>
75                <expandOthers>false</expandOthers>
76                <groupingColumn>TITLE</groupingColumn>
77                <legendPosition>Bottom</legendPosition>
78                <report>unfiled$public/lead_rpt</report>
79                <showPercentage>false</showPercentage>
80                <showValues>false</showValues>
81                <sortBy>RowLabelAscending</sortBy>
82                <useReportChart>false</useReportChart>
83            </dashboardComponent>
84            <rowIndex>9</rowIndex>
85            <rowSpan>3</rowSpan>
86        </dashboardGridComponents>
87        <numberOfColumns>9</numberOfColumns>
88        <rowHeight>90</rowHeight>
89    </gridLayout>
90    <isGridLayout>true</isGridLayout>
91    <runningUser>admin@s1.com</runningUser>
92    <textColor>#000000</textColor>
93    <title>sfx</title>
94    <titleColor>#000000</titleColor>
95    <titleSize>12</titleSize>
96</Dashboard>

メタデータ API 開発者ガイド