Available Methods

« How to Specify Objects | Building Expressions »

Designer Administrator

This manual is in pilot operation.

Below are the methods available for each object.

Table of Contents

Available Methods

Dimension Group

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
item	First argument `string`: Dimension label	Returns the dimension with the specified label. `Dimensions.item("#ACCOUNT")` is equivalent to `Dimensions!#ACCOUNT`. Please see Notes on Item Methods for more details.
cur	(None)	Returns the current dimension. This object is only valid within a member selection expression in a member list. The object returned is the dimension that the member list applies to. `Dimensions.cur` is equivalent to `Dimensions!@cur`.

item

First argument: string: Dimension label

Returns the dimension with the specified label.

Dimensions.item("#ACCOUNT") is equivalent to Dimensions!#ACCOUNT.
Please see Notes on Item Methods for more details.

cur

(None)

Returns the current dimension. This object is only valid within a member selection expression in a member list. The object returned is the dimension that the member list applies to.

Dimensions.cur is equivalent to Dimensions!@cur.

Dimension

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
label	(None)	Returns the label of the dimension.
name	(None)	Returns the name of the dimension.
desc	(None)	Returns the description of the dimension.
item	First argument `string`: Member label	Returns the member with the specified label. `#ACCOUNT.item("SALES")` is equivalent to `#ACCOUNT!SALES`. Please refer to Notes on Item Methods for more details.
cur	(None)	Returns the current member. `#ACCOUNT.cur` is equivalent to `#ACCOUNT!@cur`.
pov	(None)	Returns the point of view member. `#ACCOUNT.pov` is equivalent to `#ACCOUNT!@pov`.
rkey	(None)	Returns the responsibility scope key member. `#ACCOUNT.rkey` is equivalent to `#ACCOUNT!@rkey`.

label

(None)

Returns the label of the dimension.

name

(None)

Returns the name of the dimension.

desc

(None)

Returns the description of the dimension.

item

First argument: string: Member label

Returns the member with the specified label.

#ACCOUNT.item("SALES") is equivalent to #ACCOUNT!SALES.
Please refer to Notes on Item Methods for more details.

cur

(None)

Returns the current member.

#ACCOUNT.cur is equivalent to #ACCOUNT!@cur.

pov

(None)

Returns the point of view member.

#ACCOUNT.pov is equivalent to #ACCOUNT!@pov.

rkey

(None)

Returns the responsibility scope key member.

#ACCOUNT.rkey is equivalent to #ACCOUNT!@rkey.

Member

Method Arguments
(Optional arguments are enclosed in []) Functionality

label

(None)

Returns the label of the member.

name

(None)

Returns the name of the member.

desc

(None)

Returns the description of the member.

item

First argument: string: Property label

Returns the value of the property with the specified label.

#ACCOUNT!SALES.item("#ACTIVE") is equivalent to #ACCOUNT!SALES!#ACTIVE.
Please refer to Notes on Item Methods for more details.

is_child_of

First argument: Member object

Returns TRUE if the member calling the method is a direct child of the member provided as an argument. Otherwise, returns FALSE.

Example：

  #ACCOUNT!@cur.is_child_of(#ACCOUNT!#SALES) (1)

1	Returns `TRUE` only if the current account member is a child of the account member with the label `SALES`.

is_descendent_of

First argument: Member object

Returns TRUE if the member calling the method is a descendant (either direct or indirect child) of the member provided as an argument. Otherwise, returns FALSE.

Example：

  #ACCOUNT!@cur.is_descendent_of(#ACCOUNT!#SALES) (1)

1	Returns `TRUE` only if the current account member is a descendant of the account member with the label `SALES`.

ancestor

First argument: Member object: Common ancestor member object
Second argument: string: Member category property label
Third argument: string: Member category property value

Returns one ancestor member (either direct or indirect parent) that meets specified conditions among the ancestors of the member calling the method. If multiple such members exist, it returns the one located lowest.

The conditions are specified in the second and third arguments. For details, see Filtering by Member Category Properties.

