Analytics Extended Metadata (XMD) Developer Guide
jNewer Version Available
XMD 1.1
XMD 1.1 has been deprecated as of the Winter ’17 release and replaced with XMD 2.0,
which has a different structure and parameters. You can refer to the XMD 1.1 examples to
understand what has changed.
You can control the following with XMD 1.1.
- Formatting measures
- Display labels for dimensions and measures
- Grouping dimensions of measures
- Colors of specific fields
- Default columns to display for a values table
- Hiding dimensions and measures in the UI
- Custom menus that let users take advantage of actions on Salesforce objects and follow links to records in Salesforce and external websites
- Mapping Salesforce org IDs to their URLs, which enables CRM Analytics to match records from a multi-org dataset to the correct org for that record
The XMD file is in JSON format. To access the XMD file, edit the corresponding dataset. You can download the existing XMD file from the Edit page.
Extended Metadata Example
The following example illustrates the format of the XMD file.
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}