Clear

Removes data from combinations of Account, ICP, and Custom members. This function can be used in these types of rules:

  • Calculation

  • Translation

  • Consolidation

  • Allocation

Syntax

HS.Clear "Account.ICP.Custom1.Custom2.Custom3.Custom4"

Table 11-11 Syntax for Clear Function

Parameter Description

Account

Name of a valid Account member.

ICP

Name of a valid ICP member.

Custom1, Custom2, Custom3, Custom4

Name of valid Custom1, Custom2, Custom3, and Custom4 members.

To remove data from all cells that intersect the current point of view, which consists of the current Entity, Period, Scenario, Value, View, and Year members, place the ALL keyword after the A# characters as in this example:

HS.Clear "A#ALL"

To clear all intersections of cells and Custom or ICP dimensions, use the ALL keyword or omit the A# characters. This example omits the A# characters to clear data from all account intersections with the GolfBalls member of the Custom1 dimension:

HS.Clear "C1#GolfBalls"

Return Value

None.

Example

This example clears the data stored in the intersection of the Sales account and the GolfBalls member of the Custom1 dimension.

HS.Clear "A#Sales.C1#GolfBalls"