Elastic Path Commerce Development

System Configuration Settings Reference

System Configuration Settings Reference

This page contains descriptions of the settings that can be configured in the Configuration area of the Elastic Path Admin Console.

System settings

COMMERCE/SYSTEM/ABANDONEDCARTCLEANUP/batchSize

Field Description
Type Integer
Default value 1000
Context None. (System and cache settings are system-wide.)
Description The maximum number of carts to cleanup in one transaction.

COMMERCE/SYSTEM/ANONYMOUSCUSTOMERCLEANUP/batchSize

Field Description
Type Integer
Default refresh strategy application
Default value 1000
Context None. (System and cache settings are system-wide.)
Description The maximum number of anonymous customers to cleanup in one transaction.

COMMERCE/SYSTEM/ANONYMOUSCUSTOMERCLEANUP/maxHistory

Field Description
Type Integer
Default refresh strategy application
Default value 60
Context None. (System and cache settings are system-wide.)
Description The number of days of anonymous customer history to keep before a Quartz job clears it.

COMMERCE/SYSTEM/ASSETS/assetLocation

Field Description
Type String

Default refresh strategy

application
Default value -
Context None. (System and cache settings are system-wide.)
Description The path to the directory that contains assets required by the application, including images, theme files, and digital goods.

COMMERCE/SYSTEM/ASSETS/cmAssetsSubfolder

Field Description
Type String
Default refresh strategy application
Default value cmassets
Context None. (System and cache settings are system-wide.)
Description The name of the subfolder within the assets directory that contains non store specific resources, such as email message templates.

COMMERCE/SYSTEM/ASSETS/contentWrappersLocation

Field Description
Type String

Default refresh strategy

interval:timeout=COMMERCE/Cache/Cache_1
Default value content-wrappers
Context None. (System and cache settings are system-wide.)
Description The name of the subfolder within the assets directory that contains the Content Wrapper XML and CWT files.

COMMERCE/SYSTEM/ASSETS/importAssetsSubfolder

Field Description
Type String
Default value import
Context None. (System and cache settings are system-wide.)
Description The name of the subfolder within the assets directory that contains imported CSV files.

COMMERCE/SYSTEM/ASSETS/themesSubfolder

Field Description
Type String
Default refresh strategy application

Default value

themes
Context None. (System and cache settings are system-wide.)
Description The name of the subfolder within the assets directory that contains store themes.

COMMERCE/SYSTEM/CATALOG/catalogTopSellerCount

Field Description
Type Integer
Default refresh strategy session
Default value 2

Context

None. (System and cache settings are system-wide.)
Description The number of top seller products to display when browsing categories in the store. (The top seller job must also be enabled.)

COMMERCE/SYSTEM/CHANGESETS/enable

Field Description
Type Boolean
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value false
Context

None. (System and cache settings are system-wide.)

Description Determines whether change sets are enabled. When set to true, CM users can add objects to a change set to prevent others from editing them. Setting this to false will disable the feature.

COMMERCE/SYSTEM/CONTENTWRAPPERS/reloadInterval

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 600
Context None. (System and cache settings are system-wide.)
Description Specifies how often the content wrapper XML files and templates (*.cwt) are reloaded (in seconds).

COMMERCE/SYSTEM/EMAIL/emailAuthenticationPassword

Field Description
Type String
Default value 111111
Context None. (System and cache settings are system-wide.)
Description The password used to authenticate with the EmailService.

COMMERCE/SYSTEM/EMAIL/emailAuthenticationUsername

Field Description
Type String
Default value cmuser
Context None. (System and cache settings are system-wide.)
Description The username used to authenticate with the Email service.

COMMERCE/SYSTEM/EMAIL/emailGlobalSenderAddress

Field Description
Type String
Default value customerService@SomeDomain.com
Context None. (System and cache settings are system-wide.)
Description The email address used to send out global, non store specific emails.

COMMERCE/SYSTEM/EMAIL/emailGlobalSenderName

Field Description
Type String
Default value Customer Service
Context None. (System and cache settings are system-wide.)
Description The sender name used in global, non store specific emails.

COMMERCE/SYSTEM/EMAIL/emailTextTemplateEnabled

