Forecasting

Task Name

Description

Argument Template

ExecuteMTForecast

Executes the specified Medium Term Scenario. Takes a MTScenarioID and a boolean indicating if projects should be saved to the debug folder as required arguments.

<args>

<arg name="MTScenarioID" value="{MTScenarioID}"/>

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

ExecuteMTForecastWithForce

Executes the specified Medium Term Scenario. Takes a MTScenarioID and a boolean parameter indicating if Locked MT Forecast should be unlocked and relocked as required arguments.

<args>

<arg name="MTScenarioID" value="{MTScenarioID}"/>

<arg name="Force" value="true" type="System.Boolean" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

ExecuteRolling MTForecast

Executes the specified Medium Term Scenario, unlocking and relocking the MT Forecast and changing the dates of the forecast based on the current date and the number of months specified. Takes a MTScenarioID and an integer parameter indicating the number of months to forecast as required arguments.

<args>

<arg name="MTScenarioID" value="{MTScenarioID}"/>

<arg name="Months" value="true" type="System.Int32" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

FillAllSchedules

Executes Schedule Filling for all Schedules with Schedule Filling Parameters configured.

 

FillSchedules

Executes Schedule Filling for a subset of Schedules based on the specified filter. Takes a filter string, e.g. CUSTOM1=’Group 1’ as a required argument.

<args>

<arg name="FilterString" value="{filterstring}" />

</args>

FillWeathers

This task is executed automatically when importing weather. It can be optionally run separately when multiple providers are p¨resent in the system. See documentation for Import Tasks to disable automatic execution.

 

ForecastPortfolioADU

Prepares the master Portfolio ADU Data. Should be executed after any Portfolio Data import.

 

ForecastXDrivers

Prepares the master XDriver Data. Should be executed after any XDriver Data import.

 

ForecastXDrivers ByConcept

Prepares the master XDriver Data for the given XDriver Concept. Should be executed after an XDriver Data import for the given Concept. Takes an XDriver Concept ID.

<args>

<arg name="XDriverConceptID" value="{Concept}"/>

</args>

ForecastXDrivers ByActionRole

Prepares the master XDriver Data for the given Action ROle. Should be executed after an XDriver Data import. Takes an Action Role ID.

<args>

<arg name="XDriverConceptID" value="{Concept}"/>

</args>

GenerateAllForecasts

Generates a System Forecast including all active Models, Portfolio Items, Five Minute Models and Schedules. Takes a boolean argument indicating if the MetrixND projects should be saved to the Debug Folder.

<args>

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts

Generates a System Forecast for a subset of active Models, Portfolio Items, Five Minute Models and Schedules. Takes a filter string, e.g. CUSTOM1=''Group 1'' as a required argument.

<args>

<arg name="FilterString" value="{filterstring}"/>

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateAllForecasts WithOffset

Generates a System Forecast including all active Models, Portfolio Items, Five Minute Models and Schedules using the forecast parameters associated with the specified Action Role. Takes an ActionRole as a required argument.

<args>

<arg name="ActionRole" value="{ActionRole}" />

<arg name="WarnNoModels" value="True" type="System.Boolean" />

<arg name="WarnNoPortfolios" value="True" type="System.Boolean" />

<arg name="WarnNoFiveMinModels" value="True" type="System.Boolean" />

<arg name="WarnNoSchedules" value="True" type="System.Boolean" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts WithOffset

Generates a System Forecast for a subset of active Models, Portfolio Items, Five Minute Models and Schedules using the forecast parameters associated with the specified Action Role. Takes a filter string, e.g. CUSTOM1=''Group 1'' and Action Role as required arguments.

<args>

<arg name="FilterString" value="{filterstring}" />

<arg name="ActionRole" value="{ActionRole}" />

<arg name="WarnNoModels" value="True" type="System.Boolean" />

<arg name="WarnNoPortfolios" value="True" type="System.Boolean" />

<arg name="WarnNoFiveMinModels" value="True" type="System.Boolean" />

<arg name="WarnNoSchedules" value="True" type="System.Boolean" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts BySchedule

Generate a System Forecast for a subset of objects defined by the selected schedules. This differs from the GenerateForecasts command as the filter provided applies only to the Schedule List and the objects forecasted are the contributors of the filtered schedules. Takes a filter string, e.g. CUSTOM1=''Group 1'' and an Action Role as required arguments.

<args>

<arg name="ScheduleFilterString" value="{schedulefilterstring}"/>

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts ByScheduleWithOffset

Generate a System Forecast for a subset of objects defined by the selected schedules. This differs from the GenerateForecasts command as the filter provided applies only to the Schedule List and the objects forecasted are the contributors of the filtered schedules. Takes a filter string, e.g. CUSTOM1=''Group 1'' and an Action Role as required arguments.

<args>

<arg name="ScheduleFilterString" value="{schedulefilterstring}" />

<arg name="ActionRole" value="{ActionRole}" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts ByForecastType

Generate a System Forecast for a subset of active Models, Portfolio Items, Five Minute Models, and Schedules required for a compelte forecast in Forecast Monitor for the specified forecast type. Forecast Types are configured using the Forecast Monitor Configuration Model in MetrixIDR.

<args>

<arg name="ForecastType" value="{forecasttype}" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>

GenerateForecasts NoDependents

Generate a System Forecast for a subset of active Models, Portfolio Items, Five Minute Models, and Schedules. Takes a filter string, e.g. CUSTOM1=''Group 1'' as a required argument. Does not generate forecasts for any antecedent or dependent items.

<args>

<arg name="FilterString" value="{filterstring}" />

<arg name="WarnNoModels" value="True" type="System.Boolean" />

<arg name="WarnNoPortfolios" value="True" type="System.Boolean" />

<arg name="WarnNoFiveMinModels" value="True" type="System.Boolean" />

<arg name="WarnNoSchedules" value="True" type="System.Boolean" />

<arg name="DebugProjects" value="False" type="System.Boolean" />

</args>