Dimension PutProperties

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="3.11.1" Class="Dimension" Method="PutProperties">
    <Alea:Dimension Name="PRODUCT">
      <Alea:Properties>
        <Alea:DefaultHierarchy Name="Tire Size" />
        <Alea:ODBOType Code="8" />
        <Alea:AccessCube Name="#DAC_PRODUCT" />
        <Alea:MemberKey AttribTableID="1" FieldName="PRODUCTI" />
        <Alea:LevelNames>
          <Alea:Level Number="0" Name="Level All" />
          <Alea:Level Number="1" Name="Level Sizes" />
          <Alea:Level Number="2" Name="Level Tires" /> 
        </Alea:LevelNames>
        <Alea:Translation LocaleIdentifier="0">
          <Alea:Caption>Product</Alea:Caption>
          <Alea:Description>Product</Alea:Description>
          <Alea:MemberCaption AttribTableID="1" FieldName="Name" />
        </Alea:Translation>
        <Alea:Translation LocaleIdentifier="9">
          <Alea:Caption>Product caption</Alea:Caption>
          <Alea:Description>Product description</Alea:Description>
          <Alea:LevelCaption Level="0">All</Alea:LevelCaption> 
          <Alea:LevelCaption Level="1">Sizes</Alea:LevelCaption>
          <Alea:LevelCaption Level="2">Tires</Alea:LevelCaption>
          <Alea:MemberCaption AttribTableID="2" FieldName="English" />
        </Alea:Translation>
        <Alea:Translation LocaleIdentifier="7">
          <Alea:Caption>Produkt-Bezeichnung</Alea:Caption>
          <Alea:Description>Produkt Beschreibung</Alea:Description>
          <Alea:LevelCaption Level="0">Alle</Alea:LevelCaption> 
          <Alea:LevelCaption Level="1">Größen</Alea:LevelCaption>
          <Alea:LevelCaption Level="2">Reifen</Alea:LevelCaption>
          <Alea:MemberCaption AttribTableID="2" FieldName="German" />
        </Alea:Translation>
        <Alea:Hierarchy Name="PRODUCT">
          <Alea:Properties>
            <Alea:DefaultMember Name="All" />
            <Alea:LevelNames>
              <Alea:Level Number="0" Name="All" />
              <Alea:Level Number="1" Name="Product Group" />
              <Alea:Level Number="2" Name="Tire" />
              <Alea:Level Number="3" Name="Size" />
            </Alea:LevelNames>
            <Alea:Translation LocaleIdentifier="0">
              <Alea:Caption>Product</Alea:Caption>
              <Alea:Description>Product description</Alea:Description>
            </Alea:Translation>
          </Alea:Properties>
        </Alea:Hierarchy>
        <Alea:Hierarchy Name="Tire Size">
          <Alea:Properties>         
            <Alea:DefaultMember Name="All Sizes" />
            <Alea:Translation LocaleIdentifier="0">
              <Alea:Caption>Tires Size</Alea:Caption>
              <Alea:Description>Tires by Size</Alea:Description>
            </Alea:Translation>
            <Alea:Translation LocaleIdentifier="7">
              <Alea:Caption>Reifen Größe</Alea:Caption>
              <Alea:Description>Reifen nach Größen</Alea:Description>
            </Alea:Translation>
          </Alea:Properties>            
        </Alea:Hierarchy>
      </Alea:Properties>
    </Alea:Dimension>
  </Alea:Request>
</Alea:Document>

To assign the properties, you must have the Administer OLAP Database or Edit Dimension application permission.

This table describes the dimension properties:


