Cube GetCellDebugInformation
Retrieves the debug information of a cell, given its coordinates. The debug information includes:
- Cell coordinates
- Cell type, either basic or calculated
- If applicable, the rule that calculates the cell value
- If applicable, the semi-additive calculation method and which element drives the method
- If applicable, details about the base descendants that are consolidated in the cell
Request
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001" Class="Cube" Method="GetCellDebugInformation">
<Alea:CellCoordinates Cube="Sales">
<Alea:Element Dimension="PROFIT" Name="Revenue" />
<Alea:Element Dimension="TIME" Name="2014" />
<Alea:Element Dimension="VERSION" Name="Actual" />
<Alea:Element Dimension="CURRTYPE" Name="USD" />
<Alea:Element Dimension="LEVEL" Name="IFRS" />
<Alea:Element Dimension="UNIT" Name="G0000" />
<Alea:Element Dimension="INTERCO" Name="TotalPartner" />
<Alea:Element Dimension="PRODUCT" Name="T (118 mph 190 km/h)" Hierarchy="Speed Rating" />
</Alea:CellCoordinates>
</Alea:Request>
</Alea:Document>
If no hierarchy is specified for an element, the default hierarchy is used.
The XML function can also be written like this:
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001" Class="Cube" Method="GetCellDebugInformation">
<Alea:CellCoordinates Cube="Sales" Elements="2014[Actual[USD[IFRS[G0000[TotalPartner[T (118 mph 190 km/h)[Revenue" Hierarchies="[[[[[[Speed Rating[" />
</Alea:Request>
</Alea:Document>
The elements and hierarchies must be presented in the native order of
the dimensions inside the cube. This order can be different from the order of the dimensions
in MDX / XMLA. You can check the native order using the Cube GetList
function.
Answer
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001">
<Alea:Return>
<Alea:CellNote>
---Cell Coordinates -------------------------------
TIME TIME 2014
VERSION VERSION Actual
CURRTYPE CURRTYPE USD
LEVEL LEVEL IFRS
UNIT UNIT G0000
INTERCO INTERCO TotalPartner
PRODUCT Speed Rating T (118 mph 190 km/h)
PROFIT PROFIT Revenue
Internal Key: 274 1 3 1 10 21 52 13
External Key: 294 1 3 1 10 19 50 9
---------------------------------------------------------
Cell Type: Calculated
Consolidated by:
TIME:'2014' 12 - Base Descendants
UNIT:'G0000' 7 - Base Descendants
INTERCO:'TotalPartner' 18 - Base Descendants
PRODUCT:'T (118 mph 190 km/h)' 11 - Base Descendants
Total consolidated cells: 16632</Alea:CellNote>
</Alea:Return>
</Alea:Request>
</Alea:Document>
The Cell Coordinates section contains a row for each dimension with dimension name, hierarchy name, and element name. These different parts are separated by horizontal tabulators.
The Cell Coordinates section also includes the internal and external keys of the elements
for all dimensions. The external keys are the same IDs that are returned by the DE.INDEX
rules function. The internal keys are only important to
Infor support staff.
Depending on the cell type, different information is returned. Next are examples for each of the cell types.
Cell type: Calculated
This section is returned if the requested cell is on a consolidated level. If the cell is not calculated by a rule, then this section includes the dimensions in which there are consolidated elements. For example, in the TIME dimension there is a consolidated element ('2014') and it has 12 descendants on base level.
The total number of consolidated cells is the multiplication of the numbers of base descendants of each involved consolidated element. In this example, 12*7*18*11=16,632.
Cell Type: Calculated
Consolidated by:
TIME:'2014' 12 - Base Descendants
UNIT:'G0000' 7 - Base Descendants
INTERCO:'TotalPartner' 18 - Base Descendants
PRODUCT:'T (118 mph 190 km/h)' 11 - Base Descendants
Total consolidated cells: 16632
If the cell is calculated by a semi-additive measure over time, then this information is returned:
- The calculation mode
- Driven by: the relevant element in the calculation dimension
- Calculated by: each dimension of the requested cell that has a consolidated element
- Total consolidated cells: similar to above
Cell Type: Calculated
Calculation mode: Semi-additive – Last period
Driven by PROFIT:'Sales Volume (Last Period)'
Calculated by:
TIME:'2014' 12 – Base Descendants
UNIT:'G0000' 7 - Base Descendants
Total consolidated cells: 84
If the cell is calculated by a rule, then the rule target and the rule formula is returned. The Optimized Rule References section provides further details on the rule. This information is useful when optimizing rules.
Cell Type: Calculated
Rule: [PROFIT:'Price per Unit']=[PROFIT:'Revenue']/[PROFIT:'Sales Volume'];
---Optimized Rule References-----------------------
[PROFIT:'Revenue']
[PROFIT:'Sales Volume']
If a cell is targeted by a rule as well as by a semi-additive measure, then the rule overrides the semi-additive measure.
Cell type: Basic
This section is returned when the requested cell is on base level. If there is no rule on the cell, then also the sub-type of the cell is provided.
Cell Type: Basic
Numeric Cell
If there is a rule on the requested basic cell, then the information returned is equivalent to the information about a rule on a consolidated cell:
Cell Type: Basic
Rule: [DCS_MEASURE:'Revenue_Rule']=[DCS_MEASURE:'Price']*[DCS_MEASURE:'Units'];
---Optimized Rule References-----------------------
[DCS_MEASURE:'Price']
[DCS_MEASURE:'Units']
The Acceleration Flag section describes whether there is an accelerator flag on this cell. If yes, the accelerators are listed in this section.
Acceleration Flag
Targeted by Accelerators:
[MEASURE:'Discounts']>[MEASURE:'Discount in percent']
NO Acceleration Flag
Trigger for Accelerators:
[MEASURE:'Discounts']>[MEASURE:'Discount in percent']
Error
<Alea:Document>
<Alea:Request RequestID="001">
<Alea:Error ErrorID="error_code"/>
</Alea:Request>
</Alea:Document>