Extended Metadata (XMD) Reference

Modify the XMD file to customize the formatting of many dashboard elements in Analytics Cloud.

Formats Section

The formats section of the extended metadata file allows you to specify a format and multiplier for measures. The following example shows code for specifying a format string and a multiplier of 1 for the Amount measure:

1"formats": {
2        "measures": {
3            "Amount": [
4                "$#,##0.00",
5                1
6            ]
7        }
8    }

For more information about numeric formatting, see “Numeric Formats” in the Analytics Cloud External Data API Developer’s Guide.

Labels Section

The labels section of the extended metadata file allows you to provide a display label for the following elements.

Dimension: Maps the dimension API name to a display label.
Measure: Maps the measure API name to a display label.
Measure filter: Specifies display labels to be used when the dashboard is showing a range for a measure. You can set the measure filter if you want to use a shorter name than the one that is defined in the measures section.
Key: Specifies display labels for dimension keys.

The following example shows code for mapping a variety of API names to display labels that will be used in the user interface.

1"labels": {
2        "dimensions": {
3            "OpportunityId": "Opportunity Id",
4            "*": "Opportunities",
5            "StageName": "Opportunity Stage"
6        },
7        "measures": {
8            "Amount": "Total Amount"
9        },
10        "measure_filters": {
11            "Amount": "$"
12            "*": "OpportunityId"
13        },
14        "keys": {
15            "IsClosed": {
16                "true": "Closed",
17                "false": "Open"
18            },
19            "Outcome": {
20                "true": "Won",
21                "false": "Lost"
22            },
23            "Region": {
24                "EU": "Europe",
25                "AP": "AsiaPacific",
26                "US": "UnitedStates"
27            }
28        }
29    }

Use "*" for the name of the measure that’s used when the dashboard is displaying count().

Note

Types Section

The types section of the extended metadata file allows you to group dimensions into composite types that are treated as a single dimension in the user interface. The following example shows code for creating a type that’s called “Close Date GMT” and groups date dimensions and measures.

1"types": {
2        "Close Date GMT": {
3            "dims": {
4                "day": "CloseDate_Day",
5                "fullField": "CloseDate",
6                "month": "CloseDate_Month",
7                "quarter": "CloseDate_Quarter",
8                "week": "CloseDate_Week",
9                "year": "CloseDate_Year"
10            },
11            "meas": {
12                "epoch_day": "CloseDate_day_epoch",
13                "epoch_second": "CloseDate_sec_epoch"
14            },
15            "type": "date"
16        }
17}

Colors Section

The colors section of the extended metadata file allows you to set custom colors for charts. The following example shows code for setting the colors for particular StageName and Region values.

1"colors": {
2        "StageName": {
3            "5 - Closed-Won": "#4f4",
4            "5 - Closed-Lost": "#f44"
5        },
6        "Region": {
7            "AP": "#fc6",
8            "EU": "#48f",
9            "US": "#f88"
10        }
11    }

Values Query Columns Section

The values_query_columns section of the extended metadata file allows you to specify a list of default columns to be displayed for a values table.

1"values_query_columns": [
2        "Id",
3        "OpportunityId",
4        "StageName"
5    ]

Hide Dimensions and Measures Section

The hide_dimensions and hide_measures sections allow you to provide lists of dimensions and measures to be hidden in the user interface.

1"hide_dimensions": [
2        "Owner-Email"
3    ],
4    "hide_measures": [
5        "TotalMRR"
6    ]

Analytics Cloud Extended Metadata (XMD) Reference

No Results