Description of attributes for the Account dimension
The AccountsToDetail attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | accountsToDetail |
| Value returned | Set of parent account of the control group to be detailed. In case of: - filter on a control group, it returns the group’s parent account - filter on the account it returns the parent accounts of the control group to which the account belongs |
Example
$Account.accountsToDetail
Returns all accounts to be detailed of the control group specified in the filter (row/column, matrix, sheet, form) or of the control group to which the account specified in the filter belongs.
The CausalsGroup attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | causalsGroup |
| Attributes | - code - desc |
| Value returned | Any node of causals used to create the control group specified in the filter |
Examples
- $Account.causalsGroup.code
Returns the node of causals used to create the control group specified in the filter.
- $Account.causalsGroup.lowest
Returns all individual causals of the node of causals used to create the control group specified in the filter.
The GroupType attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | groupType |
| Attributes | - code - desc |
| Value returned | Type (code and description) of the control group specified in the filter. The following values are returned: - D - Details - F - Variation - Q - Balancing - C - Coherence In case of: - filter on control group returns the control group type - filter on account returns the type of the control group to which the account belongs |
Example
With filters on a Variation-type control group:
$Account.groupType.code: returns string "F"
$Account.groupType.desc: returns the “Variation" string or equivalent string, depending on the application language set by the user
The OriginalAccounts attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | originalAccounts |
| Value returned | Set of accounts related to a FST item. In case of: - filter on account, it returns the same account - FST items and nodes of a hierarchy defined on the account dimension, it is equivalent to the children() function and returns the related accounts - formula-type FST items, it progressively returns the accounts related to all FST items involved in the formula, including those involved indirectly, depending on the items to which other filters are related in a chain, up to the one to which the accounts are related. - control group/causal intersection, it returns the account present in the intersection |
The OriginalControlGroup attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | originalControlGroup |
| Value returned | Control group associated with a filter on an account. In case of: - filter on a control group, it returns the control group - filter on account taken from within a control group, it returns the control group to which the account belongs - filter on account taken from elsewhere (hierarchies, FSTs), it returns all control groups that detail the account |
Examples
- $Account.originalControlGroup.code
Returns the control group to which the account specified in the filter belongs
- $Account.originalControlGroup.controlGroup
Deploys the control group to which the account specified in the filter belongs, like in the Matrix Wizard.
- $Account.originalControlgroup.causalsGroup.code
Returns, given a filter on an account, the code of the detail-type node related to the control group to which the account belongs.
The Schema attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | template |
| Attributes | - code - desc - taxonomy |
| Value returned | Financial Statement Template to which the account specified in the filter belongs. If the account was chosen from a hierarchy defined on the account dimension, it returns an empty string |
Examples
$Account.schema.code
Returns the code of the FST to which the account specified in the filter belongs.
$Account.schema.desc
Returns the description of the FST to which the account specified in the filter belongs.
The ShortDesc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | shortDesc |
| Value returned | Short description in the language of the user of the specified account |
Example
$Account.shortDesc
Returns the description of the account specified in the filter.
The XBRLName attribute
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Syntax | xbrlName |
| Value returned | Value of the XBRL name field associated with a filter on the account. In particular, in case of: - a filter on an FST item, it returns the value of the XBRL name field associated with the item - a filter on account taken from within an FST, it returns the value of the XBRL name field associated with the FST item to which the account is related - in all other cases, it returns an error |
Example
$Account.xbrlName
Returns the value of the XBRL name field associated with the account.