Consolidate

Consolidates an entity’s data for the specified Scenario, Year, and Period dimension members.

Syntax

<HFMwCalculate>.Consolidate bstrScenario, bstrYear, bstrStartPeriod, bstrEndPeriod, bstrEntity, bstrParent, lConsolidationType

Argument

Description

bstrScenario

The label of the Scenario dimension member.

Input argument. String subtype.

bstrYear

The label of the Year dimension member.

Input argument. String subtype.

bstrStartPeriod

The label of the first Period dimension member in the range of periods for which the consolidation is being executed.

Input argument. String subtype.

bstrEndPeriod

The label of the last Period dimension member in the range of periods for which the consolidation is being executed.

Input argument. String subtype.

bstrEntity

The label of the child Entity dimension member.

Input argument. String subtype.

bstrParent

The label of the bstrEntity argument’s parent.

Input argument. String subtype.

lConsolidationType

Specifies the type of consolidation to be performed. Valid values are represented by the HFMConstants type library constants listed in Consolidation Type Constants.

Input argument. Long subtype.

Example

The following function takes dimension member labels that are passed to Consolidate and performs a consolidation for only those entities that contain data.

Function ConsolidateAllData(sScen, sYear, sStartPer, sEndPer, _ 
sChild, sPar) 
Dim cHFMCalc
Set cHFMCalc = Server.CreateObject("Hyperion.HFMwCalculate")
' cHFMSession is a previously set HFMwSession object
cHFMCalc.SetWebSession cHFMSession
cHFMCalc.Consolidate sScen, sYear, sStartPer, sEndPer, sChild, sPar, CONSOLIDATE_ALLWITHDATA
End Function