From 615104a27586670f03954f4c7349102484c1ae38 Mon Sep 17 00:00:00 2001
From: morgan-at-cube <153563892+morgan-at-cube@users.noreply.github.com>
Date: Fri, 4 Oct 2024 13:29:58 -0700
Subject: [PATCH] Update measures.mdx
Customers regularly think that drills and formats are expected to carry through to a BI tool. They think it is buggy behavior when it doesn't carry through. This PR is to clarify the intention of these fields in the documentation.
---
docs/pages/reference/data-model/measures.mdx | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/docs/pages/reference/data-model/measures.mdx b/docs/pages/reference/data-model/measures.mdx
index 654a4b258dd23..af0566cec9c9e 100644
--- a/docs/pages/reference/data-model/measures.mdx
+++ b/docs/pages/reference/data-model/measures.mdx
@@ -94,6 +94,12 @@ cubes:
### `drill_members`
+
+
+`drill_members` is used for creating custom applications. It does not affect the behavior drilling in BI tools.
+
+
+
Using the `drill_members` parameter, you can define a set of [drill
down][ref-drilldowns] fields for the measure. `drill_members` is defined as an
array of dimensions. Cube automatically injects dimensions’ names and other
@@ -174,6 +180,12 @@ cubes:
### `format`
+
+
+`format` does not affect the format of the data in an API response. It is used in the Cube Playground and for custom applications. It does not affect the display format of a field when viewed in a BI tool.
+
+
+
`format` is an optional parameter. It is used to format the output of measures
in different ways, for example, as currency for `revenue`. Please refer to the
[Measure Formats][ref-schema-ref-types-formats-measures-formats] for the full
@@ -540,4 +552,4 @@ join will be created automatically.
[ref-drilldowns]: /guides/recipes/data-exploration/drilldowns
[ref-naming]: /product/data-modeling/syntax#naming
[ref-playground]: /product/workspace/playground
-[ref-apis]: /product/apis-integrations
\ No newline at end of file
+[ref-apis]: /product/apis-integrations