Values for Substitution Variables

Substitution variables set up your NetSuite Planning and Budgeting environment. Some variables determine the scenario and version that you're using. Other variables determine the current, previous, and future periods and years that you want to work with.

To set a substitution variable's value, click the Navigator icon , and then select Variables. On the Variables page, click the Substitution Variables tab, and then enter the new value for a variable in the Value column.

Tip:

If you'd rather set values for substitution variables in your NetSuite account, refer to the help topic Substitution Variables.

Important:

Before you start setting up substitution variables, read the following guidelines:

During implementation, you must give values to all substitution variables before loading metadata and data. This is because the business rules that run during the metadata and data load need those values.
Member formulas use certain substitution variables. Whenever you change any of these variables, make sure you perform a cube refresh so that the member formulas use the new variable values. These variables are identified in the subsequent tables. If you skip the refresh, the member formulas keep using the old substitution variable values until the next refresh. For details about how to perform a cube refresh, see the help topic Performing a Cube Refresh in the Planning and Budgeting Financials Administrator Guide.

Note:

When you enter a value for a substitution variable in the Value column, best practice is to enclose the value in double quotation marks. For example: "1100".

The substitution variables are categorized in the subsequent tables, and they provide important details for each variable:

Setup – Lists substitution variables that you need to set up during implementation.

See Substitution Variables for Setup.
Monthly Maintenance – Lists substitution variables that you need to update monthly.

See Substitution Variables Requiring Monthly Maintenance.
Yearly – Lists substitution variables that you need to update yearly.

See Substitution Variables Requiring Annual Maintenance.
Other – Lists substitution variables that aren't assigned to any of the aforementioned categories by default.

See Other Substitution Variables.

Substitution Variables for Setup

The following table lists the substitution variables that you need to set up during implementation, along with important details for each variable:

Substitution Variable	Description	Variable Usage	Sample Value	Cube Refresh Required After Value is Updated?
NSP_FIN_AccDepreciation	Account: Accumulated Depreciation - Assets	It's used in the member formula of the CF Depreciation Amortization account. The variable value is the parent of the accounts used for accumulated depreciation and amortization. Use the P_ prefix, then add the account number for Accumulated Depreciation.	"P_1700"	Yes
NSP_FIN_AP	Account: Accounts Payable - Liabilities	It's used in multiple member formulas, forms, and business rules. The variable value is the account number for Accounts Payable.	"2010"	Yes
NSP_FIN_AR	Account: Accounts Receivable - Assets	It's used in multiple member formulas, forms, and business rules. The variable value is the account number for Accounts Receivable.	"1110"	Yes
NSP_FIN_COGS	Account: Cost of Sales - Expenses	It's used in multiple business rules. The variable value is the account number for Cost of Sales (or Cost of Goods Sold).	"5000"	No
NSP_FIN_Inventory	Account: Inventory - Assets	It's used for calculation purposes in multiple forms, including dashboard forms. The variable value is the account number for Inventory.	"1210"	Yes
NSP_FIN_RetainedEarnings	Account: Retained Earnings - Equity	The variable value is the account number for Retained Earnings. Usually, this value is “3700”, but you should review the chart of accounts to confirm the value.	"3700"	Yes
NSP_FIN_TotalCOGS	Account: (Parent) Total Cost of Sales - Expense	It's used in multiple member formulas and forms to identify the account or parent account with the total value for COGS. Use the P_ prefix, then add the account number for Total Cost of Sales.	"P_5000"	Yes
NSP_FIN_TotalDeprAmort	Account: (Parent) Total Depreciation and Amortization - Expense	It's used in the member formula for the EBITDA account to identify the account or parent account used for EBITDA. Use the P_ prefix, then use the account number for Total Depreciation and Amortization.	"P_6800"	Yes
NSP_FIN_TotalExpenses	Account: Functional Roll-up: Expense	It's used in multiple dashboard forms to identify the account or parent account used for Total Expenses. Use the P_ prefix, then add the account number for Total Expenses.	"P_6000"	Yes
NSP_FIN_TotalFixedAssets	Account: Functional Roll-up: Fixed Assets	It's used in the member formula for the CF Fixed Assets account to identify the account or parent account used for Total Fixed Assets. Use the P_ prefix, then add the account number for Total Fixed Asset.	"P_1600"	Yes
NSP_FIN_TotalInventory	Account: Functional Roll-up: Inventory	It's used in member formulas associated with Cash Flow for reporting purposes. Use the P_ prefix, then add the account number for Total Inventory.	"P_1200"	Yes
NSP_FIN_TotalRevenue	Account: Functional Roll-up: Revenue	It's used for reporting purposes. The variable is "NFS_Total Revenue".	"NFS_Total Revenue"	Yes
NSP_SYS_BSOldestYr	Years: Year of starting Balance Sheet	It's used for data load processes. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY19"	No
NSP_SYS_CurrentScenario	Scenario: Default value is "NSP_Forecast"	Use the NSP_ prefix, then add the Scenario. During implementation, set to “NSP_Forecast”. After implementation, you can adjust the value if you want to use a different Scenario for forms and business rules.	"NSP_Forecast"	Yes
NSP_SYS_CurrentVersion	Version: Default is "NSP_Base"	Use the NSP_ prefix, then add the Version. During implementation, set to “NSP_Base”. After implementation you can adjust the value if you want to use a different Version for forms and business rules.	"NSP_Base"	Yes
NSP_SYS_ExclSubFX	Subsidiary: Exclusion of Elimination Companies or Subsidiaries	It's used in the Exchange Rates to Reporting Currency form to exclude subsidiaries that are not involved in exchange rate input. It should list any subs that do not have exchange rate inputs, such as elimination companies. If no subsidiaries are excluded, the default value is "No Entity".	"No Entity", "SUB_1", "SUB_2"	No
NSP_SYS_NoIntersection	String of dimensions used for DSO, DIO, and DPO	It's used in member formulas associated with Days in Month (DSO, DIO, and DPO). The default value is "No Scenario"->"No Entity"->"No Currency"->"No Department"->"No Class"->"No Location"->"No Relationship"->"No Item". Important: Do not change the string value for this substitution variable.	"No Scenario"->"No Entity"->"No Currency"->"No Department"->"No Class"->"No Location"->"No Relationship"->"No Item"	Yes
NSP_SYS_RptCurr1	Currency: Primary Reporting currency	The variable value is your primary reporting currency. Specify the variable by the currency, then add the _Reporting suffix.	"USD_Reporting"	No