Property	Description
`Alea:ODBOType`	This property sets the ODBO type of the dimension. For example: `<Alea:ODBOType Code="17"/>` See the "Supported ODBO types" section.
`Alea:DefaultHierarchy`	This property assigns the default hierarchy to the dimension. For example: `<Alea:DefaultHierarchy Name="PRODUCT"/>`
`Alea:AccessCube`	This property assigns a Dimension Access Control (DAC) cube. For example: `<Alea:AccessCube Name="#PRODUCT"/>`
`Alea:MemberKey`	This property defines the key for the member. For example: `<Alea:MemberKey AttribTableID="" FieldName=""/>`
`Alea:Hierarchy`	This property assigns properties to a hierarchy. For example: `<Alea:Hierarchy Name="PRODUCT"> <Alea:Properties> : : </Alea:Properties> </Alea:Hierarchy>`
`Alea:DefaultMember`	This property assigns the default element to the hierarchy. For example: `<Alea:DefaultMember Name="All Tires"/>`
`Alea:LevelNames`	This property is a list of level names. For example: `<Alea:LevelNames> : : </Alea:LevelNames>` Used in `<Alea:Hierarchy>`. If `<Alea:LevelNames>` is used outside of `<Alea:Hierarchy>`, it is treated as if it would belong to the default hierarchy in the dimension.
`Alea:Level`	This property sets the level name. The default string is "Level 1"..."Level xx". For example: `<Alea:Level Number="0" Name="name"/>` Number starts with "0". Used in `<Alea:LevelNames>`. When a certain level name already exists in the hierarchy and the corresponding `<Alea:Level>` XML element is not specified in the function then this level name is deleted.
`Alea:FlatView`	Do not use. Provided only for backward compatibility.
`Alea:Translation`	This property sets the hierarchy translation properties for the language represented by the locale identifier. For example: `<Alea:Translation LocaleIdentifier="9"> <Alea:Caption>Product caption</Alea:Caption> <Alea:Description>Product description</Alea:Description> <Alea:LevelCaption Level="0">Level 0</Alea:LevelCaption> <Alea:LevelCaption Level="1">Level 1</Alea:LevelCaption> <Alea:LevelCaption Level="2">Level 2</Alea:LevelCaption> <Alea:LevelCaption Level="3">Level 3</Alea:LevelCaption> <Alea:MemberCaption AttribTableID="2" FieldName="English" /> </Alea:Translation>` `Alea:Caption` sets the hierarchy caption for the given language. `Alea:Description` sets the hierarchy description for the given language. `Alea:LevelCaption` sets the hierarchy level caption for the given language and level. `Alea:MemberCaption` sets the attribute field from which the hierarchy member captions for the given language are taken. If `Alea:Translation` is used outside of `Alea:Hierarchy`, it is treated as if it would belong to the default hierarchy in the dimension.
`Alea:YTDHierarchy`	This property can enable the corresponding hierarchy to support write redirection. See the "Writing YTD data" section.

Answer

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request>
    <Alea:Return />
  </Alea:Request>
</Alea:Document>

Error 1

This error is returned if the user has insufficient permissions to set properties:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Error ErrorID="34" />
  </Alea:Request>
</Alea:Document>

Error 2

This error is returned when the property could not be set because the ODBO type "-1" is invalid:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:ODBOType Code="-1"> 
        <Alea:Error ErrorID="273" />
      </Alea:ODBOType>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

Error 3

This error is returned when the hierarchy for the property does not exist:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:Hierarchy Name="Poduct">
        <Alea:Error ErrorID="319" />
      </Alea:Hierarchy>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

Error 4

This error is returned when the property for the hierarchy could not be set because the name of the default member is empty:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:Hierarchy Name="Hierarchy">
        <Alea:DefaultMember Name=""> 
          <Alea:Error ErrorID="37" />
        </Alea:DefaultMember>
      </Alea:Hierarchy> 
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

Example of how to clear ODBO type of dimension

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" Method="PutProperties">
    <Alea:Dimension Name="MEASURE">
      <Alea:Properties>
        <Alea:ODBOType />
      </Alea:Properties>
    </Alea:Dimension>
  </Alea:Request>
</Alea:Document>

Example of how to get ODBO type of dimension

If the ODBO type was cleared, then GetProperties returns Code="3" (MD_DIMTYPE_OTHER).

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" 
  Method="GetProperties">
    <Alea:Dimension Name="MEASURE" />
  </Alea:Request>
</Alea:Document>

Supported ODBO types


ODBO type	Value
0	`MD_DIMTYPE_UNKNOWN`
1	`MD_DIMTYPE_TIME`
2	`MD_DIMTYPE_MEASURE`
3	`MD_DIMTYPE_OTHER`
4
5	QUANTITATIVE
6	ACCOUNTS
7	CUSTOMERS
8	PRODUCTS
9	SCENARIO
10	UTILITY
11	CURRENCY
12	RATES
13	CHANNEL
14	PROMOTION
15	ORGANIZATION
16	BILL OF MATERIALS
17	GEOGRAPHY