MDSCHEMA_FUNCTIONS Rowset

The FUNCTIONS rowset exposes all functions supported by the MDP. Default sort order: ORIGIN, INTERFACE_NAME, and FUNCTION_NAME.

GUID: MDSCHEMA_FUNCTIONS

Table 5describes the rowset structure.

Table 5. MDSCHEMA_FUNCTIONS Rowset structure

Column Name	Essbase Mapping
FUNCTION_NAME	Name of the function
DESCRIPTION	Description of the function
PARAM_LIST	A comma delimited list of parameters
RETURN_TYPE	Always 12
ORIGIN	1 (always:MDX functions)
INTERFACE_NAME	One of the following: Member, Set, Tuple, Numeric, Dimension, Level, Boolean
OBJECT	One of the following values: Set, Member, Tuple, Level, Hierarchy, Dimension
HELP_CONTEXT	Help context ID for the function
CAPTION	Display caption of the function

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_FUNCTIONS</RequestType>
   <Restrictions><RestrictionList></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 (truncated)

<?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="FUNCTION_NAME" type="xsd:string" 
         sql:field="FUNCTION_NAME"/>
        <xsd:element name="DESCRIPTION" type="xsd:string" 
         sql:field="DESCRIPTION"/>
        <xsd:element name="PARAMETER_LIST" type="xsd:string" 
         sql:field="PARAMETER_LIST"/>
        <xsd:element name="RETURN_TYPE" type="xsd:int" 
         sql:field="RETURN_TYPE"/>
        <xsd:element name="ORIGIN" type="xsd:int" 
         sql:field="ORIGIN"/>
        <xsd:element name="INTERFACE_NAME" type="xsd:string" 
         sql:field="INTERFACE_NAME"/>
        <xsd:element name="OBJECT" type="xsd:string" 
         sql:field="OBJECT" minOccurs="0"/>
        <xsd:element name="HELP_CONTEXT" type="xsd:int" 
         sql:field="HELP_CONTEXT" minOccurs="0"/>
        <xsd:element name="CAPTION" type="xsd:string" 
         sql:field="CAPTION"/>
       </xsd:sequence>
      </xsd:complexType>
     </xsd:schema>
     <!-- Begin: All MDX functions that return a Member 
      (INTERFACE_NAME=Member) -->
     <row>
      <FUNCTION_NAME>Ancestor</FUNCTION_NAME>
      <DESCRIPTION>Given the input member, returns the ancestor 
       at the specified level.</DESCRIPTION>
      <PARAMETER_LIST>Member, Level | Numeric Expression</PARAMETER_LIST>
      <RETURN_TYPE>12</RETURN_TYPE>
      <ORIGIN>1</ORIGIN>
      <INTERFACE_NAME>Member</INTERFACE_NAME>
      <HELP_CONTEXT>9142</HELP_CONTEXT>
      <CAPTION>Ancestor</CAPTION>
     </row>
     < ................More Rows............. >
    </root>
   </m:return>
  </m:DiscoverResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>