MDSCHEMA_HIERARCHIES Rowset

The HIERARCHIES rowset contains information about the hierarchies available in a dimension.

GUID: MDSCHEMA_HIERARCHIES

Table 36describes the rowset structure.

Table 36. MDSCHEMA_HIERARCHIES Rowset Structure

Column Name	Essbase Mapping
CATALOG_NAME	Application name
CUBE_NAME	Database name
DIMENSION_UNIQUE_NAME	Dimension name
HIERARCHY_NAME	Dimension name
HIERARCHY_UNIQUE_NAME	Dimension name
HIERARCHY_CAPTION	Dimension name
DIMENSION_TYPE	If Essbase dimension type is: TIME: MD_DIMTYPE_TIME ACCOUNTS: MD_DIMTYPE_MEASSURE ALL OTHER: MD_DIMTYPE_OTHER
HIERARCHY_CARDINALITY	Number of members in the dimension
DEFAULT_MEMBER	Dimension name
ALL_MEMBER	Dimension name
DESCRIPTION	Dimension comment
STRUCTURE	MD_STRUCTURE_UNBALANCED(2)
HIERARCHY_UNIQUE_SETTINGS	2
HIERARCHY_IS_VISIBLE	True

Request Example

<SOAP-ENV:Envelope
 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <SOAP-ENV:Body>
  <Discover xmlns="urn:schemas-microsoft-com:xml-analysis"
   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
   <RequestType>MDSCHEMA_HIERARCHIES</RequestType>
    <Restrictions>
     <RestrictionList>
      <CUBE_NAME>Sample.Basic</CUBE_NAME>
      <DIMENSION_UNIQUE_NAME>Year</DIMENSION_UNIQUE_NAME>
     </RestrictionList>
    </Restrictions>
    <Properties>
     <PropertyList>
      <DataSourceInfo>Provider=Essbase;Data Source=localhost
      </DataSourceInfo>
      <Format>Tabular</Format>
     </PropertyList>
    </Properties>
   </Discover>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response Example

<?xml version="1.0"?>
<SOAP-ENV:Envelope 
 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
 SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <SOAP-ENV:Body>
  <m:DiscoverResponse xmlns:m="urn:schemas-microsoft-com:xml-analysis">
   <m:return xsi:type="xsd:string" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <xsd:schema xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" 
      targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:sql="urn:schemas-microsoft-com:xml-sql"
      elementFormDefault="qualified">
      <xsd:element name="root">
       <xsd:complexType>
        <xsd:sequence minOccurs="0" maxOccurs="unbounded">
         <xsd:element name="row" type="row"/>
        </xsd:sequence>
       </xsd:complexType>
      </xsd:element>
      <xsd:complexType name="row">
       <xsd:sequence maxOccurs="unbounded" minOccurs="0">
        <xsd:element name="CATALOG_NAME" type="xsd:string" 
         sql:field="CATALOG_NAME"/>
        <xsd:element name="CUBE_NAME" type="xsd:string" 
         sql:field="CUBE_NAME"/>
        <xsd:element name="DIMENSION_UNIQUE_NAME" type="xsd:string" 
         sql:field="DIMENSION_UNIQUE_NAME"/>
        <xsd:element name="HIERARCHY_NAME" type="xsd:string" 
         sql:field="HIERARCHY_NAME"/>
        <xsd:element name="HIERARCHY_UNIQUE_NAME" type="xsd:string" 
         sql:field="HIERARCHY_UNIQUE_NAME"/>
        <xsd:element name="HIERARCHY_CAPTION" type="xsd:string" 
         sql:field="HIERARCHY_CAPTION"/>
        <xsd:element name="DIMENSION_TYPE" type="xsd:short" 
         sql:field="DIMENSION_TYPE"/>
        <xsd:element name="HIERARCHY_CARDINALITY" type="xsd:unsignedInt" 
         sql:field="HIERARCHY_CARDINALITY"/>
        <xsd:element name="DEFAULT_MEMBER" type="xsd:string" 
         sql:field="DEFAULT_MEMBER"/>
        <xsd:element name="ALL_MEMBER" type="xsd:string" 
         sql:field="ALL_MEMBER"/>
        <xsd:element name="DESCRIPTION" type="xsd:string"  
         sql:field="DESCRIPTION" minOccurs="0"/>
        <xsd:element name="STRUCTURE" type="xsd:int" 
         sql:field="STRUCTURE"/>
        <xsd:element name="HIERARCHY_UNIQUE_SETTINGS" type="xsd:int" 
         sql:field="HIERARCHY_UNIQUE_SETTINGS"/>
        <xsd:element name="HIERARCHY_IS_VISIBLE" type="xsd:boolean" 
         sql:field="HIERARCHY_IS_VISIBLE"/>
       </xsd:sequence>
      </xsd:complexType>
     </xsd:schema>
     <row>
      <CATALOG_NAME>Sample</CATALOG_NAME>
      <CUBE_NAME>Sample.Basic</CUBE_NAME>
      <DIMENSION_UNIQUE_NAME>[Year]</DIMENSION_UNIQUE_NAME>
      <HIERARCHY_NAME>Year</HIERARCHY_NAME>
      <HIERARCHY_UNIQUE_NAME>[Year]</HIERARCHY_UNIQUE_NAME>
      <HIERARCHY_CAPTION>Year</HIERARCHY_CAPTION> 
      <DIMENSION_TYPE>1</DIMENSION_TYPE>
      <HIERARCHY_CARDINALITY>19</HIERARCHY_CARDINALITY>
      <DEFAULT_MEMBER>[Year]</DEFAULT_MEMBER>
      <ALL_MEMBER>[Year]</ALL_MEMBER>
      <STRUCTURE>2</STRUCTURE>
      <HIERARCHY_UNIQUE_SETTINGS>2</HIERARCHY_UNIQUE_SETTINGS>
      <HIERARCHY_IS_VISIBLE>true</HIERARCHY_IS_VISIBLE>
     </row>
    </root>
   </m:return>
  </m:DiscoverResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>