DBRA function#
DBRA retrieves an element attribute value - for example an element's description or a numeric attribute - so you can show it beside its data.
DBRA is a native TM1 / Planning Analytics function; Reportworq evaluates it against the workbook's TM1 connection at report-generation time.
Signature#
=DBRA("Server:Dimension", element, attribute)
Arguments#
| # | Argument | Type | Required | Permitted values and notes |
|---|---|---|---|---|
| 1 | Server:Dimension |
String | Yes | "server:dimension". |
| 2 | element |
String | Yes | An element name. A numeric value is rejected (see below). |
| 3 | attribute |
String | Yes | An attribute defined on the dimension. |
DBRA takes exactly three arguments. When the attribute exists but the element carries no value, the result is 0 for a numeric attribute and an empty string otherwise.
What happens when an argument is wrong#
For the shared error model and the Calc Mode effect, see how Reportworq handles errors.
| Situation | Result |
|---|---|
| More than three arguments | Hard error - too many parameters |
| Fewer than three arguments | Warning, the cell returns blank |
| Server, dimension, element, or attribute blank or an Excel error value | Warning, blank |
| A numeric element argument | Warning, blank - an attribute cannot be retrieved from a number |
| The dimension, element, or attribute is not found | Warning, blank |
Notes and limits#
- Unlike the other element functions, which only warn and continue when the element looks numeric,
DBRAstops on a numeric element because it cannot resolve an attribute from a number.
Examples#
=DBRA("PlanTM1:Product", "Widget", "Description")
=DBRA("PlanTM1:Region", $A$5, "Manager")
Related pages#
- IBM Planning Analytics functions - the function index and the shared error model.
- DBRW function - retrieve a cube cell value.
- DTYPE function - read an element or attribute type.
Feedback on this page
Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.
Email feedback on this pageOr write to support@reportworq.com directly.