CalcStatus

Gets the calculation status for the specified point of view. This function can be used in these types of rules:

Syntax

HS.CalcStatus("Scenario.Year.Period.Entity.Value")

Table 45. Syntax for CalcStatus Function

Parameter

Description

Scenario

Name of a valid Scenario member.

Year

A valid year.

Period

A valid period.

Entity

Name of a valid Entity member.

Value

Name of a valid Value member.

Return Value

A String that contains the calculation status for the specified point of view. Valid status codes are listed below.

Table 46. Calculation Status Codes  

Status Code

Description

OK

None of the data for the specified Scenario, Year, Period, Entity, and Value dimensions has changed.

OK ND

OK - No data. Some data may have changed.

OK SC

OK - System changed. Some of the data for the specified Scenario, Year, Period, Entity, and Value dimensions has changed. For example, a new rules file or metadata file has been loaded.

CH

Needs Calculation. At least one data cell for the specified Scenario, Year, Period, Entity, and Value dimensions has been changed, or metadata parameters or rules have changed. As a result, other data cells in this Scenario, Year, Period, Entity, and Value dimension may not be up to date because the SubCalculate routine has not been executed. For base level entities, the data cell may have been entered by manual data entry or by a bulk data file load. For entities, the data cell may have been entered by a journal posting.

CH ND

Needs Calculation — No Data. This indicates the first time that calculation will be performed on the cell.

TR

Needs Translation. The selected Value dimension member is not the entity’s default currency, and its translated values may not be up to date.

TR ND

Needs Translation — No Data. This indicates the first time that translation will be performed on the cell.

CN

Needs Consolidation. The data for the specified Scenario, Year, Period, Entity, and Value dimensions may not be up to date because data for a child entity has changed, data for the same entity's default currency has changed, or metadata parameters or rules have changed.

CN ND

Needs Consolidation - No Data. The parent has no data but a child of the parent has changed. This indicates the first time that consolidation will be performed on the cell.

Locked

The data for the specified Scenario, Year, Period, Entity, and Value dimensions has been locked by an administrator and can no longer be modified by manual data entry or calculations.

Note:

You can use the Alloc function to modify data in a locked destination POV.

NoData

No data exists for the specified Scenario, Year, Period, Entity, and Value dimensions.

Example

In this example, if the status for the specified point of view is “OK”, then statements between the If...Then and End If statements are executed.

If HS.CalcStatus("S#Actual.Y#2009.P#January.E#Connecticut.
V#<EntityCurrency>") = "OK" Then
  ...
End If