« How to Use Objects - Calling "Methods"   |   Available Methods »

How to Specify Objects

Designer Administrator
This manual is in pilot operation.
Unless otherwise specified, the examples of expressions given in this section demonstrate non-member selection dialects. Member selection expressions and other dialects may interpret the same expression differently because objects specified by label constants differ, as explained here: Objects Specified by Label Constants.

There are four ways to specify objects:

1. Using Predefined Identifiers

Predefined identifiers include Dimensions, Ledgers, and Editions.

Dimensions represents a dimension group object. The dimension group object has no notable features and is used as a foothold to obtain individual dimension objects.

  Dimensions!#ACCOUNT (1)
1 Specifies the account dimension object. (For the ! symbol, see "Specifying a Child Object of an Already Specified Object").

Ledgers represents a ledger group object. The ledger group object is used to determine ledgers associated with cells specified by text expressions.

  Ledgers!@CUR.Label (1)
1 Represents the label of the "current" ledger (i.e., the ledger associated with cells specified by text expressions). (For the ! symbol and @ functions, see "Specifying a Child Object of an Already Specified Object").

Editions represents a group object of ledger editions. The ledger edition group object is used to know keys of currently accessed ledger editions.

  Editions!@CUR.Key (1)
1 Represents the key of the "current" ledger edition (i.e., the ledger edition being accessed). (For the ! symbol and @ functions, see "Specifying a Child Object of an Already Specified Object").

2. Using Label Constants

Objects can be specified by writing labels in the expression. The type of object specified by a label varies by the dialect of the expression. Specifically, in dialects other than "member selection" and "field value calculation", a dimension object is specified. In member selection, a property object is specified, and in field value calculation, a field object is specified.

  • For general dialects (i.e., other than member selection and field calculation):

  #ACCOUNT
    => Specifies the "Accounts" dimension object.

  • In the case of member selection:

  #LEAF
    => Specifies the "Leaf Division" property object of the member being inspected.

  • In the case of field value calculation:

  YEAR
    => Specifies the field object labeled "YEAR".

3. Specifying as a Child Object of an Already Specified Object

Using the methods above, starting from the specified object, its "child" objects can be specified. The child objects for each object are as follows:

Object Child Objects of the Object Listed

Dimension Group

Dimension

Dimension

Member

Member

Property Value

Ledger Group

Ledger

(Others)

(None)

To specify a child object, follow the expression specifying the parent object with a !, and then write the label or @ function of the child object.

  • Using a label:

  #ACCOUNT!PL1010
    => Specifies the member object related to the member labeled _"PL1010"_ in the "Accounts" dimension.

  • Using an @ function:

  #ACCOUNT!@CUR
    => Specifies the member object for the "current member" of the "Accounts" dimension.

The @ function can only be applied to objects of dimensions, ledger groups, and ledger edition groups. The usable functions are @CUR, @POV, @RKEY.

@ Functions Applicable to Dimension Group Objects

Function Member Specified

@CUR

Returns an object that is only valid within the member selection expression in the member list definition. The returned object is the "current dimension" to which the member list definition applies.

CUR: Current

@ Functions Applicable to Dimension Objects

Function Member Specified

@CUR

Current Member
CUR: Current

@POV

Point of View Member
POV: Point of View

@RKEY

Responsibility Range Key Member
RKEY: Responsibility Key

⚠ For details on "current members" and "point of view members," please refer to Member Variables.

@ Functions Applicable to Ledger Group Objects

Function Member Specified

@CUR

Current Ledger (i.e., the ledger associated with cells where text formulas are applied)
CUR: Current

@ Functions Applicable to Ledger Edition Group Objects

Function Member Specified

@CUR

Current Ledger Edition
CUR: Current

It is also possible to stack specifications of child objects across multiple levels.

  Dimensions!#ACCOUNT!@CUR!#LEAF (1)
1 Specifies the "Leaf Division" property object of the "current member" of the "Accounts" dimension. 
  Dimensions!@CUR!@CUR!#LEAF (1)
1 When described in the member selection expression of the member list definition, it specifies the "Leaf Division" property object of the "current member" of the current dimension.

4. Using a Cell Range Specifier

To specify a "cell range" object on a form, use a cell range specifier. There are two types of cell range specifiers: two-label and one-label formats. Cell range specifiers can only be used in certain dialects of expressions on the form. For more details, refer to List of Expression Dialects.

  • Two-label format

  [SALES, TOTAL]
    => Indicates the cell range at the intersection of the "Sales column" and the "Total row" (assuming SALES is the column label for "Sales", and TOTAL is the row label for "Total").

  • One-label format

  • When the text formula is used as a calculation formula in the form’s "column specification"

  [SALES]
    => Indicates the cell range at the intersection of the row where the formula is executed and the "Sales column" (under the same assumption).

  • When the text formula is used as a calculation formula in the form’s "row specification"

  [TOTAL]
    => Indicates the cell range at the intersection of the column where the formula is executed and the "Total row" (under the same assumption).