AutoPeriod: Integer;
The AutoPeriod property determines the conditions that are used to calculate start and end dates of sample and forecasting periods.
The value is determined by combinations of the MsAutoPeriodOptions enumeration elements. AutoPeriod is taken into account if the IMsModel.UseModelPeriod property is set to True.
If AutoPeriod uses the value of the MsAutoPeriodOptions enumeration, which requires setting additional number of periods, for example, MsAutoPeriodOptions.IdentStartByIdentEnd or MsAutoPeriodOptions.ForecastEndByFact, specify additional parameters in the corresponding property:
Features of calculation start and end dates of sample and forecasting periods
Executing the example requires a modeling container with the MS identifier that contains a model with the MODEL identifier.
Add links to the Metabase and Ms system assemblies.
Sub UserProc;
Var
mb: IMetabase;
MsKey: Integer;
ModelObj: IMetabaseObject;
Model: IMsModel;
ModelPeriod: IMsModelPeriod;
Begin
// Get the current repository
mb := MetabaseClass.Active;
// Get model
MsKey := mb.ItemById("MS").Key;
ModelObj := mb.ItemByIdNamespace("MODEL", MsKey).Edit;
Model := ModelObj As IMsModel;
Model.UseModelPeriod := True;
// Get model periods
ModelPeriod := Model.Transform.Period;
// Set calculation period conditions
ModelPeriod.AutoPeriod := MsAutoPeriodOptions.IdentStartAsNow +
MsAutoPeriodOptions.IdentEndAsNow +
MsAutoPeriodOptions.ForecastStartAsNow +
MsAutoPeriodOptions.ForecastEndByIdentEnd;
ModelPeriod.IdentificationStartOffset := -10;
ModelPeriod.IdentificationEndOffset := -1;
ModelPeriod.UseForecastStart := True;
ModelPeriod.ForecastStartOffset := 1;
ModelPeriod.ForecastEndOffset := 5;
// Save changes
ModelObj.Save;
End Sub UserProc;
After executing the example the conditions that determine model calculation periods are set:
Sample period start: actual data minus ten periods.
Sample period end: actual data minus one period.
Forecasting period start: current date plus one period.
Forecasting period end: sample end plus five periods.
See also: