1. NetSuite Enterprise Performance Management
  2. NetSuite Planning and Budgeting
  3. NSPB Sync SuiteApp
  4. NSPB Sync Setup Guide
  5. NSPB Sync Functionality in NetSuite UI
  6. Substitution Variables

Substitution Variables

If you have the Administrator role, you can use NetSuite to review and edit values of substitution variables configured in your Planning and Budgeting. You can also identify substitution variables the values of which you want to update automatically.

To review or edit a substitution variable in NetSuite:

  1. Go to Planning & Budgeting > Setup > Substitution Variables.

    A page opens with substitution variables categorized under the following subtabs:

    • Monthly Maintenance for substitution variables that you need to update monthly.

    • Yearly for substitution variables that you need to update yearly.

    • Setup for substitution variables that you need to configure.

    • Other for substitution variables that you did not assign to any of the above categories.

      Important:

      To display a substitution variable under the Other subtab, you first need to create it in your Planning and Budgeting. The substitution variable is listed under the Other subtab until you assign it to a category. See Categorizing the Substitution Variables.

      Tip:

      If you want to translate the names of the categories, or create your custom categories to better suit your needs, see Creating and Customizing Categories for Substitution Variables.

  2. Click any of the subtabs to update the New Value field for a substitution variable of your choice.

  3. Click Save.

    This updates the value of the substitution variable directly in your Planning and Budgeting.

  4. To enable automatic update of substitution variables values, click the Advance Values button. For a complete description of this feature, see Enabling Automatic Update of Substitution Variables Values.

Note:

NSPB Sync does not store values of the substitution variables in NetSuite. The values are dynamically retrieved from your Planning and Budgeting. When you update a substitution variable in NetSuite, the substitution variable is dynamically updated in your Planning and Budgeting.

For monthly maintenance of substitution variables, you can use the Planning & Budgeting Substitution Variables Portlet.

Categorizing the Substitution Variables

For your convenience, you can split the list of substitution variables into categories.

To categorize the substitution variables:

  1. Go to Customization > Lists, Records, & Fields > Record Types.

  2. Click List for the NSPB | Substitution Variables record type.

  3. Click New NSPB | Substitution Variables.

  4. In the Name field, paste the name of a substitution variable that you copied from the Other subtab at Planning & Budgeting > Setup > Substitution Variables.

    The value must match exactly, including upper and lower case.

    Important:

    To display a substitution variable under the Other subtab, you first need to create it in your Planning and Budgeting.

  5. In the Description field, enter a description to help you identify this substitution variable in NetSuite.

  6. From the Category dropdown list, select a category for this substitution variable. If you select New, you can create your custom category right away:

    1. In the Name field, enter a name for your custom category.

    2. Click Save.

    3. Select the created custom category from the Category dropdown list.

      For instructions on how you can create a list of custom categories, see Creating and Customizing Categories for Substitution Variables.

  7. (Optional) From the Auto-Update Action dropdown list, select an option for automatic update of the substitution variable values. For a complete description of this feature, see Enabling Automatic Update of Substitution Variables Values.

  8. Click Save.

    This moves the substitution variable to the appropriate subtab at Planning & Budgeting > Setup > Substitution Variables.

Creating and Customizing Categories for Substitution Variables

For your convenience, you can move the substitution variables into custom categories that you have created in NetSuite. You can also create translations for categories.

To create and customize categories:

  1. Go to Customization > Lists, Records, & Fields > Lists.

    Tip:

    To narrow the displayed list, you can do the following:

    1. Expand the Filters area if the filters are not displayed.

    2. From the From Bundle filter, select the bundle ID.

  2. Click NSPB Sub Var Category.

  3. On the Values subtab, add your custom categories one by one.

  4. If you have the Multi-Language feature enabled in your NetSuite account, click in the Translation column to enter translations for categories.

    For instructions on enabling the Multi-Language feature and setting up your preferred language, see Enabling Multiple Languages, Configuring Multiple Languages, and Choosing a Language for Your NetSuite User Interface.

  5. When finished, click Save.

    You can then see your custom and translated categories at Planning & Budgeting > Setup > Substitution Variables. To split the substitution variables into these categories, proceed as described in Categorizing the Substitution Variables.

Enabling Automatic Update of Substitution Variables Values

In NetSuite, you can identify substitution variables the values of which you want to update automatically. NSPB Sync then updates the values dynamically in your Planning and Budgeting.

To enable automatic update of substitution variables values:

  1. Go to Customization > Lists, Records, & Fields > Record Types.

  2. Click List for the NSPB | Substitution Variables record type.

  3. In the displayed list of substitution variables, do one of the following:

    • Next to the substitution variable for which you want to update its values automatically, click Edit.

    • To add a substitution variable to the list, click New NSPB | Substitution Variables, and follow steps 4 through 6 in the help topic Categorizing the Substitution Variables.

  4. From the Auto-Update Action dropdown list, select one from the following options:

    • Advance to Next Period (12) – If you use a 12-period calendar in your Planning and Budgeting, this option increases the value of the substitution variable incrementally up to 12, and then restarts from 1.

    • Advance to Next Period (13) – If you use a 13-period calendar in your Planning and Budgeting, this option increases the value of the substitution variable incrementally up to 13, and then restarts from 1.

      For information about a 13-period calendar, see the Oracle Help Center topic About 13-Period Calendars.

    • Advance to Next Year – This option increases the value of the substitution variable incrementally from one calendar year to the next.

    Note:

    The New option to create your custom auto-update action is not currently supported.

  5. Click Save.

  6. Repeat steps 3 through 5 for all the other substitution variables the values of which you want to update automatically.

  7. When finished, go to Planning & Budgeting > Setup > Substitution Variables.

  8. Click the Advance Values button.

    This opens a page that lists all the substitution variables for which you have selected an auto-update option in step 4.

  9. To narrow the list, select one or more of the following auto-update options:

    • Advance to Next Period

    • Advance to Next Year

  10. Click Next.

    This lists substitution variables for any of the selected auto-update options.

  11. In the New Value column, validate the new value for each substitution variable in the list. If necessary, you can update the value. The current value is displayed in the Value column.

    Read the following details about the format of the substitution variables values:

    • The year format that you should use for the substitution variables values is "FY<yy>". The values then raise incrementally from one calendar year to the next, for example, from "FY23" to "FY24".

    • The monthly format that you should use for the substitution variables values is "TP<index of the month>". The values then raise incrementally depending on the existing fiscal calendar in your Planning and Budgeting:

      • If you use a 12-period calendar, the value of the substitution variable increases incrementally up to 12, and then restarts from 1. For example, "TP11" raises to "TP12" and "TP12" raises to "TP1".

      • If you use a 13-period calendar, the value of the substitution variable increases incrementally up to 13, and then restarts from 1. For example, "TP12" raises to "TP13" and "TP13" raises to "TP1".

        For information about a 13-period calendar, see the Oracle Help Center topic About 13-Period Calendars.

  12. To confirm the action, check the Confirm New Values box.

  13. Click Save.

    This updates all the listed substitution variables to the new values directly in your Planning and Budgeting.

Related Topics

General Notices