Example：

  DEPT!@cur.ancestor(DEPT!ALL, "DEPT_TYPE", "DIV") (1)

1	Returns a member from the `Department/DEPT` dimension that is an ancestor of the current member, belonging to the member tree under the `ALL` member and having the `Department Type/DEPT_TYPE` property value `Division/DIV`.

lowest_common_ancestor

First argument: Member object: Member object 1
Second argument: Member object: Member object 2
Third argument: string: Member category property label
Fourth argument: string: Member category property value

Searches for and returns the lowest common ancestor member of two given members within a specific member tree. The member tree considered for this method starts at the vertex.

The conditions are specified in the third and fourth arguments. For details, see Filtering by Member Category Properties. If multiple members meet the conditions, the one located lowest is returned.

Example：

  DEPT!ALL.lowest_common_ancestor(DEPT!@CUR, DEPT!@POV, "#LEAF", "FALSE") (1)

1	Returns the common ancestor member of `DEPT!@CUR` and `DEPT!@POV` in the `Department/DEPT` dimension, which is not a leaf (`FALSE`), among the descendants of the `ALL` member.

shares_ancestors_with

First argument: Member object
Second argument: boolean: Logical value specifying whether to limit the search to active ancestors
Third argument: string: Member category property label
Fourth argument: string: Member category property value

Determines whether the member calling the method and the member provided as an argument have a common ancestor member (either themselves or their direct and indirect parents) that meets the specified conditions. Returns TRUE if such an ancestor member exists, otherwise returns FALSE.

Second argument: Specify TRUE to limit the search to active ^[1] ancestors. Specify FALSE to not limit the search.

The other conditions are specified in the third and fourth arguments. For details, see Filtering by Member Category Properties.

Example：

  DEPT!@cur.shares_ancestors_with(DEPT!@pov, TRUE, "DEPT_TYPE", "DIV") (1)

1	Returns `TRUE` only if the current member and the point of view member of the `Department/DEPT` dimension belong to the same division, provided that the `Department Type/DEPT_TYPE` property value is `Division/DIV`.

1. A value of the Is Active property.

Filtering by Member Category Properties

Some methods concerning dimension members use Member Category Property Labels and Member Category Property Values as arguments to filter the target members. The filtering conditions are as follows:

If the Member Category Property Label is blank, no filtering is performed.
If the Member Category Property Label is specified as #LABEL, filtering is performed by examining the member label.
Otherwise, filtering is performed by examining the value of the property specified by the Member Category Property Label.
During the inspection, if the member’s label (in case of 2) or the property value (in case of 3) matches the value pattern specified in the Member Category Property Value, the check is passed. Wildcard characters ? and * can be used in the Member Category Property Value. ? matches any single character, and * matches any string.

Determining Relationships Between Members of Different Dimensions

Some methods related to members determine the relationships between members. These methods typically require multiple members as arguments and targets, and these members generally need to belong to the same dimension.

However, as an exception, if the dimensions to which these multiple members belong are the same, it is possible to determine relationships between members of different dimensions using these methods. "Being the same" in terms of two dimensions means that one borrows from the other or both share a common borrowed dimension, as described in Borrowing Dimensions.

The return values of these methods may also be member objects. In such cases, the dimension of the returned member object will be the dimension of the member object that was the target of the method.

Properties

Method	Arguments (Optional arguments are enclosed in [])	Functionality
label	(None)	Returns the label of the property value.
name	(None)	Returns the name of the property value.
desc	(None)	Returns the description of the property value.

Method

Arguments
(Optional arguments are enclosed in [])

Functionality

label

(None)

Returns the label of the property value.

name

(None)

Returns the name of the property value.

desc

(None)

Returns the description of the property value.

Ledger Groups

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
item	First argument `string`: Ledger label	Returns the ledger with the specified label. `Ledgers.item("PL")` is equivalent to `Ledgers!PL`. Please refer to Considerations on Item Methods for more details.
cur	(None)	Returns the ledger associated with the current cell being accessed. `Ledgers.cur` is equivalent to `Ledgers!@CUR`.

item

First argument: string: Ledger label