Field Description
Type Boolean
Default value false
Context None. (System and cache settings are system-wide.)
Description Determines whether to use the plain text template for sending store emails. Set to true to use the plain text template or false to use the HTML template.

COMMERCE/SYSTEM/EMAIL/mailHost

Field Description
Type String
Default value -
Context None. (System and cache settings are system-wide.)
Description The host name of the email server.

COMMERCE/SYSTEM/EMAIL/mailPort

Field Description
Type Integer
Default value -
Context None. (System and cache settings are system-wide.)
Description The listener port of the email server.

COMMERCE/SYSTEM/FAILEDORDERCLEANUP/batchSize

Field String
Type String
Default value 1000
Context None. (System and cache settings are system-wide.)
Description The maximum number of failed orders to clean up in one transaction.

COMMERCE/SYSTEM/FAILEDORDERCLEANUP/maxHistory

Field Description
Type String
Default value 60
Context None. (System and cache settings are system-wide.)

Description

The number of days orders with state failed will be kept before a Quartz job removes them from the system.

COMMERCE/SYSTEM/FILTEREDNAVIGATION/separatorInToken

Field Description
Type String
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_2
Default value _
Context None. (System and cache settings are system-wide.)
Description Defines the field separator that is used in the filtered navigation.

COMMERCE/SYSTEM/FILTEREDNAVIGATION/filteredNavigationConfiguration

Field Description
Type String
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_2
Default value
<!-- Configuration file for filtered navigation -->
<!-- For range values, lower bounds are inclusive, upper values are exclusive. -->
<IntelligentBrowsing>
</IntelligentBrowsing>
Context None. (System and cache settings are system-wide.)
Description The configuration XML for filtered (faceted) navigation.

COMMERCE/SYSTEM/IMPORT/importJobMaxAge

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 172800
Context None. (System and cache settings are system-wide.)
Description The maximum age (in seconds) a completed import job will remain in the database before it is deleted by the import job clean-up processor.

COMMERCE/SYSTEM/IMPORT/staleImportJobTimeout

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 5
Context None. (System and cache settings are system-wide.)
Description The period of time (in minutes) before an import job is considered stale.

COMMERCE/SYSTEM/MESSAGING/ORDERS/channelUri

Field Description
Type String
Default value jms:topic:VirtualTopic.ep.orders
Context None. (System and cache settings are system-wide.)
Description

The URI of the channel on which Order Event messages are sent and received. Changes will not take effect until applications using this setting have been restarted.

COMMERCE/SYSTEM/ORDERLOCK/batchSize

Field Description
Type Integer
Default value 200
Context None. (System and cache settings are system-wide.)
Description The maximum number of order locks to clean up in one transaction.

COMMERCE/SYSTEM/ORDERLOCK/minsBeforeCleanUp

Field Description
Type Integer
Default value 120
Context None. (System and cache settings are system-wide.)
Description The number of minutes to maintain order locks. At the end of this period, all order locks will be deleted by the cleanupOrderLocksJob Quartz job.

COMMERCE/SYSTEM/SEARCH/searchHost

Field Description
Type String
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value -
Context None. (System and cache settings are system-wide.)
Description The search server's URL. If this is not set correctly, searching and browsing in the store and in Admin Console will not work. For a search server cluster, this setting must contain two values. The default value must be set to the load balancer URL. A defined value with the context set to 'master' must be set to the master search server URL.

COMMERCE/SYSTEM/SESSIONCLEANUP/batchSize

Field Description
Type Integer
Default value 1000
Context None. (System and cache settings are system-wide.)
Description The maximum number of customer sessions to clean up in one transaction.

COMMERCE/SYSTEM/SHIPPING/carriers

Field Description
Type String
Default value Fed Ex, UPS, Canada Post, Royal Mail
Context None. (System and cache settings are system-wide.)
Description The comma-delimited list of supported shipping carriers.

COMMERCE/SYSTEM/UNITS/length

Field Description
Type String
Default value CM
Context None. (System and cache settings are system-wide.)
Description The unit of measurement applying to all product lengths. For example, CM or FT.

COMMERCE/SYSTEM/UNITS/weight

