Description of attributes for the Scenario 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 scenario and period present in the filter are related.
The ConsolidationScenario attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | consolidationScenario |
| Attributes | - code - desc |
| Value returned | If applied to an original scenario, it returns the associated consolidation scenario or set of consolidation scenarios. If applied to a consolidation scenario, it returns the same scenario. |
Examples
- $Scenario.consolidationScenario.code
Returns the code of the consolidation scenario associated with the original scenario specified in the filter.
- Scenario.consolidationScenario("true").code
Returns the code of the consolidation scenario associated with the original scenario specified in the filter. In the event that the scenario is included in more than one group, it is shown below every group in which it has been inserted.
- $Scenario.consolidationScenario("false").code
Returns the code of the consolidation scenario associated with the original scenario specified in the filter
The CurrencyScenario attribute
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Syntax | currencyScenario |
| Attributes | - code - desc |
| Value returned | Currency of the consolidation scenario specified in the filter. If applied to an original scenario, it returns an empty string. |
Example
$Scenario.currencyScenario.code
Returns the currency code of the consolidation scenario 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 |
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 Holding attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | holding |
| Attributes | - code - desc |
| Value returned | Holding of the consolidation scenario specified in the filter |
Example
$Scenario.holding.code
Returns the code of the holding.
The Next/Prev/Ref1/Ref2/.../Ref5 attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | next, prev, ref1, ref2, ... ref5 |
| Attributes | - code - desc |
| Value returned | Value of the relative field for the scenario specified in the filter. In the scenarios table, the attributes and fields correspond as follows: - next - next scenario - prev - previous scenario - ref1 - reference scenario 1 - ... - ref5 - reference scenario 5 |
Examples
- $Scenario.next.code
Returns the code of the scenario following the one specified in the filter.
- $Scenario.prev.code
Returns the code of the scenario prior to the one specified in the filter.
- $Scenarioref1.code
Returns the code of reference scenario 1 specified in the filter.
- $Scenario.next.next.desc
Returns the description of the scenario following the scenario following the scenario specified in the filter.
- $Scenario.prev.ref1.desc
Returns the description of reference scenario 1 of the scenario prior to the one specified in the filter.
The NumCopia attribute
| Element | Description |
|---|---|
| Availability | From 3.1109 |
| Syntax | numCopia |
| Attributes | - code - desc |
| Value returned | Version of the snapshot scenario |
Example
With an original 2012ACT scenario for which three snapshot scenarios are defined:
- Version 01: 2012ACT_V1
- Version 02: 2012ACT_V2
- Version 03: 2012ACT_V3
If scenario 2012ACT_V2 is used in the filters, then the $Scenario.numCopia syntax returns string "2".
The Opening attribute
| Element | Description |
|---|---|
| Availability | From 4.2.0 |
| Syntax | opening |
| Attributes | - CumulatedDays - endDate - MonthDays - startDate |
| Value returned | Given a scenario, it returns the opening scenario/period. |
Example
$Scenario.opening.startdate
Returns the start date of the opening period.
The OriginalScenario attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | originalScenario |
| Parameters | ("true/false") |
| Attributes | - code - desc |
| Value returned | If applied to a consolidation scenario, it returns the associated original scenario. If applied to an original scenario, it returns the same scenario. |
Example
-
$Scenario.originalScenario.code
-
Returns the code of the original scenario associated with the consolidation scenario specified in the filter.
Scenario.originalScenario("true").code
Returns the code of the original scenario associated with the consolidation scenario specified in the filter. In the event that the scenario is included in more than one group, it is shown below every group in which it has been inserted.
- $Scenario.originalScenario("false").code
Returns the code the original scenario associated with the consolidation scenario specified in the filter.
The OriginalSnapshotScenario attribute
| Element | Description |
|---|---|
| Availability | From 3.0903 |
| Syntax | originalSnapshotScenario |
| Attributes | - code - desc |
| Value returned | Given a snapshot scenario, it returns the linked original scenario. |
Example
$Scenario.originalSnapshotScenario.code
Returns the code of the original scenario linked to the snapshot scenario.
The ScenarioPeriod attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | scenarioPeriod |
| Attributes | - CumulatedDays - endDate - MonthDays - Quarter - startDate Note: the "quarter" attribute is used to refer to the current quarter. In the editor window, it is also possible to navigate between quarters using the offsetSP, firstSP and lastSP functions. |
| Value returned | Scenario/period pair associated with the filters on the 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 specified in the filter.
- $Period.ScenarioPeriod.endDate
Returns the scenario/period end date associated with the period specified in the filter.
- $Period.ScenarioPeriod.(Period.getLeaf("04")).endDate
Returns the period end date with code 04.
"Quarter" attribute examples
With scenario "2014" and period "02" as input filters, the following behaviours may take place:
- quarter.firstSP.endDate
Returns the date of the last day in the first period of the quarter containing the current period ("31/01/2014").
- quarter.lastSP.endDate
Returns the date of the last day in the last period of the quarter containing the current period ("31/03/2014").
- quarter.offsetSP(1).firstSP.EndDate
Returns the date of the last day in the first period of the quarter following the current quarter ("30/04/2014").
- quarter.offsetSP(-1).firstSP.EndDate
Returns the date of the last day in the first period of the quarter prior to the current quarter ("31/10/2013").
The ScenarioPeriod attribute
| Element | Description |
|---|---|
| Availability | From 5.1.0 |
| Syntax | scenarioPeriod |
| Attributes | - desc |
| Value returned | Description of the period of the scenario specified in the filter |
Example
$Scenario.scenarioPeriod.Description
Returns the description of the period of the specified scenario.
The Periods attribute
| Element | Description |
|---|---|
| Availability | From 5.3.SP14 |
| Syntax | Periods |
| Attributes | - code - desc |
| Value returned | List of periods of the scenario specified in the filter |
Example
$Scenario(@NOME_PARAMETRO).Periods
Returns the list of periods of the scenario specified in the filter.
The SnapshotScenarios attribute
| Element | Description |
|---|---|
| Availability | From 3.0903 |
| Syntax | snapshotScenarios |
| Attributes | - code - desc |
| Value returned | Set of all snapshot scenarios related to the scenario specified in the filter |
Example
$Scenario.snapshotScenario.item(1).code
Returns the code of the first snapshot scenario related to the scenario specified in the filter.
The Version attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | version |
| Value returned | Value of the "Version" field in the scenarios table for the scenario specified in the filter |
Example
$Scenario.version
Returns the version of the scenario specified in the filter.
The Year attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | year |
| Value returned | Value of the "Year" field in the scenarios table for the scenario specified in the filter |
Example
$Scenario.year
Returns the year of the scenario specified in the filter.