ImpactStatus

Changes the status of the specified data unit to impacted. This function can be used in Calculation rules.

Syntax

Combination of Scenario, Year, Period, Entity, and Value members. If the scenario is the same, the year and period combination must be a future period. If no value member is specified, it is assumed to be current.

HS.ImpactStatus"S#Scenario.Y#Year.P#Period.E#Entity.V#Value"

Table 11-30 Syntax for ImpactStatus Function

Parameter	Description
Scenario	Name of a valid Scenario dimension member.
Year	A valid year.
Period	A valid period.
Entity	Name of a valid Entity dimension member.
Value	Name of a valid Value dimension member.

Note:

If the specified POV is the same scenario, year, period, and entity as the data unit being processed, an error occurs and there is no impact to the data unit. If the target Period is locked when the rule is run, the system returns a VBScript error and there is no impact to the data unit.

Return Value

None.

Example

HS.ImpactStatus "S#Actual.Y#2014.P#January"