Cube DataareaCalculateHash

Calculates the hash value for each cell value in a data area and continuously adds the hash values to a resulting hash value. This way you can check if the cube values and element names were changed in the data area since the last call of Cube DataareaCalculateHash. It is extremely unlikely that data areas with different cell values yield the same resulting hash value.

The data area used for this operation is the last data area that has been defined on this session.

Request

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="002" Class="Cube" Method="DataareaCalculateHash">
    <Alea:DataQuery NonExistentCellSuppression="false" UseOnlyBasicElements="true" IncludeElementNames="true" Key="myKey" TreatZeroAsEmptyCell="false" />
  </Alea:Request>
</Alea:Document>

This table describes the attributes of the Alea:DataQuery element:

Attribute Value
UseOnlyBasicElements This attribute specifies the type of cells to include.

False: cells of any type are used (base, calculated, string).

True: calculated cells (on all levels, rule-calculated base cells as well) are not considered.

This attribute is optional. If this attribute is included, it overrides the attribute from DataareaDefine.

NonExistentCellSuppression This attribute specifies if empty cells are included in the respective query. It can be true or false. A special case is that a string cell can contain an empty string. This is not the same as an empty cell.

This attribute is optional. If this attribute is included, it overrides the attribute from DataareaDefine.

Included empty cells change the resulting hash value even if the element names are not included.
TreatZeroAsEmptyCell This attribute specifies the handling of zero values. It is useful in conjunction with NonExistentCellSuppression to remove differences because of minimal calculation inaccuracies.

True: all zero values between -1E-10 and 1E-10 are treated as an empty cell.

False: all zero values are used for the hash calculation.

This attribute is required.
IncludeElementNames This attribute defines whether element names are included in building the hash values. It can be true or false.

This attribute is required.

Key This attribute indicates the key for the hash calculation. This attribute is optional.

Answer

<Alea:Document xmlns:Alea="http://www.misag.com">
  <Alea:Request RequestID="002">
    <Alea:Value>0C0A3CD93D5E4D3107A2B75452BCF49627C77416</Alea:Value>
  </Alea:Request>
</Alea:Document>

Error

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