Returns the ledger with the specified label.

Ledgers.item("PL") is equivalent to Ledgers!PL.
Please refer to Considerations on Item Methods for more details.

cur

(None)

Returns the ledger associated with the current cell being accessed.

Ledgers.cur is equivalent to Ledgers!@CUR.

Ledger

Method	Arguments (Optional arguments are enclosed in [])	Functionality
label	(None)	Returns the label of the ledger.
name	(None)	Returns the name of the ledger.
desc	(None)	Returns the description of the ledger.

Method

Arguments
(Optional arguments are enclosed in [])

Functionality

label

(None)

Returns the label of the ledger.

name

(None)

Returns the name of the ledger.

desc

(None)

Returns the description of the ledger.

Ledger Edition Groups

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
item	First argument `string`: Ledger Edition Key	Returns the ledger edition with the specified ledger edition key. `Editions.item("PUBLIC")` is equivalent to `Editions!PUBLIC`. Please refer to Considerations on Item Methods for more details.
cur	(None)	Returns the current ledger edition being accessed. `Editions.cur` is equivalent to `Editions!@CUR`.

item

First argument: string: Ledger Edition Key

Returns the ledger edition with the specified ledger edition key.

Editions.item("PUBLIC") is equivalent to Editions!PUBLIC.
Please refer to Considerations on Item Methods for more details.

cur

(None)

Returns the current ledger edition being accessed.

Editions.cur is equivalent to Editions!@CUR.

Ledger Edition

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
key	(None)	Returns the ledger edition key.
owner_label	(None)	Returns the label of the participant owning the ledger edition. Specifically, when the ledger edition is a "Workspace Edition of Each Participant" generated by the process management function, this method returns the last part when the ledger edition key is split by periods. In other cases, it returns an empty string. Please note that this method also returns an empty string for Ledger Editions of Submission Packages.
is_submission	(None)	Returns `TRUE` if the ledger edition represents a submission package, otherwise returns `FALSE`.

key

(None)

Returns the ledger edition key.

owner_label

(None)

Returns the label of the participant owning the ledger edition.

Specifically, when the ledger edition is a "Workspace Edition of Each Participant" generated by the process management function, this method returns the last part when the ledger edition key is split by periods. In other cases, it returns an empty string.
Please note that this method also returns an empty string for Ledger Editions of Submission Packages.

is_submission

(None)

Returns TRUE if the ledger edition represents a submission package, otherwise returns FALSE.

Cell Range

Method Arguments
(Optional arguments are enclosed in []) Functionality

Method	Arguments (Optional arguments are enclosed in [])	Functionality
total	(None)	Returns the aggregate value of document cells within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present in the range, the error value `#VALUE` is returned. If the range contains error values such as `#VALUE!` or `#N/A`, those error values are returned.
max (fusion_place >= 10.0)	(None)	Returns the maximum value of document cells within the cell range. Numerical values are assessed as debit+, increase+. If non-numerical values are present or if the range contains error values such as `#VALUE!`, `#N/A`, those values are skipped.
min (fusion_place >= 10.0)	(None)	Returns the minimum value of document cells within the cell range. Numerical values are assessed as debit+, increase+. If non-numerical values are present or if the range contains error values such as `#VALUE!`, `#N/A`, those values are skipped.
is_empty	(None)	Returns `TRUE` if all cells within the cell range are empty, otherwise returns `FALSE`. Numerical cells are considered empty only when their value is zero, while other cells are considered empty only when their value is an empty string.
is_protected	(None)	Returns `TRUE` if all cells within the cell range are non-editable, otherwise returns `FALSE`.
is_open	(None)	Returns `TRUE` if all cells within the cell range are in an open period, otherwise returns `FALSE`.
value	(None)	Returns the value of the top-left cell in the cell range. If the value is numerical, it is returned with a sign as debit+, increase+. Be aware that the displayed text value and the sign may differ.
text	(None)	Returns the exact string value displayed in the top-left cell of the cell range. Note that the `text` method returns a string value even if the cell’s value is numerical.
count (fusion_place >= 12.1)	(None)	Returns the count of numerical cells in the document cell range within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present, those are skipped. If the range contains error values such as `#VALUE!` or `#N/A`, those error values are returned. Be aware that the results can change based on the loop specification setting "Hide if no data".
average (fusion_place >= 12.1)	(None)	Returns the average (arithmetic mean) of the values in the document cells within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present, the error value `#VALUE` is returned. If the range contains error values such as `#VALUE!`, `#N/A`, those error values are returned.

