拡張メタデータ (XMD) の概要
データセットの XMD を変更すると、そのデータセットを使用するすべての UI の視覚化に新しい形式が適用されます。次の事項を制御できます。
- 基準の形式
- ディメンションおよび基準の表示ラベル
- 基準のディメンションのグループ化
- 特定の項目の色
- 値テーブルに表示されるデフォルトの列
- ユーザインターフェースでのディメンションおよび基準の非表示
- ユーザが Salesforce オブジェクトのアクションを利用し、Salesforce および外部 Web サイトのレコードへのリンクをたどることができるカスタムメニュー
- 複数組織のデータセットの Salesforce レコードへのリンクがそのレコードの正しい組織インスタンスに解決できるようにする、URL への Salesforce 組織 ID の対応付け。
XMD ファイルは JSON 形式です。XMD ファイルにアクセスするには、対応するデータセットを編集します。[編集] ページから既存の XMD ファイルをダウンロードできます。
XMD の変更および更新についての情報は、XMD 2.0 セクションを参照して��ださい。
拡張メタデータの例
XMD ファイルの形式の例を次に示します。
1{
2 "formats": {
3 "measures": {
4 "Amount": [
5 "$#,##0.00",
6 1
7 ]
8 }
9 },
10 "hide_dimensions": [
11 "Owner-Email"
12 ],
13 "labels": {
14 "dimensions": {
15 "CloseDate": "Close Date GMT",
16 "CloseDate_Day": "Close Date Day",
17 "CloseDate_Month": "Close Date Month",
18 "CloseDate_Quarter": "Close Date Quarter",
19 "CloseDate_Week": "Close Date Week",
20 "CloseDate_Year": "Close Date Year",
21 "CreatedDate": "Created Date GMT",
22 "CreatedDate_Day": "Created Date Day",
23 "CreatedDate_Month": "Created Date Month",
24 "CreatedDate_Quarter": "Created Date Quarter",
25 "CreatedDate_Week": "Created Date Week",
26 "CreatedDate_Year": "Created Date Year",
27 "Id": "Id",
28 "OpportunityId": "Opportunity Id",
29 "StageName": "Opp Stage"
30 },
31 "measures": {
32 "Amount": "Total Amount"
33 },
34 "keys": {
35 "IsClosed": {
36 "true": "Closed",
37 "false": "Open"
38 },
39 "Outcome": {
40 "true": "Won",
41 "false": "Lost"
42 },
43 "Region": {
44 "EU": "Europe",
45 "AP": "Asia Pacific",
46 "US": "United States"
47 }
48 }
49 },
50 "types": {
51 "Close Date GMT": {
52 "dims": {
53 "day": "CloseDate_Day",
54 "fullField": "CloseDate",
55 "month": "CloseDate_Month",
56 "quarter": "CloseDate_Quarter",
57 "week": "CloseDate_Week",
58 "year": "CloseDate_Year"
59 },
60 "meas": {
61 "epoch_day": "CloseDate_day_epoch",
62 "epoch_second": "CloseDate_sec_epoch"
63 },
64 "type": "date"
65 },
66 "Created Date GMT": {
67 "dims": {
68 "day": "CreatedDate_Day",
69 "fullField": "CreatedDate",
70 "month": "CreatedDate_Month",
71 "quarter": "CreatedDate_Quarter",
72 "week": "CreatedDate_Week",
73 "year": "CreatedDate_Year"
74 },
75 "meas": {
76 "epoch_day": "CreatedDate_day_epoch",
77 "epoch_second": "CreatedDate_sec_epoch"
78 },
79 "type": "date"
80 }
81 },
82 "colors": {
83 "StageName": {
84 "5 - Closed-Won": "#4f4",
85 "5 - Closed-Lost": "#f44"
86 },
87 "Region": {
88 "AP": "#fc6",
89 "EU": "#48f",
90 "US": "#f88"
91 }
92 },
93 "values_query_columns": [
94 "Id",
95 "OpportunityId",
96 "StageName"
97 ]
98}XMD 2.0
いくつかの XMD 要素が変更され、いくつかの動作も変更されました。Salesforce の開発サークルでは、これらの変更は XMD 1.1 に対して XMD 2.0 として参照されます。
主な変更点は、XMD が JSON ファイルではなく BPO (Base Platform Object: ベースプラットフォームオブジェクト) に保存されるようになったことです。API がこのオブジェクトに対して動作するため、XMD API エンドポイントを使用して XMD ディレクトリを操作できます。
ユーザは依然として JSON ファイルのダウンロードとアップロードを行って独自の変更を有効にすることができます。XMD はその場で変換されます。ただし、この変更には副次的影響もあります。
- XMD はデータセットのバージョンごとに保存されます。
- system XMD は、main.json がアップロードされたとき、または旧バージョンのデータフローで API 経由で GET コールが実行されたときに生成されます。
以前と同様に、main タイプの XMD は、system と user をマージすることで作成されます。user XMD ファイルを変更して、Wave Analytics の多くのダッシュボード要素の形式をカスタマイズできます。
これはどのような意味を持つのでしょうか?
次の表で、XMD 要素の変更点について説明します。変更点のほとんどは新規要素ですが、名前が変更された既存の要素もいくつかあります。これらの要素を使用している場合は、XMD を更新してください。
| 要素 | 次のレベルの要素 | 次のレベルの要素 | 型 | メモ |
|---|---|---|---|---|
| dimensions | description | String | 新規。ディメンションの説明。 | |
| fullyQualifiedName | String | 新規。ディメンションの完全修飾名。 | ||
| origin | String | 新規。このディメンションの発生源。 | ||
| dateFormat | String | 新規。これを使用して、日付を読みやすい形式で表示します。 | ||
| isMultiValue | Boolean | 新規。ディメンションが複数値であるかどうかを示します。 | ||
| imageTemplate | String | 新規。画像テンプレートの名前。 | ||
| customActionsEnabled | Boolean | 新規。ディメンションでカスタムアクションが有効になっているかどうかを示します。 | ||
| customActions | List | 新規。このディメンションにリンクされているカスタムアクション。 | ||
| name | String | 新規。アクションの名前。 | ||
| url | String | 新規。アクションの URL。 | ||
| icon | String | 新規。アクションのアイコン。 | ||
| tooltip | String | 新規。アクションのツールチップ。 | ||
| target | String | 新規。アクションのターゲット。 | ||
| method | String | 新規。アクションのメソッド。 | ||
| enabled | Boolean | 新規。特定のディメンションに対してアクションが有効になっているかどうかを示します。 | ||
| sfdcActions | List | salesforceActions に名前変更されました。 | ||
| sfdcActionsEnabled | Boolean | salesforceActionsEnabled に名前変更されました。 | ||
| measures | description | String | 新規。基準の説明。 | |
| fullyQualifiedName | String | 新規。基準の完全修飾名。 | ||
| origin | String | 新規。基準の発生源。 | ||
| dateFormat | String | 新規。基準である日付に使用される書式。 | ||
| format | List | 既存。 | ||
| prefix | String | 新規。項目値の前に置かれるプレフィックス。 | ||
| unit | String | 新規。基準の単位文字列 (「cm」など)。 | ||
| suffix | String | 新規。項目値の後に置かれるサフィックス。 | ||
| decimalDigits | Integer | 新規。小数点の後に表示される桁数。 | ||
| negativeParens | Boolean | 新規。負の数値をマイナス記号を使用するのではなく括弧内に表示するかどうかを示します。 | ||
| unitMultiplier | Double | 新規。単位乗数。 | ||
| dates | label | String | 新規。日付列の表示ラベル。 | |
| compact | Boolean | 新規。日付がコンパクトとして表示されるかどうか。 | ||
| description | String | 新規。日付列の説明。 | ||
| showInExplorer | Boolean | 新規。日付がエクスプローラで表示されるかどうか。 | ||
| fiscalMonthOffset | Integer | 新規。カレンダー年に対する会計年度のオフセット (月数)。 | ||
| isYearEndFiscalYear | Boolean | 新規。1 年の終わりが会計年度であるかどうか。 | ||
| firstDayOfWeek | Integer | 新規。週の開始曜日として何を使用するか。 | ||
| dataset | connector | String | 新規。データセットのコネクタソース。 | |
| fullyQualifiedName | String | 新規。データセットバージョンの完全修飾名。 | ||
| origin | String | 新規。このデータセットバージョンのソースを表す発生源。 | ||
| description | String | 新規。データセットの説明。 |