Field Description
Type String
Default value KG
Context None. (System and cache settings are system-wide.)
Description The unit of measurement applying to all product weights. For example, KG or LB.

COMMERCE/SYSTEM/datafileEncoding

Field Description
Type String
Default refresh strategy session
Default value UTF-8
Context None. (System and cache settings are system-wide.)
Description The character encoding used to import CSV data files and to export data files and reports.

COMMERCE/SYSTEM/digitalAssetEncryptionKey

Field Description
Type String
Default value digital asset encryption key must be changed in production
Context None. (System and cache settings are system-wide.)
Description The encryption key used to encrypt the URLs of digital assets. The key must be at least 25 characters long.

COMMERCE/SYSTEM/emailEnabled

Field Description
Type Boolean
Default value true
Context None. (System and cache settings are system-wide.)
Description Specifies whether email is enabled. If set to false, the system does not send any email (order confirmations, password changes, etc.) If it is set to true, the system will attempt to send email as required. Make sure all other email related settings are set correctly when this setting is true, otherwise an error will occur when attempting to send email.

COMMERCE/SYSTEM/encryptionKey

Field Description
Type String
Default value this must be changed in production
Context None. (System and cache settings are system-wide.)
Description

The encryption key used to encrypt credit card numbers. The key must be at least 25 characters long.

COMMERCE/SYSTEM/localeDateFormat

Field Description
Type String
Default value EEE MMM dd HH:mm:ss yyyy
Context None. (System and cache settings are system-wide.)
Description The format of date strings in import files.

COMMERCE/SYSTEM/userIdMode

Field Description
Type Integer
Default refresh strategy application

Default value

1
Context None. (System and cache settings are system-wide.)
Description Specifies how customer user IDs are created. If set to 1, the customer's email address is used. If set to 2, a unique ID is generated by some other means (through a customization). This should be set to 1 unless you have a customization that requires it.

Store-specific settings

COMMERCE/STORE/theme

