HsvCalculate Type Library Overview

The HsvCalculate type library contains one object, the HsvCalculate object. Use this object to execute consolidations, translations, and calculations in Financial Management applications.

The HsvCalculate object is a child of the HsvSession object. Use HsvSession’s Calculate property to set HsvCalculate object references as shown in the following example:

  Dim cHsvCalculate as HsvCalculate
  Set cHsvCalculate = cHsvSession.Calculate

The following table lists the methods of the HsvCalculate object.

Table 22. HsvCalculate Object Methods

Method

Description

Allocate

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

Allocate2

Allocates an entity’s data across a range of periods for the specified Scenario, Year, and Value dimension members.

CalcEPU

Runs the Equity Pickup for the specified Scenario, Year, and Period.

ChartLogic

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

ChartLogic2

Calculates an entity’s data across a range of periods for the specified Scenario, Year, and Value dimension members.

Consolidate

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

Consolidate2

Consolidates an entity’s data across a range of periods for the specified Scenario and Year dimension members.

CustomLogic

For internal use.

FindOverlappingConsolidation

Indicates whether any consolidations are currently running or queued for the specified entity, scenario, year, and range of periods. If FindOverlappingConsolidation finds any such consolidations, the consolidations’ types and dimension member labels are returned.

GetCOMDLLRules

For internal use.

GetConsolidationProgress

For internal use.

GetDefaultExchangeRate

Returns the exchange rate between two currencies for the specified Point of View.

GetEPUInfo

Retrieves the equity pickup information for the specified Scenario, Year, and Period. The information returns include: owner, owned, percentage ownership, and status.

GetVBScriptRules

Returns the rules that have been loaded into an application. The rules are returned as an array of bytes.

IsEntityAnEPUOwner

Indicates whether the entity is an EPU owner for specified Scenario, Year, and Period.

LoadCalcManagerRules

For internal use.

LoadCalcManagerRules2

For internal use.

SetCOMDLLRules

For internal use.

SetVBScriptRules

Loads or scans a rules file.

SetVBScriptRules2

Loads or scans a rules file, optionally validating whether the rules violate the referential integrity of any intercompany transactions.

StopConsolidation

For internal use.

Translate

Translates an entity’s data from one currency to another for the specified Scenario, Year, Period, and Value dimension members.

Translate2

Translates an entity’s data from one currency to another across a range of periods for the specified Scenario, Year, and Value dimension members.

For detailed descriptions of these methods, see HsvCalculate Object Methods.