Trend of Historic Averages Parameters

Parameter Description Example
createRuleGroupName = groupName The rule group used when creating a forecast . Valid entries come from the FCRG_Name column of the FCST_RuleGroup Table. createRuleGroupName = DEFAULT FORECAST CREATION RULE GRP
ruleGroupName = groupName The rule group associated with the forecast. Note that this rule group is not used when creating the forecast. ruleGroupName = DEFAULT FORECAST RULE GROUP
forecastInitialStateName = stateName The state of the forecast when it is created. forecastInitialStateName = Initial
topDownVolumeTypeName = volumeTypeName The volume type to forecast. topDownVolumeTypeName = AHR, REVENUE
topDownFieldName = field1,field2 Field name to place the forecasted value. topDownFieldName = fcitAhr,fcitSales
ahrGrowthPercentageVolumeType = AHR The growth percentage to apply to AHR. ahrGrowthPercentageVolumeType = AHR
refForecastLayoutName = layoutName The layout template name. refForecastLayoutName = PHASED FORECAST TEMPLATE
calculatorClass = className The name of the calculator class. calculatorClass = com.workbrain.app. modules.budgeting.forecasting.impl. TOHCalculator
valuesFromBudget = field1,field2 The values required from the budget. valuesFromBudget = fcitPayrollPct, fcitMinHours,fcitHolHours,fcitVacHours, fcitOtherHours
forecastMaxLocations = number The maximum number of locations for which a forecast can be generated from the Forecast Generation page. forecastMaxLocations = 50
salesBaseLineWeights = weightForTimePeriod1,weightForTimePeriod, etc. The weighting to assign a given time period when calculating the baseline weights for sales. The number of entries also specifies the number of weeks to use. salesBaseLineWeights = 2, 3, 2
salesTrendWeights = weightForPreviousWeek1,weightForPreviousWeek2, etc. The number of past time periods and the weights to use when calculating the trend percentage for sales. salesTrendWeights = 8, 6, 4, 2, 1, 1, 1, 1
ahrBaseLineWeights = weightForTimePeriod1,weightForTimePeriod2, etc. The weighting to assign a given time period when calculating the baseline weights for the average hourly rate. The number of entries also specifies the number of weeks to use. ahrBaseLineWeights = 1, 3,1
ahrPastTimePeriods = number of past time periods to use The number of past time periods to use when calculating the average hourly rate trend percentage. ahrPastTimePeriods = 8
lastYearsActualsVolTypeName = name1,name2, etc. The actuals to load from the previous time periods. These values are used to calculate the average hourly rate. lastYearsActualsVolTypeName = AHR
lastYearsActualsFieldNames = field1,field2,etc. The fields into which to load this year's actual values. Valid entries correspond to the properties of the FcstItemData class. lastYearsActualsFieldNames = fcitAhr
forecastInitialStateName = stateName Initial state of the forecast. The valid values are in FCST_STATE. forecastInitialStateName = Initial
forecastTypeName = forecastTypeName The generated forecast type. Valid values are in FCST_TYPE. forecastTypeName = FORECAST
copyFromMasterVersions = versionName The forecast version. The values are taken from the Master version. copyFromMasterVersions = SYSFORECAST

The following parameters are no longer used, although they are still displayed in the Parameters field on the Forecast Methods Detail page:

  • lastYearsActualsAggregation
  • thisYearsActualsVolTypeName
  • thisYearsActualsFieldNames
  • thisYearsActualsaggregation