Field Description
Type String
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_2
Default value electronics
Context The store code.
Description The theme associated with the store. (The name of the subfolder under the themes directory that contains the theme's templates, CSS files, and other resources.)

COMMERCE/STORE/CATALOG/catalogViewPagination

Field Description
Type Integer

Default refresh strategy

session
Default value 20
Context The store code.
Available in Store Marketing tab true
Description The maximum number of items to display per page when browsing the catalog in the storefront.
COMMERCE/STORE/SEARCH/searchCategoriesFirst
Field Description
Type Boolean

Default refresh strategy

interval:timeout=COMMERCE/Cache/Cache_1
Default value true
Context The store code.
Available in Store Marketing tab true
Description When set to true, searches in the storefront will search categories before searching products, and if a category match is found, the first matching category page is displayed instead of the search results page.

COMMERCE/STORE/PRODUCTRECOMMENDATIONS/numberOrderHistoryDays

Field Description
Type Integer

Default refresh strategy

session
Default value 3
Context The store code.
Available in Store Marketing tab true
Description The number of days of historical order data to use when calculating product recommendations. For example, if the value is 3, product recommendations are calculated based on all orders created during the past three days.

COMMERCE/STORE/PRODUCTRECOMMENDATIONS/numberMaxRecommendations

Field Description
Type Integer
Default value 3
Context

The store code.

Available in Store Marketing tab true
Description The maximum number of product recommendations to display.

COMMERCE/STORE/CATALOG/featuredProductCountToDisplay

Field Description
Type Integer
Default refresh strategy session
Default value 2
Context The store code.
Available in Store Marketing tab true
Description The number of featured products to display when browsing a catalog with either no filters or only one filter applied.

COMMERCE/STORE/CATALOG/catalogSitemapPagination

Field Description
Type Integer
Default value 90
Context The store code.
Available in Store Marketing tab true
Description

The maximum number of products listed on a page in the sitemap.

COMMERCE/STORE/FILTEREDNAVIGATION/attributeFilterEnabled

Field Description
Type Boolean
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_3
Default value true
Context The store code.
Description True if attribute filtering is enabled for filtered navigation, false if not.

COMMERCE/STORE/storefrontUrl

Field Description
Type String
Default value https://localhost:8443/storefront
Context The store code.
Description The secure (HTTPS) storefront URL. This URL is used by the Commerce Manager application for CSR login on behalf of customers. Certain customer service activities, such as editing orders, require the CSR to log in as the customer. The Commerce Manager application uses this URL to perform the login. If the specified URL does not begin with https://, the login request will fail and the CSR will not be able to perform the action.

COMMERCE/STORE/SEARCH/showBundlesFirst

Field Description
Type Boolean
Default value true

Context

The store code.

Available in Store Marketing tab

true
Description Set to true to display product bundles before other products in storefront search results.

COMMERCE/STORE/SESSIONCLEANUP/maxHistory

Field Description
Type Integer
Default value 60
Context The store code.
Description The number of days of customer session history to maintain. At the end of this period, all sessions with empty shopping carts are removed by the cleanupSessionsJob Quartz job.

COMMERCE/STORE/ABANDONEDCARTCLEANUP/maxHistory

Field Description
Type Integer
Default value 60
Context The store code.
Description This setting controls the number of days of cart history to keep before a Quartz job clears it.

COMMERCE/STORE/listPagination

Field Description
Type Integer
Default value 20
Context The store code.
Description The maximum number of list elements per page that the API resource will return for paginated objects.

Application-specific settings

COMMERCE/APPSPECIFIC/RCP/minimumPasswordLength

Field Description
Type Integer
Default value 8
Context The application name.
Description The minimum user password length. Note that the default value complies with PCI DSS security guidelines. Before changing this setting, make sure the change is compatible with your organization's PCI compliance policy.

COMMERCE/APPSPECIFIC/RCP/maximumPasswordAge

Field Description
Type Integer
Default value 90
Context The application name.
Description The number of days after first logon before the user password expires. Note that the default value complies with PCI DSS security guidelines. Before changing this setting, make sure the change is compatible with your organization's PCI compliance policy.

COMMERCE/APPSPECIFIC/RCP/passwordHistoryLength

Field Description
Type Integer
Default value 4
Context The application name.
Description Number of passwords without repetition including current user password.

COMMERCE/APPSPECIFIC/RCP/accountLockoutThreshold

Field Description
Type Integer
Default value 6
Context The application name.
Description The minimum number of unique passwords, including current CM user password, before the user can re-use a previous password. Note that the default value complies with PCI DSS security guidelines. Before changing this setting, make sure the change is compatible with your organization's PCI compliance policy.

COMMERCE/APPSPECIFIC/RCP/idleTimeForLock

Field Description
Type Integer
Default value 15
Context The application name.
Description

Number of minutes of inactivity before the Commerce Manager is locked and the user is required to re-enter their password. Set to 0 to disable. Note that the default value complies with PCI DSS security guidelines. Before changing this setting, make sure the change is compatible with your organization's PCI compliance policy.

COMMERCE/APPSPECIFIC/RCP/PRICING/maximumBaseAmounts

Field Description
Type Integer
Default value 1000
Context The application name.
Description The maximum number of base amount rows to display in the pricing editor.

Search settings

COMMERCE/SEARCH/maxReturnNumber

Field Description
Type Integer

Default refresh strategy

interval:timeout=COMMERCE/Cache/Cache_1
Default value 0
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description The maximum number of matching items to include in search results. The default is 0, which specifies no limit.

COMMERCE/SEARCH/minimumSimilarity

Field Description
Type BigDecimal
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 0.75
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Used for fuzzy searching. This specifies how similar a term must be in order to match the query term. It must be set to a value between 0 and 1, not inclusive. (1 means it must be an exact match and 0 means the terms do not need to match at all.)

COMMERCE/SEARCH/prefixLength

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 0
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Used for fuzzy searching. Specifies the number of characters at the start of the search term that must be the same in potential matches.

COMMERCE/SEARCH/minimumResultsThreshold

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 10
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Used by the spell checker. Results that are below or equal to this number will trigger a spelling suggestion lookup.

COMMERCE/SEARCH/maximumResultsThreshold

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 10000
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Used by the spell checker. Results that are above or equal to this number will trigger a spelling suggestion lookup.

COMMERCE/SEARCH/maximumSuggestionsPerWord

Field Description
Type Integer
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value 3
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Used by the spell checker. The maximum number of spelling suggestions to return.

COMMERCE/SEARCH/accuracy

Field Description
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Type BigDecimal
Default value 0.75
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Sets the accuracy of spelling suggestions. This value works the same as COMMERCE/SEARCH/minimumSimilarity.

COMMERCE/SEARCH/boosts

Field Description
Type Map<String, String>
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value -
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description A comma-separated list of field name/value pairs that attribute greater importance to values matched in specific fields. For example: "categoryCode=0.5,productCode=0.5,categoryName_en=2.0,description_en=0.2". By default, all fields have a boost value of 1.0.

COMMERCE/SEARCH/excludeAttributes

Field Description
Type Collection<String>
Default refresh strategy interval:timeout=COMMERCE/Cache/Cache_1
Default value -
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Specifies a comma-separated list of attribute keys that should be not be included when searching all fields. For example: "A00981,A01012"

COMMERCE/SEARCH/indexOptimizationInterval

Field Description
Type Integer

Default value

720
Context If the setting is application-specific, the format is: APPSPECIFIC/appName/indexName
Where:
  • appName is the application name (RCP)
  • indexName is the index name (product, category, customer, order, orderreturn, or promotion)

If the setting is store-specific, the format is: STORE/storeCode/indexName

Where:
  • storeCode is the store code
  • indexName is the index name (product or category)
Note:

The context is case-sensitive.

Description Specifies how often (in minutes) the index specified in the context is optimized. Optimization is only required after an index is updated, so if the index is updated frequently, you may want to optimize more frequently by specifying a lower value. Note that the repeatInterval property of the optimizeSearchIndicesTrigger bean determines the smallest interval between index optimizations; if indexOptimizationInterval is less than repeatInterval, then the effective interval will be the repeatInterval.

Cache settings

COMMERCE/Cache/Cache_1

Field Description
Type Integer
Default value 300000
Context

None. (System and cache settings are system-wide.)

Description For each setting that is mapped to this cache, specifies the period of time (in milliseconds) during which the setting value is cached. At the end of the interval, the cached value is invalidated and the next time it is requested, the value is retrieved directly from the database and the cache is updated. The name of this setting can be used when specifying the refresh strategy for another setting. To assign a setting to this cache, set the value of that setting's apiRefreshStrategy metadata setting to interval:timeout=COMMERCE/Cache/Cache_1.

COMMERCE/Cache/Cache_2

Field Description
Type Integer
Default value 60000
Context

None. (System and cache settings are system-wide.)

Description For each setting that is mapped to this cache, specifies the period of time (in milliseconds) during which the setting value is cached. At the end of the interval, the cached value is invalidated and the next time it is requested, the value is retrieved directly from the database and the cache is updated. The name of this setting can be used when specifying the refresh strategy for another setting. To assign a setting to this cache, set the value of that setting's apiRefreshStrategy metadata setting to interval:timeout=COMMERCE/Cache/Cache_2.

COMMERCE/Cache/Cache_3

Field Description
Type Integer
Default value 60000
Context

None. (System and cache settings are system-wide.)

Description For each setting that is mapped to this cache, specifies the period of time (in milliseconds) during which the setting value is cached. At the end of the interval, the cached value is invalidated and the next time it is requested, the value is retrieved directly from the database and the cache is updated. The name of this setting can be used when specifying the refresh strategy for another setting. To assign a setting to this cache, set the value of that setting's apiRefreshStrategy metadata setting to interval:timeout=COMMERCE/Cache/Cache_2.
COMMERCE/STORE/FILTEREDNAVIGATION/filteredNavigationConfiguration
Value type String

Default refresh strategy

interval:timeout=COMMERCE/Cache/Cache_2

Default value

<!-- Configuration file for filtered navigation -->
<!-- For range values, lower bounds are inclusive, upper values are exclusive. -->
<IntelligentBrowsing>
</IntelligentBrowsing>

Context

None. (System and cache settings are system-wide.)

Description

The configuration XML for filtered (faceted) navigation.