total

(None)

Returns the aggregate value of document cells within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present in the range, the error value #VALUE is returned. If the range contains error values such as #VALUE! or #N/A, those error values are returned.

max
(fusion_place >= 10.0)

(None)

Returns the maximum value of document cells within the cell range. Numerical values are assessed as debit+, increase+. If non-numerical values are present or if the range contains error values such as #VALUE!, #N/A, those values are skipped.

min
(fusion_place >= 10.0)

(None)

Returns the minimum value of document cells within the cell range. Numerical values are assessed as debit+, increase+. If non-numerical values are present or if the range contains error values such as #VALUE!, #N/A, those values are skipped.

is_empty

(None)

Returns TRUE if all cells within the cell range are empty, otherwise returns FALSE.
Numerical cells are considered empty only when their value is zero, while other cells are considered empty only when their value is an empty string.

is_protected

(None)

Returns TRUE if all cells within the cell range are non-editable, otherwise returns FALSE.

is_open

(None)

Returns TRUE if all cells within the cell range are in an open period, otherwise returns FALSE.

value

(None)

Returns the value of the top-left cell in the cell range. If the value is numerical, it is returned with a sign as debit+, increase+. Be aware that the displayed text value and the sign may differ.

text

(None)

Returns the exact string value displayed in the top-left cell of the cell range. Note that the text method returns a string value even if the cell’s value is numerical.

count
(fusion_place >= 12.1)

(None)

Returns the count of numerical cells in the document cell range within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present, those are skipped. If the range contains error values such as #VALUE! or #N/A, those error values are returned. Be aware that the results can change based on the loop specification setting "Hide if no data".

average
(fusion_place >= 12.1)

(None)

Returns the average (arithmetic mean) of the values in the document cells within the cell range. Numerical values are aggregated as debit+, increase+, and if non-numerical values are present, the error value #VALUE is returned. If the range contains error values such as #VALUE!, #N/A, those error values are returned.

Considerations on Item Methods

For dimension groups, dimensions, members, and ledger group objects, if an object with the label specified in the Item method’s argument does not exist and the label value is fixed at the time of formula writing, the formula will result in an error. Otherwise, the Item method will return an object at runtime that has both a label and a name as empty strings. Therefore, if the label of the returned object is an empty string, it can be concluded that no object with the label specified in the argument exists.

The Item method of ledger edition group objects returns a ledger edition object with the specified ledger edition key, regardless of whether the ledger edition exists (such an edition is not actually generated).

About Object Names and Languages

The names of objects in fusion_place are multilingual. The name returned by the name method in a text formula pertains to the name registered for the "currently selected language." If no name is registered for the currently selected language, the name in English is returned.

The "currently selected language" varies depending on the situation. When names are displayed on screens, the "current language" is the display language selected in the menu. During server-side processing, the language specified on the client-side may be applied, or English may be uniformly applied. This is touched upon appropriately in the explanations of each process.

Using names for purposes other than data display, such as in ledger masks, access permission types, calculation of target values in forms, validation rules, and formulas in import specifications, is not recommended.

About Object Descriptions

An object’s description combines its label and name as appropriate for display. The method of displaying descriptions can be selected via the Options Object Display in the [Manager] / [Browser] / [Contributor] menus. In processes not involving screen display, the name is considered as the selected description. In server-side calculations, the name is always used as the description by this rule, so please be aware. The same rules apply to the display language of the description as to the name.

Using descriptions for purposes other than data display, such as in ledger masks, access permission types, calculation of target values in forms, validation rules, and formulas in import specifications, is not recommended.