Scenarios

Expose Scenario Planning Range time horizon information as expressions, which allow you to specify the following:

  • Start Year: Returns the start year in string format for the given scenario.
  • End Year: Returns the end year in string format for the given scenario.
  • Start Month: Returns the start month in string format for the given scenario.
  • End Month: Returns the end month in string format for the given scenario.
  • Module Start Year: Returns the start year in string format for the given module and scenario.
  • Module End Year: Returns the end year in string format for the given module and scenario.
  • Module Start Period: Returns the start period in string for the given module and scenario.
  • Module End Period: Returns the end period in string format for the given module and scenario.

Note:

Module Start Year, Module End Year, Module Start Period, and Module End Period are only valid for Planning Modules applications.

Calculation Manager Syntax:

[[getStartYear("ScenarioName")]]
[[getEndYear("ScenarioName")]]
[[getStartMonth("ScenarioName")]]
[[getEndMonth("ScenarioName")]]
[[getModuleStartYear("ModuleName","ScenarioName")]]
[[getModuleEndYear("ModuleName,"ScenarioName")]] 
[[getModuleStartPeriod("ModuleName,"ScenarioName")]] 
[[getModuleEndPeriod("ModuleName,"ScenarioName")]] 
  

ScenarioName can be a typed in Scenario member, or a Calculation Manager run-time prompt member type variable. The member must be enclosed in double quotes. For example, [[getStartYear("Actual")]].

ScenarioName can also be a substitution variable in the following formats:

  • getSubVarValue(plan type name, subtitution variable name) returns the substitution variable value for a given substitution variable at the plan type defined by the plan type name

  • getSubVarValue(subtitution variable name) returns the substitution variable value for a given substitution variable at the application level for all plan types

The substitution variable name must be enclosed in double quotes, do not use & or {}. See Example 3 and Example 4 below.

Example 1

The following syntax, where {rtpScenario} is a run-time prompt variable of type member with a default value of actual:

FIX({rtpScenario}, [[getStartYear({rtpScenario})]]:[[getEndYear({rtpScenario})]],
   [[getStartMonth({rtpScenario})]]:[[getEndMonth({rtpScenario})]])
      FIX ( Working, P_000, "111")
        "5800" = 5500;
      ENDFIX
ENDFIX  

returns the following script:

FIX ("Actual", "FY10" : "FY18", "Jan" : "Dec") 
    FIX (Working, P_000, "111") 
      "5800" = 5500;
    ENDFIX 
ENDFIX

Example 2

The following syntax:

FIX({rtpScenario}, [[PlanningFunctions.getModuleStartYear("CAPITAL",{rtpScenario})]]:
[[PlanningFunctions.getModuleEndYear("CAPITAL",{rtpScenario})]] , "Jan" : "Dec")
  FIX(OEP_Working, P_000, "111")
    "5800" = 5500;
  ENDFIX
ENDFIX

returns the following script:

FIX("OEP_Plan", "FY18" : "FY22", "Jan" : "Dec")
  FIX(OEP_Working, P_000, "111")
    "5800" = 5500;
  ENDFIX
ENDFIX

Example 3

The following syntax uses a substitution variable at the plan type level:

FIX ("Name", [[getStartMonth(getSubVarValue("Plan1", "testPlan"))]], "FY15", 
"BU Version_1", "No Currency", "No Entity", "No Grades") 
"Current" = 15; 
ENDFIX

This produces the following script:

FIX ("Name", "Jan", "FY15", "BU Version_1", "No Currency", "No Entity", "No 
Grades") 
"Current" = 15; 
ENDFIX

Example 4

The following syntax uses a substitution variable at the application level:

FIX ("Name", [[getStartMonth(getSubVarValue("testApp"))]], "FY15", "BU 
Version_1", "No Currency", "No Entity", "No Grades") 
"Current" = 15; 
ENDFIX 

This produces the following script:

FIX ("Name", "Jan", "FY15", "BU Version_1", "No Currency", "No Entity", "No 
Grades") 
"Current" = 15; 
ENDFIX