Description of attributes for the Period dimension
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 for the process to which scenarios/periods present in the filter are related.
The DescNumPeriod attribute
| Element | Description |
|---|---|
| Availability | From 3.1109 |
| Syntax | descNumPeriod |
| Value returned | Value of the "Period number" field in the periods table for the specified period |
Example
$Period.descNumPeriod
Returns the number of the period specified in the filter.
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 or of the entity indicated as the parameter of the function |
Examples
- $Currency.exchangeRate.average
Returns the average FX rate of the entity currency for the defined scenario/period/entity.
- $Currency.exchangeRate.final
Returns the final FX rate of the entity currency for the defined scenario/period/entity.
- $Currency.exchangeRate.periodic
Returns the period average FX rate of the entity currency for the defined scenario/period/entity.
- $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 "Matrix1".
Offset attribute
| Element | Description |
|---|---|
| Availability | From 3.1109 |
| Syntax | offset |
| Parameters | - offset Deviation from the starting period |
| Value returned | Period obtained based on the period indicated when applying the offset. If the shift is greater than the number of periods present in the scenario, prior or subsequent to the indicated period, the system creates a chain of periods, taking account of the previous and subsequent relationships of the scenarios. |
Example
With filter on Period = April and Scenario = 2013ACT and 2012ACT = previous scenario. Scenarios are made up of 12 periods.
- $Period.offset(-3).code
Returns the code of the "January" period
- $Period.offset(-5).code
Returns the code of the "November" period
The ScenarioOffset attribute
| Element | Description |
|---|---|
| Availability | From 3.1109 |
| Syntax | scenarioOffset |
| Parameters | - offset Deviation from the starting period |
| Value returned | Scenario obtained from the "offset" of the periods indicated in the parameter. Returns the scenario indicated in the filter if the shift does not give rise to scenario offsets. |
Example
With filter on Period = April and Scenario = 2013ACT and 2012ACT = previous scenario. Scenarios are made up of 12 periods.
- $Period.scenarioOffset(-6).code
Returns the code of the previous scenario (2012ACT)
- $Period.scenarioOffset (-3).code
Returns the code of the filter scenario (2013ACT)
The ScenarioPeriod attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | scenarioPeriod |
| Attributes | - CumulatedDays - endDate - MonthDays - startDate |
| Value returned | Scenario/period pair associated with the filters on scenario and period dimensions. Can be applied to both the scenario and the period dimension. |
Examples
- $Scenario.ScenarioPeriod.endDate
Returns the scenario/period end date associated with the scenario.
- $Period.ScenarioPeriod.endDate
Returns the scenario/period end date associated with the period.
- $Period.ScenarioPeriod.(Period.getLeaf("04")).endDate
Returns the period end date (overridden) with code 04.