DefaultFreq

Gets the default frequency for the current Scenario member or for a specified scenario member. This function can be used in these types of rules:

• Calculation

• Translation

• Consolidation

• Allocation

Syntax

HS.Scenario.DefaultFreq("Scenario")

HS.Scenario.DefaultFreq("")

Note:

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

where Scenario is the name of a valid Scenario member.

Return Value

A string that contains the default frequency for the scenario.

Example

In this example, if the default frequency for the Actual scenario is YTD, then statements between the If...Then and End If statements are executed.

If HS.Scenario.DefaultFreq("Actual") = "YTD" Then

  ...

End If