Substitution Variable

Description

Variable Usage

Sample Value

Cube Refresh Required After Value is Updated?

NSP_FIN_AccDepreciation

Account: Accumulated Depreciation - Assets

It's used in the member formula of the CF Depreciation Amortization account. The variable value is the parent of the accounts used for accumulated depreciation and amortization.

Use the P_ prefix, then add the account number for Accumulated Depreciation.

"P_1700"

Yes

NSP_FIN_AP

Account: Accounts Payable - Liabilities

It's used in multiple member formulas, forms, and business rules. The variable value is the account number for Accounts Payable.

"2010"

Yes

NSP_FIN_AR

Account: Accounts Receivable - Assets

It's used in multiple member formulas, forms, and business rules. The variable value is the account number for Accounts Receivable.

"1110"

Yes

NSP_FIN_COGS

Account: Cost of Sales - Expenses

It's used in multiple business rules. The variable value is the account number for Cost of Sales (or Cost of Goods Sold).

"5000"

NSP_FIN_Inventory

Account: Inventory - Assets

It's used for calculation purposes in multiple forms, including dashboard forms. The variable value is the account number for Inventory.

"1210"

Yes

NSP_FIN_RetainedEarnings

Account: Retained Earnings - Equity

The variable value is the account number for Retained Earnings. Usually, this value is “3700”, but you should review the chart of accounts to confirm the value.

"3700"

Yes

NSP_FIN_TotalCOGS

Account: (Parent) Total Cost of Sales - Expense

It's used in multiple member formulas and forms to identify the account or parent account with the total value for COGS.

Use the P_ prefix, then add the account number for Total Cost of Sales.

"P_5000"

Yes

NSP_FIN_TotalDeprAmort

Account: (Parent) Total Depreciation and Amortization - Expense

It's used in the member formula for the EBITDA account to identify the account or parent account used for EBITDA.

Use the P_ prefix, then use the account number for Total Depreciation and Amortization.

