ConsolidateYTD

Determines if the current Scenario member or a specified scenario member is consolidated year to date. This function can be used in these types of rules:

• Calculation

• Translation

• Consolidation

• Allocation

Syntax

HS.Scenario.ConsolidateYTD("Scenario")

HS.Scenario.ConsolidateYTD("")

where Scenario is the name of a valid Scenario member.

Use a blank string ("") to apply this function to the current member.

Return Value

A Boolean expression that is True if the scenario is consolidated using the year-to-date method, False if the scenario is consolidated using the periodic method.

Example

In this example, if the Actual scenario is set up to be consolidated using the year-to-date method, then statements between the If...Then and End If statements are executed.

If HS.Scenario.ConsolidateYTD("Actual") = TRUE Then

  ...

End If