- First argument
-
string
: Dimension label
Available Methods
This manual is in pilot operation.
|
Below are the methods available for each object.
Dimension Group
Method | Arguments (Optional arguments are enclosed in []) |
Functionality |
---|---|---|
item |
Returns the dimension with the specified label.
|
|
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.
|
Dimension
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 |
|
Returns the member with the specified label.
|
cur |
(None) |
Returns the current member.
|
pov |
(None) |
Returns the point of view member.
|
rkey |
(None) |
Returns the responsibility scope key member.
|
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 |
|
Returns the value of the property with the specified label.
|
||
is_child_of |
|
Returns Example:
|
||
is_descendent_of |
|
Returns Example:
|
||
ancestor |
|
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:
|
||
lowest_common_ancestor |
|
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:
|
||
shares_ancestors_with |
|
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
The other conditions are specified in the third and fourth arguments. For details, see Filtering by Member Category Properties. Example:
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. |
Ledger Groups
Method | Arguments (Optional arguments are enclosed in []) |
Functionality |
---|---|---|
item |
|
Returns the ledger with the specified label.
|
cur |
(None) |
Returns the ledger associated with the current cell being accessed.
|
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 |
---|---|---|
item |
|
Returns the ledger edition with the specified ledger edition key.
|
cur |
(None) |
Returns the current ledger edition being accessed.
|
Ledger Edition
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. |
is_submission |
(None) |
Returns |
Cell Range
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 |
max |
(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 |
min |
(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 |
is_empty |
(None) |
Returns |
is_protected |
(None) |
Returns |
is_open |
(None) |
Returns |
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 |
count |
(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 |
average |
(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 |
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
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.