"P_6800"

Yes

NSP_FIN_TotalExpenses

Account: Functional Roll-up: Expense

It's used in multiple dashboard forms to identify the account or parent account used for Total Expenses.

Use the P_ prefix, then add the account number for Total Expenses.

"P_6000"

Yes

NSP_FIN_TotalFixedAssets

Account: Functional Roll-up: Fixed Assets

It's used in the member formula for the CF Fixed Assets account to identify the account or parent account used for Total Fixed Assets.

Use the P_ prefix, then add the account number for Total Fixed Asset.

"P_1600"

Yes

NSP_FIN_TotalInventory

Account: Functional Roll-up: Inventory

It's used in member formulas associated with Cash Flow for reporting purposes.

Use the P_ prefix, then add the account number for Total Inventory.

"P_1200"

Yes

NSP_FIN_TotalRevenue

Account: Functional Roll-up: Revenue

It's used for reporting purposes.

The variable is "NFS_Total Revenue".

"NFS_Total Revenue"

Yes

NSP_SYS_BSOldestYr

Years: Year of starting Balance Sheet

It's used for data load processes.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY19"

NSP_SYS_CurrentScenario

Scenario: Default value is "NSP_Forecast"

Use the NSP_ prefix, then add the Scenario.

During implementation, set to “NSP_Forecast”. After implementation, you can adjust the value if you want to use a different Scenario for forms and business rules.

"NSP_Forecast"

Yes

NSP_SYS_CurrentVersion

Version: Default is "NSP_Base"

Use the NSP_ prefix, then add the Version.

During implementation, set to “NSP_Base”. After implementation you can adjust the value if you want to use a different Version for forms and business rules.

"NSP_Base"

Yes

NSP_SYS_ExclSubFX

Subsidiary: Exclusion of Elimination Companies or Subsidiaries

It's used in the Exchange Rates to Reporting Currency form to exclude subsidiaries that are not involved in exchange rate input. It should list any subs that do not have exchange rate inputs, such as elimination companies. If no subsidiaries are excluded, the default value is "No Entity".

"No Entity", "SUB_1", "SUB_2"

NSP_SYS_NoIntersection

String of dimensions used for DSO, DIO, and DPO

It's used in member formulas associated with Days in Month (DSO, DIO, and DPO).

The default value is "No Scenario"->"No Entity"->"No Currency"->"No Department"->"No Class"->"No Location"->"No Relationship"->"No Item".

Important:

Do not change the string value for this substitution variable.

"No Scenario"->"No Entity"->"No Currency"->"No Department"->"No Class"->"No Location"->"No Relationship"->"No Item"

Yes

NSP_SYS_RptCurr1

Currency: Primary Reporting currency

The variable value is your primary reporting currency.

Specify the variable by the currency, then add the _Reporting suffix.

"USD_Reporting"

Substitution Variables Requiring Monthly Maintenance

The following table lists the substitution variables that you need to update every month, along with important details for each variable:

Substitution Variable	Description	Variable Usage	Sample Value	Cube Refresh Required After Value is Updated?
NSP_PER_ActCurrMo	Period: Current Actual month	The variable value is the month before NSP_PER_BudCurrMonth. Use the time period prefix, TP, then add the numerical value for the month. For example, if NSP_PER_BudCurrMonth is “TP9”, then NSP_PER_ActCurrMo is “TP8”. If NSP_PER_BudCurrMonth is “TP1”, then NSP_PER_ActCurrMo is “TP12”.	"TP3"	No
NSP_PER_FcstCurrMo	Period: Current Forecast month	The variable value is the first month in which users enter forecast data. The variable is the first month after the last month for which data is loaded. Use the time period prefix, TP, then add the numerical value for the month. For example, if data loads from Jan FY18 – Aug FY20, then September is the first Forecast month. Since September is the ninth month of the year, the substitution variable is “TP9”.	"TP9"	No
NSP_PER_RptCurrMo	Period: Month before "NSP_PER_BudCurrMonth"	It's used on dashboards and variance report forms to identify the current month. Use the time period prefix, TP, then add the numerical value for the month.	"TP3"	No
NSP_PER_RptPriorMo	Period: Month before "NSP_PER_RptCurrMth"	The variable value is the month before NSP_PER_RptCurrMo. Use the time period prefix, TP, then add the numerical value for the month.	"TP2"	No
NSP_PER_SyncEndMonth	Period: Actual end month selected by user	It's used for data load processes. Use the time period prefix, TP, then add the numerical value for the month.	"TP3"	No
NSP_PER_SyncStartMonth	Period: Actual start month selected by user	It's used for data load processes. Use the time period prefix, TP, then add the numerical value for the month.	"TP1"	No

