CalcStatus

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

Calculation
Translation
Consolidation
Allocation

Syntax

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

Table 11-9 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 11-10 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. The calculation has been effectively run, but calculations were not run for no data.
OK SC	OK - System changed. A change has taken place that may affect the data for the specified Scenario, Year, Period, Entity, and Value dimensions. For example, a new rules file, metadata file, or member list file has been loaded, or the currency rate has changed. The data itself, such as a value of 10,000 has not changed. Rather, some change has taken place, perhaps in a dimension member attribute. For example, the number of decimals associated with the account has been set to two, requiring the value to be changed to 10,000.00.
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 dimension may not be current because calculation has not been run. For base-level entities, you may have entered the data cell through data entry or by a data file load. For any entity, 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 current because any of the following has changed: Data for a child entity Data for the same entity's default currency Metadata parameters or rules
CN ND	Needs Consolidation - No Data. The parent has no data, but data for a child entity 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. It can no longer be modified manually or through calculations. 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.
NoAccess	The user does not have rights for the specified dimension member.

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.