NumPeriods

Gets the number of periods defined for the frequency of the specified scenario. This function can be used in these types of rules:

• Calculation

• Translation

• Consolidation

• Allocation

Syntax

HS.Scenario.NumPeriods("ScenarioName")

or

HS.Scenario.NumPeriods(" ")

or

HS.Scenario.NumPeriods(Var1)

Return Value

Numeric value for the number of periods for the frequency. For example, if the scenario is monthly, the system returns 12 for the number of periods. If the scenario is quarterly, the system returns 4 for the number of periods.

Example

This example returns the number of periods defined for the frequency of the Actual scenario.

HS.Scenario.NumPeriods("Actual")