Class SitePreferences

• TopLevel.Object
  • dw.object.PersistentObject
    • dw.object.ExtensibleObject
      • dw.system.SitePreferences

SitePreferences is a container for custom site-level attributes. The object corresponds with system object type “SitePreferences”. It has no system attributes and exists only as a place for merchants to define custom attributes which need to be available for each site.

Logically there is only one SitePreferences instance per site. The instance is obtained by calling Site.getPreferences(). Once an instance of the container is obtained, it is possible to read/write site preference values by using the usual syntax for ExtensibleObject instances. For example:

1var sitePrefs : SitePreferences = dw.system.Site.getCurrent().getPreferences();
2var mySitePrefValue : String = sitePrefs.getCustom()["mySitePref"];

Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.

Commerce Cloud Digital defines many site-level preferences, relating to baskets, timezone, locales, customers, etc, which can be managed within the “Site Preferences” module of the Business Manager, but these preferences are not accessible through this object. (SourceCodeURLParameterName is the one exception to this rule.)

This class does not have a constructor, so you cannot create it directly.

describe, getCustom

getCreationDate, getLastModified, getUUID

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

sourceCodeURLParameterName: String (read-only)

Returns the name of the source code url paremeter configured for the site.

getSourceCodeURLParameterName(): String

Returns the name of the source code url paremeter configured for the site.

Returns:

• source code url parameter name