Macro Variables

The following macro variables return information related to the CAS session, caslibs, and input and output tables.

System-Defined Macro Variables Related to Input and Output

Macro Variable

Description

vf_session

CAS session name

vf_sessionID

CAS session ID

vf_caslibIn

caslib where input data is stored

vf_caslibOut

caslib where output data is stored

vf_libIn

CAS engine libref for input data

vf_libOut

CAS engine libref for output data

vf_tableInPrefix

Input table name prefix, which is used to differentiate input tables among different projects

vf_tableOutPrefix

Output table name prefix, which is used to differentiate output tables among different projects

vf_inData

Input table name

vf_inAttribute

Input attribute table name

vf_outFor

Output forecast table name

For more information, see Forecasted Values (OUTFOR).

vf_outStat

Output statistics table name

For more information, see Statistics of Fit (OUTSTAT).

vf_outInformation

Output information table name

vf_outSelect

Output model selection table name

For more information, see Model Selection Statistics (OUTSELECT).

vf_outModelInfo

Output model information table name

For more information, see Model Attributes (OUTMODELINFO).

vf_outLog

Output log name

vf_classification

Identifier for one of the following pluggable modeling nodes

  • pluggable_auto (Auto-forecasting)
  • pluggable_hierarchical (Hierarchical Forecasting (Pluggable))
  • pluggable_multistage (Multistage Model)
  • pluggable_naive (Naive Model)
  • pluggable_nonseasonalforecast (Non-seasonal Model)
  • pluggable_regression (Regression for Time Series)
  • pluggable_retired (Retired Series)
  • pluggable_seasonalforecast (Seasonal Model)
  • pluggable_temporalAggregation (Temporal Aggregation Model)

The following macro variables return information about variables and settings that the user defines on the Data tab.

System-Defined Macro Variables Related to Data Specification

Macro Variable

Description

vf_depVar

Dependent variable name

vf_depVarAcc

Accumulation setting for the dependent variable

vf_depVarAgg

Aggregation setting for the dependent variable

vf_depVarSetMissing

Missing-value interpretation setting for the dependent variable

vf_byVars

BY variables defined for the project

vf_timeID

Time ID variable name

vf_timeIDInterval

Time series interval

vf_timeIDSeasonality

Time series seasonality

vf_setMissing

Missing-value interpretation setting for the time ID

vf_lead

Forecast lead (horizon)

vf_horizonStart

Forecast horizon start date

vf_reconcileLevelNumber

Reconcile level number specified for the project; the _TOP_ level number is 0

vf_reconcileLevel

BY variable that corresponds to the reconcile level specified for the project

vf_allowNegativeForecasts

Boolean value indicating whether negative values are allowed in the forecast results

vf_indepVars

Strings that specify the independent variable names (for example, promotion, price, and inventory)

vf_indepVarsAcc

Accumulation settings for the independent variables

vf_indepVarsAgg

Aggregation settings for the independent variables

vf_indepVarsSetMissing

Missing-value interpretation settings for the independent variables

vf_indepVarsRequired

Boolean value indicating whether independent variables are required

vf_indepVarsExtend

Returns the method for extension or replacement for each independent series separated by a space. The extension option for each variable is used in the TSDF.AddX method.

vf_events

List of events defined in the project

vf_numEvents

The number of events specified in the project

vf_eventnum

Event variables names for each event specified in the project

The variable names are assigned as vf_event1, vf_event2, and so on, depending on the number of events in the project. After the node is run, you can examine the log to determine which event variable is assigned to each event.

vf_eventsRequired

Boolean value indicating whether events are required

vf_inEventData

Event definition data

vf_inEventObj

Returns a string that defines the object associated with the event CAS table for the project

vf_back

Size of the out-of-sample region

vf_alpha

alpha level for the confidence limits

Last updated: March 16, 2026