Available Methods

« How to Specify Objects | Building Expressions »

Designer Administrator

This manual is in pilot operation.

The methods available for each object are as follows.

Table of Contents

Available Methods

Dimension Groups

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

Method	Arguments (Optional arguments are enclosed in [])	Function
item	Argument 1 `String`: Dimension Label	Returns the dimension with the specified label. `Dimensions.item("#ACCOUNT")` is equivalent to `Dimensions!#ACCOUNT`. If the desired object does not exist, an empty object is returned.
cur	None	Returns the current dimension. `cur` returns an object valid only within a member selection expression in a member list. The returned object is the dimension to which the member list is applied. `Dimensions.cur` is equivalent to `Dimensions!@cur`. If the desired object does not exist, an empty object is returned.

item

Argument 1: String: Dimension Label

Returns the dimension with the specified label.

Dimensions.item("#ACCOUNT") is equivalent to Dimensions!#ACCOUNT.
If the desired object does not exist, an empty object is returned.

cur

None

Returns the current dimension. cur returns an object valid only within a member selection expression in a member list. The returned object is the dimension to which the member list is applied.

Dimensions.cur is equivalent to Dimensions!@cur.
If the desired object does not exist, an empty object is returned.

Dimension

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

Method	Arguments (Optional arguments are enclosed in [])	Function
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	Argument 1 `String`: Member Label	Returns the member with the specified label. `#ACCOUNT.item("SALES")` is equivalent to `#ACCOUNT!SALES`. If the desired object does not exist, an empty object is returned.
cur	None	Returns the current member. `#ACCOUNT.cur` is equivalent to `#ACCOUNT!@cur`. If the desired object does not exist, an empty object is returned.
pov	None	Returns the POV member. `#ACCOUNT.pov` is equivalent to `#ACCOUNT!@pov`. If the desired object does not exist, an empty object is returned.
rkey	None	Returns the Responsibility Key Member. `#ACCOUNT.rkey` is equivalent to `#ACCOUNT!@rkey`. If the desired object does not exist, an empty object is returned.

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

Argument 1: String: Member Label

Returns the member with the specified label.

#ACCOUNT.item("SALES") is equivalent to #ACCOUNT!SALES.
If the desired object does not exist, an empty object is returned.

cur

None

Returns the current member.

#ACCOUNT.cur is equivalent to #ACCOUNT!@cur.
If the desired object does not exist, an empty object is returned.

pov

None

Returns the POV member.

#ACCOUNT.pov is equivalent to #ACCOUNT!@pov.
If the desired object does not exist, an empty object is returned.

rkey

None

Returns the Responsibility Key Member.

#ACCOUNT.rkey is equivalent to #ACCOUNT!@rkey.
If the desired object does not exist, an empty object is returned.

Member

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

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

Argument 1: String: Property Label

Returns the value of the property with the specified label.

#ACCOUNT!SALES.item("#ACTIVE") is equivalent to #ACCOUNT!SALES!#ACTIVE.
If the desired object does not exist, an empty object is returned.

is_child_of

Argument 1: Member Object

Returns TRUE if the calling member is a child (directly below) of the member given 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 labeled `SALES`.

is_descendent_of

Argument 1: Member Object

Returns TRUE if the calling member is a descendant (including itself and its direct and indirect children) of the member given 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 labeled `SALES`.

ancestor

Argument 1: Member Object: Common Ancestor Member Object
Argument 2: String: Member Classification Property Label
Argument 3: String: Member Classification Property Value

Returns one ancestor member (including itself and its direct and indirect parents) of the calling member that meets the specified conditions. If multiple members meet the conditions, the lowest one is returned.

The conditions are specified by Argument 2 and Argument 3. For details, please refer to Filtering Members by Classification Properties.

If the desired object does not exist, an empty object is returned.

Example)

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

1	Returns a member in the `Department/DEPT` dimension, under the current member's parent members, belonging to the member tree below `ALL` and having the `Department Type/DEPT_TYPE` property value of `Division/DIV`.

lowest_common_ancestor

Argument 1: Member Object: Member Object 1
Argument 2: Member Object: Member Object 2
Argument 3: String: Member Classification Property Label
Argument 4: String: Member Classification Property Value

Searches for and returns the lowest common ancestor member of two members within a specified member tree. The calling member is the root of the member tree to be searched.

The conditions are specified by Argument 3 and Argument 4. For details, please refer to Filtering Members by Classification Properties. If multiple members meet the conditions, the lowest one is returned.

If the desired object does not exist, an empty object is returned.

Example)

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

1	Returns a member among the descendants of the `ALL` member in the `Department/DEPT` dimension that is a common ancestor of `DEPT!@CUR` and `DEPT!@POV`, and has a `Leaf Status` property value of `Not Leaf (FALSE)`.

shares_ancestors_with

Argument 1: Member Object
Argument 2: Boolean: Logical value specifying whether to limit the search to active ancestors
Argument 3: String: Member Classification Property Label
Argument 4: String: Member Classification Property Value

Determines whether the calling member and the member given as an argument share a common ancestor member (including itself and its direct and indirect parents) that meets the specified conditions. Returns TRUE if such an ancestor exists, otherwise returns FALSE.

Argument 2: Specify TRUE to limit the search to active ancestors ^[1]. Specify FALSE otherwise.

Other conditions are specified by Argument 3 and Argument 4. For details, please refer to Filtering Members by Classification Properties.

Example)

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

1	Returns `TRUE` only if the current member and POV member in the `Department/DEPT` dimension share a common department under the assumption that a department with the `Department Type/DEPT_TYPE` property value of `Division/DIV` is indeed a division.

1. Active refers to the value of the Is Active property.

Filtering Members by Classification Properties

Some methods related to dimension members perform filtering on the target members using the Member Classification Property Label and Member Classification Property Value provided as arguments. The filtering conditions are as follows:

No filtering is performed if the Member Classification Property Label is a blank value.
If #LABEL is specified as the Member Classification Property Label, the filtering is performed based on the member label.
Otherwise, filtering is performed based on the property value specified by the Member Classification Property Label.
In the examination, if the label of the member in case 2, or the property value in case 3, matches the value pattern specified by the Member Classification Property Value, the examination is deemed successful. Wildcard characters ? and * can be used in the Member Classification Property Value. ? matches any single character, and * matches any string.

Possibility of Determining Relationships Between Members Belonging to Different Dimensions

Some methods related to members determine the relationships between members. These methods are provided with multiple members as the method’s target and arguments. As a general rule, these multiple members must belong to the same dimension.

However, as an exception to the above, if the contents of the dimensions to which these multiple members belong are the same, these methods can determine the relationships between members of different dimensions. If the "contents are the same" for two dimensions, it means that either one borrows from the other borrowing, or both borrow from the same dimension.

Some of these methods return member objects. In such cases, the dimension to which the returned member object belongs is the same as the dimension of the member object that was the target of the method.

Properties

Method	Arguments (Optional arguments are enclosed in [])	Function
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 [])

Function

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 []) Function

Method	Arguments (Optional arguments are enclosed in [])	Function
item	Argument 1 `String`: Ledger Label	Returns the ledger with the specified label. `Ledgers.item("PL")` is equivalent to `Ledgers!PL`. If the desired object does not exist, an empty object is returned.
cur	None	Returns the ledger associated with the currently accessed cell. `Ledgers.cur` is equivalent to `Ledgers!@CUR`.

item

Argument 1: String: Ledger Label

Returns the ledger with the specified label.

Ledgers.item("PL") is equivalent to Ledgers!PL.
If the desired object does not exist, an empty object is returned.

cur

None

Returns the ledger associated with the currently accessed cell.

Ledgers.cur is equivalent to Ledgers!@CUR.

Ledger

Method	Arguments (Optional arguments are enclosed in [])	Function
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 [])

Function

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 Editions

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

Method	Arguments (Optional arguments are enclosed in [])	Function
item	Argument 1 `String`: Ledger Edition Key	Returns the ledger edition with the specified ledger edition key. `Editions.item("PUBLIC")` is equivalent to `Editions!PUBLIC`. If the desired object does not exist, an empty object is returned.
cur	None	Returns the currently accessed ledger edition. `Editions.cur` is equivalent to `Editions!@CUR`.

item

Argument 1: String: Ledger Edition Key

Returns the ledger edition with the specified ledger edition key.

Editions.item("PUBLIC") is equivalent to Editions!PUBLIC.
If the desired object does not exist, an empty object is returned.

cur

None

Returns the currently accessed ledger edition.

Editions.cur is equivalent to Editions!@CUR.

Ledger Edition

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

Method	Arguments (Optional arguments are enclosed in [])	Function
key	None	Returns the ledger edition key.
owner_label	None	Returns the label of the participant that owns the ledger edition. Specifically, this method returns the last part of the ledger edition key when the ledger edition is a workspace edition for each participant generated by the process management function. In other cases, it returns an empty string. Please also note that this method also returns an empty string for submission package ledger editions.
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 that owns the ledger edition.

Specifically, this method returns the last part of the ledger edition key when the ledger edition is a workspace edition for each participant generated by the process management function. In other cases, it returns an empty string.
Please also note that this method also returns an empty string for submission package ledger editions.

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 []) Function

Method	Arguments (Optional arguments are enclosed in [])	Function
total	None	Returns the total value of document cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there is a non-numeric value in the range, the error value `#VALUE` is returned. If the range contains error values such as `#VALUE!`, `#N/A`, etc., those error values are returned.
max (fusion_place >= 10.0)	None	Returns the maximum value of document cells within the cell range. Numeric values are judged as Debit+ and Increase+. If there are non-numeric values in the range, or if the range contains error values such as `#VALUE!`, `#N/A`, etc., those values are skipped.
min (fusion_place >= 10.0)	None	Returns the minimum value of document cells within the cell range. Numeric values are judged as Debit+ and Increase+. If there are non-numeric values in the range, or if the range contains error values such as `#VALUE!`, `#N/A`, etc., those values are skipped.
is_empty	None	Returns `TRUE` if all cells within the cell range are empty, otherwise returns `FALSE`. Numeric cells are considered empty only when the value is zero, and non-numeric cells are considered empty only when the value is an empty string.
is_protected	None	Returns `TRUE` if all cells within the cell range are not editable, otherwise returns `FALSE`.
is_open	None	Returns `TRUE` if the period is open for all cells within the cell range, otherwise returns `FALSE`.
value	None	Returns the value of the top-left cell within the cell range. If the value is numeric, the signed value is returned as Debit+ and Increase+. Please note that the sign may differ from the displayed text value.
text	None	Returns the text value as displayed in the top-left cell within the cell range. Even if the value of the cell is numeric, the `text` method returns the text value, so please be aware of this.
count (fusion_place >= 12.1)	None	Returns the count of numeric cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there are non-numeric values in the range, those values are skipped. If the range contains error values such as `#VALUE!`, `#N/A`, etc., those error values are returned. Note that the result may vary depending on the loop specification "Hide when no data".
average (fusion_place >= 12.1)	None	Returns the average (arithmetic mean) of the values of document cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there is a non-numeric value in the range, the error value `#VALUE` is returned. If the range contains error values such as `#VALUE!`, `#N/A`, etc., those error values are returned.

total

None

Returns the total value of document cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there is a non-numeric value in the range, the error value #VALUE is returned. If the range contains error values such as #VALUE!, #N/A, etc., those error values are returned.

max
(fusion_place >= 10.0)

None

Returns the maximum value of document cells within the cell range. Numeric values are judged as Debit+ and Increase+. If there are non-numeric values in the range, or if the range contains error values such as #VALUE!, #N/A, etc., those values are skipped.

min
(fusion_place >= 10.0)

None

Returns the minimum value of document cells within the cell range. Numeric values are judged as Debit+ and Increase+. If there are non-numeric values in the range, or if the range contains error values such as #VALUE!, #N/A, etc., those values are skipped.

is_empty

None

Returns TRUE if all cells within the cell range are empty, otherwise returns FALSE.
Numeric cells are considered empty only when the value is zero, and non-numeric cells are considered empty only when the value is an empty string.

is_protected

None

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

is_open

None

Returns TRUE if the period is open for all cells within the cell range, otherwise returns FALSE.

value

None

Returns the value of the top-left cell within the cell range. If the value is numeric, the signed value is returned as Debit+ and Increase+. Please note that the sign may differ from the displayed text value.

text

None

Returns the text value as displayed in the top-left cell within the cell range. Even if the value of the cell is numeric, the text method returns the text value, so please be aware of this.

count
(fusion_place >= 12.1)

None

Returns the count of numeric cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there are non-numeric values in the range, those values are skipped. If the range contains error values such as #VALUE!, #N/A, etc., those error values are returned. Note that the result may vary depending on the loop specification "Hide when no data".

