1. Administrator's Guide
  2. Rule Functions
  3. OpenCellTextUnit

OpenCellTextUnit

Retrieves the cell text for multiple cells. This function can be used in these types of rules:

  • Calculation

  • Translation

  • Consolidation

You can specify part of the POV for which to retrieve cell text, for example, Scenario and Year, instead of the entire POV. If you do not specify a page dimension member, (Scenario, Year, Period, Value, Entity), then cell text is returned only for the current member. If you do not specify a sub-cube dimension (Account, ICP, Custom), then the system returns cell text for all base and parent members. You can specify the Scenario and Year member to retrieve cell text for a sub-cube that is not the current sub-cube. You can also specify a member list for Period, Value, and/or Entity to retrieve cell text for more than one sub-cube. You can specify to retrieve cell text labels, and also whether to sort the cell text by Ascending or Descending order of dimension member or cell text label. If you do not specify a value for sorting, then no sorting is performed on the cell text unit, and results are returned based on their order in the database.

Syntax

Set CTU = HS.OpenCellTextUnit(POVExpression,Label(s),Sort_Dimension,Sort_Order)

Where POVExpression is a POV, Label is none, one, or more cell text labels, and Sort_Order is Ascending or Descending.

Return Value

Returns information on all the cell text and labels for the specified POV.

Example

Set CTU = HS.OpenCellTextUnit("S#Actual.Y#2014","","","")
Set CTU = HS.OpenCellTextUnit("S#Actual.Y#2014.P{.[Base]}.A{.[Base]}","","Period","Ascending")
Set CTU = HS.OpenCellTextUnit("S#Actual.Y#2014.E{.[Base]}.P{.[Base]}","CouponRate","LABEL","Ascending")
Set CTU = HS.OpenCellTextUnit("S#Actual.Y#2014.E{.[Base]}.P{.[Base]}.A#Purchases","","Brands","Descending")

If you want to retrieve cell text for multiple labels, you can enter the labels as comma-separated values. If you do not specify any value for Label(s), all labels are retrieved.

Example

Set CTU = HS.OpenCellTextUnit("A#Sales","Label-1,Label-2","Label","Descending")