Commonly used JSTL variables in starter store pages

The EnvironmentSetup.jspf file is a configuration file that is commonly included in starter store pages. The variables declared within this file can be modified to change the appearances and behaviors of storefront components.

Styling variables

env_vfileColor: The directory that contains color dependent image files.
env_vfileStylesheet: The name of the cascading style sheet (CSS) file.
env_vfileStylesheetprint: The name of the CSS file for printing order confirmation pages. This file is a printer-friendly CSS file.

Variables used on store pages

storeName: The store name.
userType: The type of the user. This value can be G for guest users, and R for registered users.
storeId: The ID of the store.
langId: The currently selected language ID for the store.
locale: The currently selected locale for the store.
anonymousUser: This variable indicates whether the current user is an anonymous user or not. For example, a user with ID -1002
userId: The ID of the current user.
catalogID: The ID of the store catalog.
lastCmdName: The name of the last command that is run in the page.
urlLangId: This parameter can be passed to wcf:url tags. If passed, this urlLangId variable is used to look up URL keywords. If keywords are not found for this urlLangId, then the store default language ID is used to look up the URL keywords. By default page language ID is set as urlLangId. If store URLs are supported in only one language, then set that language ID as the urlLangId variable.

Store directory variables

env_jspStoreDir: WebAsset directory of the shared file directory. This directory can contain common web file formats such as JSP files, HTML, and images.
jspStoreImgDir: The URL referring to the shared image directory, used to reference images.
storeDir: WebAsset directory of the hosted store. This directory can contain common web file formats such as JSP files, HTML, and images.
storeImgDir: The URL referring to the hosted store home directory, used to reference images.
jsAssetDir: Path that is used to retrieve the JavaScript assets, used to reference JavaScript files.
env_imageContextPath: The path that indicates the context root, which is used for referencing images.

Currency variables

env_currencyDecimal: The number of decimal places for currency. For example, JPY and KRW do not contain any decimal places, while other currencies contain two decimal places.
env_currencyCode: The code for currency, for ex: USD.
env_CurrencySymbolToFormat: The currency symbol in the specified format.
env_languageString: The description of the language.

Presentation variables

env_absoluteURL: A fully qualified URL to use if necessary
env_defaultPageView: The default view in which products are displayed throughout the store.
dojoConfigParams: The Dojo configuration parameters.
dojoFile: The location of the main dojo.js file. This variable must be included in store JSP files to extend Dojo functions.
env_displayListPriceInProductPage: The variable to indicate whether the list price is to be displayed in the product details page
maxSKUs: The maximum number of SKU identifiers for which the details are fetched.
maxOrderItemsPerPage: The maximum number of displayed ordered items in a single page.
env_maxOrderItemsToInspect: The maximum number of ordered items to inspect in the checkout pages.
maxOrderItemsToInspect: The maximum number of ordered items to inspect in the mini shopping cart.
profileShippingNickname: The default shipping address nickname for the quick checkout profile.
profileBillingNickname: The default billing address nickname for the quick checkout profile.
ariaMessageNode: The variable ariaMessageNode is used to indicate the ID of the span where refreshArea is updated with a message when the content is updated. This message notifies the user when a certain section on the page is updated after the refreshArea is completed by using aria live region. The default span is in MessageDisplay.jspf.
env_inPreview: This variable indicates whether the store is running in preview mode.
storeText: The variable to access the messages file of the store.
lazyLoadDepartmentList: Controls the behavior of the catalog browsing menu for all store pages. The catalog browsing menu is typically a menu in the page header that includes a list of departments and categories.
When the value for the variable is true, the menu displays only the top-level category when the page loads. The remaining categories load through an Ajax action when a shopper clicks to view the menu. If the value for the variable is false, the menu displays the entire list of categories. Loading the entire category hierarchy in the menu can affect performance. The default value is true. The setting for this variable applies to all pages in your store. However, you can override the setting for any page. For more information, see Override the loading of categories in the catalog browsing menu.

Variables indicating store supported features

showPONumber: The variable showPONumber is used to indicate whether the purchase order number displays for this store.
showProcessedOrders: Show processed orders in the order status page in the My Account page.
showScheduledOrders: Show scheduled orders in the order status page in the My Account page.
showWaitingForApprovalOrders: Show orders that are waiting for approvals in the order status page in the My Account page.
supportPaymentTypePromotions: The variable is used to indicate whether payment type promotions are supported in the shipping and billing page.
env_subsFulfillmentFrequencyAttrName: The variable is used for subscription products to indicate the name of the fulfillment frequency attribute.
env_subsPaymentFrequencyAttrName: The variable is used for subscription products to indicate the name of the payment frequency attribute.
env_subsTimePeriodAttrName: The variable is used for subscription products to indicate the name of the time period attribute.
showDynamicKit: The variable is used to indicate whether the store supports the display of dynamic kit.
env_b2bStore: The variable indicates whether the store is a B2B store.
env_displayRibbonAdInGridMode: The variable controls whether ribbon ads display for catalog entries in a grid view on store pages.
When the value for the variable is true, a store page must retrieve the attribute information for the catalog entries on the page. The attribute information determines whether any ribbon ads exist for the catalog entries. The retrieval of the attribute information for all catalog entries in a grid view can affect performance. If you do not want to display ribbon ads on store pages, or in a grid view of catalog entries on a page, set the value for the variable to false. When the value is false, ribbon ads display for catalog entries only in list views on store pages. The default value is true.
env_includeJSPFExtension: Controls whether all store pages include the JSPFExtToInclude.jspf file.
When the value for this variable is true, the JSPFExtToInclude.jspf extension file includes other custom JSP files dynamically on all pages for a store. The custom JSP files that the JSPFExtToInclude.jspf file includes on store pages are defined within the STORECONF database table. When your store is dynamically retrieving custom JSP files with this variable, your store performance can be affected. If you do not want to dynamically include custom JSP files, ensure that the value for this variable is false. The default value is false. For more information, see Adding extension logic to all store pages.