Dimension Read

Reads information about dimension elements and attributes.

The function returns a string up to 1 MB. If the string is larger than 1MB, the answer is batched. For more information see Batching Dimension Read functions.

Request 1

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" Method="Read">
    <Alea:Dimension Name="PRODUCT" Relation="Nothing" Selection="All">
      <Alea:Elements>All Tires</Alea:Elements>
      <Alea:Attributes>
        <Alea:Attribute AttribTableID="1" Name="APRODUCT" />
        <Alea:Attribute AttribTableID="1" Name="PRODUCTM" />
        <Alea:Attribute AttribTableID="2" Name="ENGLISH" />
      </Alea:Attributes>
    </Alea:Dimension>
  </Alea:Request>
</Alea:Document>

The <Alea:Elements> tag enables you to query information, such as dimension attributes, of a single element or of multiple elements. There are two ways to query multiple elements. The first is to use a line break between elements. For example:

<Alea:Elements>AS600/175
C3000/175</Alea:Elements>

The second way is to use a pick list. For example:

<Alea:PickList>
  <Alea:Element Name="AS600/175"/>
  <Alea:Element Name="C3000/175"/>
</Alea:PickList>

If both methods are used, the pick list is ignored.

To query a non-default hierarchy, define the Hierarchy attribute inside the dimension tag. If no hierarchy is specified, the default hierarchy is queried. For example:

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" Method="Read">
    <Alea:Dimension Name="Product" Relation="CHILD" Selection="ALL" Hierarchy="Tire Size" />
  </Alea:Request>
</Alea:Document>

Answer 1

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:Dimension Name="PRODUCT" Hierarchy="PRODUCT">
        <Alea:Attributes>
          <Alea:Attribute AttribTableID="1" Name="APRODUCT" />
          <Alea:Attribute AttribTableID="1" Name="PRODUCTM" />
          <Alea:Attribute AttribTableID="2" Name="ENGLISH" />
        </Alea:Attributes>
        <Alea:Elements LastBatch="true" FirstBatch="true" LinesCount="1">C	All Tires	Christoph.Berlin@Genesis.com	7	All Tires
</Alea:Elements>
      </Alea:Dimension>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

The format of returned attribute values is described in the Dimension ImportAttributeValues topic.

Error

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

Request 2

You can request detailed information about a dimension element. For example, the element type, the number of parents or the number of children.

The <Alea:NumberOfChildren /> and <Alea:NumberOfParents /> tags return the number of children or the number of parents. No value should be specified for these tags.

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Dimension" Method="Read">
    <Alea:Dimension Name="PRODUCT" Relation="None" Selection="All">
      <Alea:Elements>AS600/175</Alea:Elements>
      <Alea:Attributes>
        <Alea:Attribute AttribTableID="1" Name="Name" />
      </Alea:Attributes>
      <Alea:ElementInfo>
        <Alea:NumberOfChildren />
        <Alea:NumberOfParents />
      </Alea:ElementInfo>
    </Alea:Dimension>
  </Alea:Request>
</Alea:Document>

This table describes the XML attributes:

Parameter Values Description
Name Name of the dimension.
Relation Child | None/Nothing | Parent If Child, then child elements are returned with their parents. If None or Nothing then no additional elements are returned.

If Parent, then parent elements with their children are returned.
Selection All | Top | Basic Returns all elements, only top level elements, or only base elements.

Defined is deprecated but can be used in place of All.
Delimiter \t | space | character Specifies the delimiter between the columns in the output string. The default is Tab (\t). You can also specify a space or a character. For example, a semi-colon (;).
DecimalPoint . | , Specifies the decimal point in doubles. The default is a period (.).
Operator Self Obsolete
RelationFromSelectionOnly True | False Obsolete

Answer 2

In the output, the number of children and number of parents are shown after the attributes.

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001">
    <Alea:Return>
      <Alea:Dimension Name="PRODUCT" Hierarchy="PRODUCT">
        <Alea:Attributes>
          <Alea:Attribute AttribTableID="1" Name="Name" />
        </Alea:Attributes>
        <Alea:ElementInfo>
          <Alea:NumberOfChildren />
          <Alea:NumberOfParents />
        </Alea:ElementInfo>
        <Alea:Elements LastBatch="true" FirstBatch="true" LinesCount="1">N	AS600/175	AS600/175	0	3
</Alea:Elements>
      </Alea:Dimension>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>

Request 3

You can obtain the dimension element weights (factors).

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="23" Class="Dimension" Method="Read">
    <Alea:Dimension Name="VALTYPE" Relation="Child" Selection="All" />
  </Alea:Request>
</Alea:Document>

Answer 3

The weights are listed after the child element. They are listed only if they are different from 1.

<Alea:Document>
  <Alea:Request RequestID="23">
    <Alea:Return>
      <Alea:Dimension Name="VALTYPE" Hierarchy="VALTYPE">
        <Alea:Elements LastBatch="true" FirstBatch="true" LinesCount="8">N	Actual
N	Budget
C	Variance
N	Simulation
N	Forecast
C	Variance
	Actual
	Budget	-1</Alea:Elements>
      </Alea:Dimension>
    </Alea:Return>
  </Alea:Request>
</Alea:Document>
Related topics