Cube Splashing

Performs a splashing operation. The value in the request represents the value to be splashed.

Allocation modes are described in the Splashing topic.

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="001" Class="Cube" Method="Splashing">
    <Alea:Splashing AllocationMode="Equal" Rounding="true" DecimalPlaces="2" ErrorCorrection="true" Undo="true" DoNotDeleteOnZero="false">
      <Alea:CellCoordinates Purpose="Target" Cube="SALES">
        <Alea:Element Dimension="TIME" Name="2010" />
        <Alea:Element Dimension="VERSION" Name="Budget" />
        <Alea:Element Dimension="CURRTYPE" Name="LC" />
        <Alea:Element Dimension="LEVEL" Name="IFRS" />
        <Alea:Element Dimension="UNIT" Name="C1101" />
        <Alea:Element Dimension="INTERCO" Name="ED_3001" />
        <Alea:Element Dimension="PRODUCT" Name="AS600/175" />
        <Alea:Element Dimension="PROFIT" Name="Sales Volume" />
      </Alea:CellCoordinates>
      <Alea:Value>200.56</Alea:Value>
    </Alea:Splashing>
  </Alea:Request>
</Alea:Document>

The Cube Splashing XML function supports all allocation modes.

Answer

<Alea:Document xmlns:Alea="http://www.misag.com"> 
  <Alea:Request RequestID="001"> 
  <Alea:Return> 
    <Alea:UndoRefNumber>05D77A</Alea:UndoRefNumber> 
  </Alea:Return> 
  </Alea:Request> 
</Alea:Document>

The UndoRefNumber tag is returned only if the Undo option was enabled in the request and the request was executed successfully.

Locked elements

Specific elements can be locked in a splashing request. Cells with the corresponding coordinates in the target area then retain their values after the splashing operation. Furthermore these conditions apply:

  • Only elements in the target area of the splashing request can be locked. Locked elements outside of the target area are ignored.
  • If a consolidated element is locked then all its underlying base elements are also locked.
  • External weighted splashing/Mixed (Delta) splashing:
    • Locked elements relate to write operations only. Hence the only purpose of locked elements is to define which cells in the target area will remain unchanged - they are locked. Locked elements in the source have no effect on the result of the splash operation.
    • For locked cells in the target area it is not necessary to retrieve the related cell values from the source area as they would be ignored anyway.
  • Mixed (Delta) splashing:
    • Locked elements are not taken into account during the calculation of the source distribution.

For example, before the splashing request, the values in the cube are:

195 AS800/195 C2001/195 W6000/195 W7000/195
Sales Volume 600 25 75 200 300

The splashing request is:

<<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="101" Class="Cube" Method="Splashing">
    <Alea:Splashing AllocationMode="Weighted" Rounding="false" ErrorCorrection="false" Undo="false">
      <Alea:LockedElements>
        <Alea:Element Dimension="PRODUCT" Name="AS800/195" Hierarchy="Tire Size" />
        <Alea:Element Dimension="PRODUCT" Name="C2001/195" Hierarchy="Tire Size" />
      </Alea:LockedElements>
      <Alea:CellCoordinates Purpose="Target" Cube="SALES">
        <Alea:Element Dimension="TIME" Name="2016" />
        <Alea:Element Dimension="VERSION" Name="Actual" />
        <Alea:Element Dimension="CURRTYPE" Name="LC" />
        <Alea:Element Dimension="LEVEL" Name="IFRS" />
        <Alea:Element Dimension="UNIT" Name="C1101" />
        <Alea:Element Dimension="INTERCO" Name="TotalPartner" />
        <Alea:Element Dimension="PRODUCT" Name="195" Hierarchy="Tire Size" />
        <Alea:Element Dimension="PROFIT" Name="Sales Volume" />
      </Alea:CellCoordinates>
      <Alea:Value>1100</Alea:Value>
    </Alea:Splashing>
  </Alea:Request>
</Alea:Document>

After the splashing, the values in the cube changed to:

195 AS800/195 C2001/195 W6000/195 W7000/195
Sales Volume 1100 25 75 400 600

If the complete target area is locked, the splashing request fails and error 371 is returned:

<Alea:Document>
  <Alea:Request RequestID="102">
    <Alea:Error ErrorID="371" />
  </Alea:Request>
</Alea:Document>
Related topics