メタデータ API 開発者ガイド
jDashboard
ダッシュボードを表します。ダッシュボードは、総計値とパフォーマンスを一目で理解できるように表示されたデータの視覚的表現です。Metadata メタデータ型を拡張し、その fullName 項目を継承します。詳細は、Salesforce オンラインヘルプの「Salesforce Classic のアクセシビリティモードでのダッシュボードの編集」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ダッシュボードは、対応するパッケージディレクトリの dashboards ディレクトリに保存されます。ファイル名はダッシュボードのタイトルに一致し、拡張子は .dashboard です。
ダッシュボードの取得
package.xml ではダッシュボードにワイルドカード (*) 記号を使用できません。明示的な名前を package.xml に入力するためにダッシュボードのリストを取得するには、listMetadata() をコールし、DashboardFolder をデータ型として渡します。DashboardFolder は describeMetadata() ではデータ型として返されません。ダッシュボードは、inFolder の関連付けられている属性が true に設定された describeMetadata() から返されます。この属性が true に設定されている場合は、DashboardFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。
次の例では、package.xml 内のフォルダを示します。
バージョン
Dashboard コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
| 項目 | データ型 | 説明 |
|---|---|---|
| backgroundEndColor | string | 必須。ダッシュボードでは、グラフにグラデーションの色の変化を適用できます。この項目は、グラデーションの 2 つ目の色を定義し、backgroundStartColor は、最初の色を定義します。背景で単色を使用する場合、またはグラデーションの色の変化を使用しない場合は、この項目と backgroundStartColor に同じ色を選択してください。色は、16 進形式で表記されます (#FF6600 など)。 |
| backgroundFadeDirection | ChartBackgroundDirection (string 型の列挙) | 必須。backgroundStartColor 項目と backgroundEndColor 項目で定義される、グラデーションの色の変化の方向。有効な値は、次のとおりです。
|
| backgroundStartColor | string | 必須。ダッシュボードのグラフでのグラデーションの色の変化の開始色。詳細は、「backgroundEndColor」を参照してください。色は、16 進形式で表記されます (#FF6600 など)。 |
| dashboardFilters | DashboardFilters[] |
ダッシュボードの検索条件のリスト。 この項目は API バージョン 23.0 以降で使用できます。 |
| dashboardGridLayout | DashboardGridLayout |
含まれている DashboardGridComponent オブジェクトをリストし、ダッシュボードの列数を指定し、各ダッシュボードの行の高さをピクセル単位で設定します。 この項目は、API バージョン 35.0 以降で使用できます。 |
| dashboardType | DashboardType (string 型の列挙) |
ダッシュボードの表示設定を設定する方法を決定します。有効な値は、次のとおりです。
この項目は 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 型の列挙) | 棒グラフまたは折れ線グラフの手動または自動設定の軸範囲。有効���値は、次のとおりです。
|
| chartAxisRangeMax | double | 表示する最大軸範囲。これは、chartAxisRange 項目について manual の軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。 |
| chartAxisRangeMin | double | 表示する最小軸範囲。これは、chartAxisRange 項目について manual の軸範囲が選択された棒グラフと折れ線グラフにのみ適用されます。 |
| chartSummary | ChartSummary |
グラフデータの集計項目を指定します。isAutoSelectFromReport が false に設定されている場合は必須です。 この項目は API バージョン 25.0 以降で使用できます。 |
| componentType | DashboardComponentType (string 型の列挙) |
必須。ダッシュボードコンポーネントの種類。有効な値は、次のとおりです。
|
| dashboardFilterColumns | DashboardFilterColumns[] |
ダッシュボードの検索条件列のリスト。各レポートベースのコンポーネントには、検索条件が適用される列を定義するダッシュボード検索条件列が必要です。 この項目は API バージョン 23.0 以降で使用できます。 |
| dashboardTableColumn | DashboardTableColumn[] | カスタマイズされたダッシュボードテーブルコンポーネントの列のリストを表します。 |
| displayUnits | ChartUnits (string 型の列挙) | グラフの単位。有効な値は、次のとおりです。
|
| 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 型の列挙) | |
| 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
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 です。