average
(fusion_place >= 12.1)

None

Returns the average (arithmetic mean) of the values of document cells within the cell range. Numeric values are aggregated as Debit+ and Increase+. If there is a non-numeric value in the range, the error value #VALUE is returned. If the range contains error values such as #VALUE!, #N/A, etc., those error values are returned.

Specifying Selection Criteria for Cell Ranges in Aggregation Methods (fusion_place >= 14.1)

In aggregation methods such as the total method, you can narrow down the selection range by specifying selection criteria as arguments. Applicable methods are listed in the table above.

Call Format

The call format of the method is as follows (example shown with the total method, but other methods follow the same format):
```
  [TargetRange].total(CriteriaRange, Criteria)
```
You can specify any number of criteria as pairs.
```
  [TargetRange].total(CriteriaRange1, Criteria1, CriteriaRange2, Criteria2, …)
```

The number of columns and rows in the target range and the criteria range must match. If they do not match, the aggregation method returns the error value #VALUE.

Format of Criteria

The criteria can be specified as either numbers or strings. For strings, you can use comparison operators at the beginning such as =, <>, >, >=, <, or ⇐.

  [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL2], "<=10")

  [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL2], "=EIGYO")

If no operator is specified, it is interpreted as if = is prefixed.

  [PRODUCT::LABEL1,LABEL2].total(
       [PRODUCT::LABEL1,LABEL2], 5)

  [PRODUCT::LABEL1,LABEL2].total(
       [PRODUCT::LABEL1,LABEL2], "")

Strings following = or <> can include wildcard characters * and ?. * matches any string, and ? matches any single character.

  [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "<>AA*")

  [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "BB???")

To treat wildcard characters * or ? as literal characters rather than wildcards, prefix them with a tilde ~ to escape them.

  [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "AB~*X")

The tilde is recognized as an escape character only when used in strings that contain either * or ?. For example, the string "AB*~X" is interpreted as "AB*X", while "AB~X" is interpreted as the literal string "AB~X", not ABX.

Empty objects

Methods and functions that return objects such as dimensions, members, properties, ledgers, etc., will result in an error if it is confirmed during writing and saving an expression that the corresponding object does not exist.

For example, the Item method of a dimension object takes a label as an argument, and if it is found when saving the object containing this expression that no member with that label exists, an error should occur.

On the other hand, if the existence of the corresponding object is confirmed at runtime, and the object does not indeed exist, such methods and functions return an "empty object.

" An empty object can be identified by its label and name being empty strings. Therefore, if the label of the returned object is an empty string, it can be determined that an object which fulfills the specified criteria does not exist.

Methods to which the above description applies

Type of Object	Method
Dimension Group	cur, item
Dimension	item, cur, pov, rkey
Dimension Member	item, lowest_common_ancestor, ancestor
Ledger Edition Group	item

Type of Object

Method

Dimension Group

cur, item

Dimension

item, cur, pov, rkey

Dimension Member

item, lowest_common_ancestor, ancestor

Ledger Edition Group

item

Functions to which the above description applies

find_in_path

An exception to the above is the Item method of the ledger editions object, which returns a ledger edition object with the specified ledger edition key regardless of whether a ledger edition with that key exists. (However, such a ledger edition is not actually generated.)

Object Names and Languages

The names of fusion_place objects are multilingual. The name returned by the name method in a text expression is 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 the name is displayed on the screen, the "current language" is the Display Language selected in the menu. In server-side processing, either the language specified on the client-side is applied, or English is uniformly applied. This is mentioned as appropriate in the explanations related to each processing, so please be aware.

When using text expressions for purposes other than data display, such as ledger masks, access permission types, calculation of writable target values in forms, validation rules, and calculation expressions in import specifications, it is not recommended to use names.

About Object Descriptions

The description of an object is a display that combines the object’s label and name as appropriate. The display method of the description can be selected in the menu: Options[Object Display] of the [Manager] / [Browser] / [Contributor] menus. In processes that do not involve screen display, the name is considered as the description. In server-side calculations, the name is always treated as the description according to this rule, so please be aware. The display language of the description follows the same rules as the name.

⚠ When using the Name method without arguments, if no name exists for the currently selected language, a name in an alternative language (locale) is selected according to the rules described in the section on Multilingual Support. However, if a language is explicitly specified as an argument, an empty string is returned if no name exists in that language.