Description of attributes for the Entity dimension
The AdministrativeHQ attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | AdministrativeHQ |
| Value returned | Name of the entity's administrative headquarters |
Example
$Entity.administrativeHQ
Returns the entity's administrative headquarters.
The AdministrativeHQBranch attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | AdministrativeHQBranch |
| Value returned | City of the entity's administrative HQ |
Example
$Entity.administrativeHQBranch
Returns the city of the entity's administrative HQ.
The AlternativeCode attribute
| Element | Description |
|---|---|
| Availability | From 4.2.1 |
| Syntax | AlternativeCode |
| Value returned | Alternative entity code |
Example
Entity with code A00 and alternative code A00_ITA.
$Entity.alternativeCode
Returns the string "A00_ITA".
The BusinessName attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | businessName |
| Value returned | The entity's business name |
Example
$Entity.businessName
Returns the entity's business name.
The CertificationDate attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | certificationDate |
| Value returned | The entity's submission date |
Example
$Entity.certificationDate
Returns the entity's submission date/phase containing the form for the process to which scenarios/periods present in the filter (row/column, matrix, sheet, form) are related.
The ConsolidationPerc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | consolidationPerc |
| Value returned | The entity's consolidation percentage |
Example
$Entity.consolidationPerc
Returns the entity's consolidation percentage.
The ConsolidationType attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | consolidationType |
| Value returned | The entity's consolidation type |
Example
$Entity.consolidationType
Returns the entity's consolidation type.
The ConstitutionDate attribute
| Element | Description |
|---|---|
| Availability | From 5.0 |
| Syntax | constitutionDate |
| Value returned | The date on which the entity was established |
Example
$Entity.constitutionDate
Returns the date on which the entity was established.
The Counterparties attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | counterparties |
| Value returned | Counterparty entities related to the entity |
Example
$Entity.counterparties.code
Returns the codes of the counterparty entities related to the entity.
The CounterpartiesByControlType attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | counterpartiesByControlType |
| Attributes | - code - desc |
| Value returned | Counterparty entities related to the current entity by scenario/period (control chart). Requires a filter (row/column, matrix, sheet, form) on the scenario and period dimensions. |
IMPORTANT: this attribute always returns elements belonging to the "Counterparty Entity" dimension. The elements obtained can then only be used directly within advanced selection scripts related to the "Counterparty Entity" dimension (see Details of advanced selection scripts for calculating the default value).
Example
$Entity.counterpartiesControlType.code
Returns the codes of the counterparty entities related to the entity within the control chart.
The Currency attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | currency([scenario],[period]) |
| Attributes | - code - desc |
| Parameters | - scenario (optional) Scenario code - period (optional) Period code |
| Value returned | Entity currency specified in the filter (row/column, matrix, sheet, form) for the process to which scenarios/periods present in the filter are related. |
Examples
- $Entity.currency.code
Returns the currency code associated with the entity specified in the filter for the process to which scenarios/periods present in the filter are related.
- $Entity.currency.code.getLeaf()
Returns the filter on the currency associated with the entity
- $Entity.currency(column(“MATRIX1”,1).$Scenario,column(“MATRIX1”,1).$Period.code
Returns the currency code associated with the entity specified in the filter for the process to which scenarios/periods present on the first column of "MATRIX1" are related.
The Cust_dim1Default, Cust_dim2Default, ... Cust_dim5Default attribute
| Element | Description |
|---|---|
| Availability | From 4.2.1 |
| Syntax | cust_dim1Default |
| Attributes | - code - desc |
| Value returned | Default element of the custom dimension associated with the entity specified in the filter (row/column, matrix, sheet, form) extracted from the elements table |
Example
$Entity.cust_dim1Default.code
Returns the code of the default element of custom dimension 1 associated with the entity specified in the filter.
The Email attribute
| Element | Description |
|---|---|
| Availability | From 5.0 |
| Syntax | |
| Value returned | Entity email |
Example
$Entity.email
Returns the entity's email.
The EquityRatioPerc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | equityRatioPerc([scenario],[period]) |
| Parameters | - scenario (optional) Scenario code - period (optional) Period code |
| Value returned | The entity's equity ratio percentage |
Examples
- $Entity.equityRatioPerc
Returns the equity ratio percentage.
- $Entity.equityRatioPerc(column(“MATRIX 1”,1).$Scenario,column(“MATRIX 1”,1).$Period)
Returns the equity ratio percentage for scenarios/periods indicated as parameters, not those specified in the filter (row/column, matrix, sheet, form).
The ExchangeRate attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | exchangeRate([scenario],[period],[entity]) |
| Applicability | Entity or currency |
| Parameters | - scenario (optional) Scenario code - period (optional) Period code - entity (optional) Entity code |
| Attributes | - average Average FX rate - final Final FX rate - period: Period average FX rate |
| Value returned | FX rate of the currency used as the filter (row/column, matrix, sheet, form) or of the entity indicated as the parameter |
Examples
- $Currency.exchangeRate.average
Returns the average FX rate of the entity currency for the scenario/period/entity defined in the filter.
- $Currency.exchangeRate.final
Returns the final FX rate of the entity currency for the scenario/period/entity defined in the filter.
- $Currency.exchangeRate.periodic
Returns the period average FX rate of the entity currency for the scenario/period/entity defined in the filter.
- $Currency.exchangeRate(matrix("MATRIX 1").$Scenario, matrix("MATRIX 1").$Period, matrix("MATRIX 1").$Entity).average
Returns the average FX rate of the entity currency for the scenario/period/entity defined in "Matrix 1".
The LegalHQ attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | legalHQ |
| Value returned | The entity's legal headquarters |
Example
$Entity.legalHQ
Returns the entity's legal headquarters.
The LegalHQBranch attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | legalHQBranch |
| Value returned | City of the entity's legal HQ |
Example
$Entity.legalHQBranch
Returns the city of the entity's legal HQ.
The OwnershipPerc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | ownershipPerc([scenario],[period]) |
| Parameters | - scenario (optional) Scenario code - period (optional) Period code |
| Value returned | The entity’s ownership percentage |
Examples
- $Entity.ownershipPerc
Returns the ownership percentage.
- $Entity.ownershipPerc(column(“MATRIX 1”,1).$Scenario,column(“MATRIX 1”,1).$Period)
Returns the ownership percentage relative to the scenario/period defined as a parameter of the function and not for the scenario/period specified in the filter.
The Phone attribute
| Element | Description |
|---|---|
| Availability | From 5.0 |
| Syntax | phone |
| Value returned | Entity telephone number |
Example
$Entity.phone
Returns the entity's telephone number.
The ProcessStep attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | processStep |
| Attributes | - code - desc |
| Value returned | Step related to the entity for the process to which the scenario/process present in the filter (row/column, matrix, sheet, form) is related |
Example
$Entity.processStep.code
Returns the code of the step associated with the entity specified in the filter.
The ProportionalityPerc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | proportionalityPerc |
| Parameters | - scenario (optional) Scenario code - period (optional) Period code |
| Value returned | The entity's proportionality percentage |
Examples
- $Entity.proportionalityPerc
Returns the entity's proportionality percentage.
- $Entity.proportionalityPerc(column(“MATRIX 1”,1).$Scenario,column(“MATRIX 1”,1).$Period)
Returns the entity's proportionality percentage for scenarios/periods processed as parameters of the function, not for those specified in the filter.
The Snapshot attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | snapshot |
| Value returned | Information related to the entity/scenario/period triplet when a snapshot scenario is created |
Examples
- $Entity.snapshot.comment
Returns the comment inserted when the snapshot scenario for entity/scenario/periods present in the filter was created.
- $Entity.snapshot.desc
Returns the description inserted when the snapshot scenario for the entity/scenario/period present in the filter was created.
The Variable attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | variable(code) |
| Parameters | - code Classifier code |
| Attributes | - code - desc |
| Value returned | The Variable element associated with the entity specified in the filter |
Example
$Entity.variable(“V01”).desc
Returns the description of variable "V01" associated with the entity specified in the filter.