Substitution Variable

Description

Variable Usage

Sample Value

Cube Refresh Required After Value is Updated?

NSP_PER_ActCurrMo

Period: Current Actual month

The variable value is the month before NSP_PER_BudCurrMonth.

Use the time period prefix, TP, then add the numerical value for the month.

For example, if NSP_PER_BudCurrMonth is “TP9”, then NSP_PER_ActCurrMo is “TP8”. If NSP_PER_BudCurrMonth is “TP1”, then NSP_PER_ActCurrMo is “TP12”.

"TP3"

NSP_PER_FcstCurrMo

Period: Current Forecast month

The variable value is the first month in which users enter forecast data. The variable is the first month after the last month for which data is loaded.

Use the time period prefix, TP, then add the numerical value for the month.

For example, if data loads from Jan FY18 – Aug FY20, then September is the first Forecast month. Since September is the ninth month of the year, the substitution variable is “TP9”.

"TP9"

NSP_PER_RptCurrMo

Period: Month before "NSP_PER_BudCurrMonth"

It's used on dashboards and variance report forms to identify the current month.

Use the time period prefix, TP, then add the numerical value for the month.

"TP3"

NSP_PER_RptPriorMo

Period: Month before "NSP_PER_RptCurrMth"

The variable value is the month before NSP_PER_RptCurrMo.

Use the time period prefix, TP, then add the numerical value for the month.

"TP2"

NSP_PER_SyncEndMonth

Period: Actual end month selected by user

It's used for data load processes.

Use the time period prefix, TP, then add the numerical value for the month.

"TP3"

NSP_PER_SyncStartMonth

Period: Actual start month selected by user

It's used for data load processes.

Use the time period prefix, TP, then add the numerical value for the month.

"TP1"

Substitution Variables Requiring Annual Maintenance

The following table lists the substitution variables that you need to update annually, along with important details for each variable:

Substitution Variable	Description	Variable Usage	Sample Value	Cube Refresh Required After Value is Updated?
NSP_PER_ActCurrYr	Years: Current Actual year	The variable value is the year that goes with NSP_PER_ActCurrMo. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY21"	No
NSP_PER_FcstCurrYr	Years: Current Forecast year	The variable value is the first year in which users enter Forecast data. This value is the year of the first month after the last month for which data is loaded. For example, if data loads from Jan FY19 – Aug FY21, September of FY21 is the first Forecast month. Therefore, the substitution variable is “FY21” as the first Forecast year. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY21"	Yes
NSP_PER_FcstNextYr	Years: Next Forecast year	The variable value is the year after NSP_PER_FcstCurrYr. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY22"	Yes
NSP_PER_PriorYr	Years: Year before NSP_PER_ActCurrYr	The variable value is the year before NSP_PER_BudCurrYr. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY20"	No
NSP_PER_PriorYr1	Years: Year before NSP_PER_PriorYr	It's used on forms to identify the year before NSP_PER_PriorYr. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY19"	Yes
NSP_PER_RptCurrYr	Years: Year of NSP_PER_ActCurrYr	It's used on dashboards and variance report forms to identify the current year. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY21"	No
NSP_PER_RptPriorYr	Years: Year before NSP_PER_ActCurrYr	It's used on dashboards to identify the year before the current year. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY20"	No
NSP_PER_RptYrOfPriorMo	Years: Year of NSP_PER_RptPriorMo	It's used on dashboards and variance report forms to identify the year of the prior reporting month. For example, if the current reporting month is February of 2021, then the prior month is January of 2021, and NSP_PER_RptPriorYr is "FY21". If the current reporting month is January of 2021, then the prior month is December of 2020, and NSP_PER_RptPriorYr is "FY20". Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY21", "FY20"	No
NSP_PER_SyncEndYear	Years: Actual data load end year	It's used for data load processes. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY21"	No
NSP_PER_SyncStartYr	Years: Actual data load start year	It's used for data load processes. Use the fiscal year prefix, FY, then add the last two digits of the year.	"FY19"	No

