Cube GetList (12.0.0)
Retrieves a list of available cubes.
Request
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001" Class="Cube" Method="GetList">
<Alea:Cubes NameFilter="SALES" detailed="true" />
</Alea:Request>
</Alea:Document>
If the NameFilter
attribute is not
present or empty, all information is returned. If NameFilter
is specified, it is interpreted as a regular expression. The NameFilter
attribute is optional.
Use the detailed
attribute to retrieve
additional details about the cubes. For example, the timestamp of the last update, base
values, and so on. The detailed
attribute is optional.
The default is false.
Answer
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001">
<Alea:Return>
<Alea:Cubes Count="1">
<Alea:CubeInfo Name="SALES">
<Alea:Description>Sales Controlling</Alea:Description>
<Alea:Dimensions Count="8">
<Alea:Dimension Name="TIME" />
<Alea:Dimension Name="VERSION" />
<Alea:Dimension Name="CURRTYPE" />
<Alea:Dimension Name="LEVEL" />
<Alea:Dimension Name="UNIT" />
<Alea:Dimension Name="INTERCO" />
<Alea:Dimension Name="PRODUCT" />
<Alea:Dimension Name="PROFIT" />
</Alea:Dimensions>
<Alea:Type Value="U" />
<Alea:Loaded Value="true" />
<Alea:Modified Value="true" />
<Alea:Accelerated Value="false" />
<Alea:TRS Value="off" />
<Alea:AccessControl Value="off" />
<Alea:HasMDAC Value="true" />
<Alea:ErrorSuppression Value="off" />
<Alea:BaseValuesCount Value="295392" />
<Alea:CalculatedValuesCount Value="0" />
<Alea:ActiveRulesCount Value="23" />
<Alea:TimeStamp Value="1483969820" LastModified="2017-01-09T13:50:20.000" />
<Alea:AllocatedMemoryBytes Value="8292760" />
<Alea:MeasureDimension Name="PROFIT" />
<Alea:FormatDimension Name="PRODUCT" />
<Alea:CachePartitionDimension Name="UNIT" />
<Alea:MDACCubes>
<Alea:MDACCube Name="#SALESMDAC" />
</Alea:MDACCubes>
</Alea:CubeInfo>
</Alea:Cubes>
</Alea:Return>
Element | Description |
---|---|
Alea:Type |
Returns the cube type. These are the values:
|
Alea:TimeStamp |
The Value attribute is deprecated and should
no longer be used. Use the LastModified attribute
instead. |
Alea:Loaded |
Indicates if the cube is loaded into memory. |
Alea:Modified |
Indicates if the cube was altered since the last save. |
Alea:Accelerated |
Indicates if the former rules engine is used. |
Alea:TRS |
Indicates if transaction logging is switched on or off. |
Alea:AccessControl |
Indicates if cube access control is active or not. |
Alea:HasMDAC |
Indicates if at least one multidimensional access control cube is assigned to the cube. |
Alea:ErrorSuppression |
Indicates if an error is returned when attempting to write to a consolidated cell. |
Alea:BaseValuesCount |
Returns the number of stored values in the cube. |
Alea:CalculatedValuesCount |
Returns the number of values in the cache. |
Alea:ActiveRulesCount |
Returns the number of enabled rules. |
Alea:AllocatedMemoryBytes |
Returns the memory used for the cube. |
Alea:MeasureDimension |
Returns the name of the measure dimension. An empty string is returned if there is no measure dimension defined for the cube. |
Alea:FormatDimension |
Returns the name of the dimension used for cell formats. An empty string is returned if there is no format dimension defined for the cube. |
Alea:CachePartitionDimension |
Returns the name of the dimension used for cache partitioning. An empty string is returned if there is no cache partition dimension. |
Alea:MDACCubes |
Returns a list of MDAC cube names. The Alea:MDACCubes tag is empty if there is no MDAC cube defined for the
cube. |
Error
<Alea:Document>
<Alea:Request RequestID="001">
<Alea:Error ErrorID="error_code"/>
</Alea:Request>
</Alea:Document>
Example
This is an example of an answer where the detailed attribute is false or not specified:
<Alea:Document xmlns:Alea="http://www.misag.com">
<Alea:Request RequestID="001">
<Alea:Return>
<Alea:Cubes count="1">
<Alea:CubeInfo Name="SALES" />
</Alea:Cubes>
</Alea:Return>
</Alea:Request>
</Alea:Document>