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
COMMERCE/SYSTEM/ANONYMOUSCUSTOMERCLEANUP/batchSize
COMMERCE/SYSTEM/ANONYMOUSCUSTOMERCLEANUP/maxHistory
COMMERCE/SYSTEM/ASSETS/assetLocation
COMMERCE/SYSTEM/ASSETS/cmAssetsSubfolder
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
COMMERCE/SYSTEM/ASSETS/themesSubfolder
COMMERCE/SYSTEM/CATALOG/catalogTopSellerCount
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
COMMERCE/SYSTEM/EMAIL/emailAuthenticationPassword
COMMERCE/SYSTEM/EMAIL/emailAuthenticationUsername
COMMERCE/SYSTEM/EMAIL/emailGlobalSenderAddress
COMMERCE/SYSTEM/EMAIL/emailGlobalSenderName
COMMERCE/SYSTEM/EMAIL/emailTextTemplateEnabled
COMMERCE/SYSTEM/EMAIL/mailHost
COMMERCE/SYSTEM/EMAIL/mailPort
COMMERCE/SYSTEM/FAILEDORDERCLEANUP/batchSize
COMMERCE/SYSTEM/FAILEDORDERCLEANUP/maxHistory
COMMERCE/SYSTEM/FILTEREDNAVIGATION/separatorInToken
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
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
COMMERCE/SYSTEM/ORDERLOCK/minsBeforeCleanUp
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
COMMERCE/SYSTEM/SHIPPING/carriers
COMMERCE/SYSTEM/UNITS/length
COMMERCE/SYSTEM/UNITS/weight
COMMERCE/SYSTEM/datafileEncoding
COMMERCE/SYSTEM/digitalAssetEncryptionKey
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
COMMERCE/SYSTEM/localeDateFormat
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 | 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
COMMERCE/STORE/CATALOG/featuredProductCountToDisplay
COMMERCE/STORE/CATALOG/catalogSitemapPagination
COMMERCE/STORE/FILTEREDNAVIGATION/attributeFilterEnabled
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
COMMERCE/STORE/SESSIONCLEANUP/maxHistory
COMMERCE/STORE/ABANDONEDCARTCLEANUP/maxHistory
COMMERCE/STORE/listPagination
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
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
Search settings
COMMERCE/SEARCH/maxReturnNumber
COMMERCE/SEARCH/minimumSimilarity
COMMERCE/SEARCH/prefixLength
COMMERCE/SEARCH/minimumResultsThreshold
COMMERCE/SEARCH/maximumResultsThreshold
COMMERCE/SEARCH/maximumSuggestionsPerWord
COMMERCE/SEARCH/accuracy
COMMERCE/SEARCH/boosts
COMMERCE/SEARCH/excludeAttributes
COMMERCE/SEARCH/indexOptimizationInterval
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. |
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. |