Substitution Variable

Description

Variable Usage

Sample Value

Cube Refresh Required After Value is Updated?

NSP_PER_ActCurrYr

Years: Current Actual year

The variable value is the year that goes with NSP_PER_ActCurrMo.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY21"

NSP_PER_FcstCurrYr

Years: Current Forecast year

The variable value is the first year in which users enter Forecast data. This value is the year of the first month after the last month for which data is loaded.

For example, if data loads from Jan FY19 – Aug FY21, September of FY21 is the first Forecast month. Therefore, the substitution variable is “FY21” as the first Forecast year.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY21"

Yes

NSP_PER_FcstNextYr

Years: Next Forecast year

The variable value is the year after NSP_PER_FcstCurrYr.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY22"

Yes

NSP_PER_PriorYr

Years: Year before NSP_PER_ActCurrYr

The variable value is the year before NSP_PER_BudCurrYr.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY20"

NSP_PER_PriorYr1

Years: Year before NSP_PER_PriorYr

It's used on forms to identify the year before NSP_PER_PriorYr.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY19"

Yes

NSP_PER_RptCurrYr

Years: Year of NSP_PER_ActCurrYr

It's used on dashboards and variance report forms to identify the current year.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY21"

NSP_PER_RptPriorYr

Years: Year before NSP_PER_ActCurrYr

It's used on dashboards to identify the year before the current year.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY20"

NSP_PER_RptYrOfPriorMo

Years: Year of NSP_PER_RptPriorMo

It's used on dashboards and variance report forms to identify the year of the prior reporting month.

For example, if the current reporting month is February of 2021, then the prior month is January of 2021, and NSP_PER_RptPriorYr is "FY21". If the current reporting month is January of 2021, then the prior month is December of 2020, and NSP_PER_RptPriorYr is "FY20".

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY21", "FY20"

NSP_PER_SyncEndYear

Years: Actual data load end year

It's used for data load processes.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY21"

NSP_PER_SyncStartYr

Years: Actual data load start year

It's used for data load processes.

Use the fiscal year prefix, FY, then add the last two digits of the year.

"FY19"

Other Substitution Variables

The following table lists the substitution variables that you didn't assign to any of the other categories (setup, monthly maintenance, and yearly), along with important details for each variable:

Substitution Variable	Description	Variable Usage	Sample Value	Cube Refresh Required After Value is Updated?
NSP_SYS_LogLevel	Numeric switch: The variable value determines which `println` commands in a Groovy script are executed. A `println` command sends output to the Job Status log.	It's used in all the Groovy scripts to control logging. The variable can be "0", "1", or "2". Set the variable to one of the following options: "0" – Only the `println` commands for the start and end times for a job are printed. "1" – Everything printed for “0” is printed. The contents of the Essbase scripts that are generated by Groovy are also printed. "2" – Everything printed for “1” is printed. The Groovy variable values (“state”) are also printed.	"0"	No
NSP_SYS_BaseCurr1	Currency: Primary Input currency	The variable value is your Primary Input currency.	"GBP"	No

Substitution Variable

Description

Variable Usage

Sample Value

Cube Refresh Required After Value is Updated?

NSP_SYS_LogLevel

Numeric switch: The variable value determines which println commands in a Groovy script are executed. A println command sends output to the Job Status log.

It's used in all the Groovy scripts to control logging. The variable can be "0", "1", or "2".

Set the variable to one of the following options:

"0" – Only the println commands for the start and end times for a job are printed.
"1" – Everything printed for “0” is printed. The contents of the Essbase scripts that are generated by Groovy are also printed.
"2" – Everything printed for “1” is printed. The Groovy variable values (“state”) are also printed.

"0"

NSP_SYS_BaseCurr1

Currency: Primary Input currency

The variable value is your Primary Input currency.

"GBP"

Substitution Variables for Setup

Substitution Variables Requiring Monthly Maintenance

Substitution Variables Requiring Annual Maintenance

Other Substitution Variables

Related Topics