Broadleaf Runtime Properties
When the application starts up, Broadleaf provides a mechanism to merge and override properties files based on the current environment that is being used. Broadleaf will look in the classpath for the following files, in order, to merge (later files override earlier files if two properties collide):
common-shared.propertiesin the core project[specific-environment]-shared.propertiesin the core projectcommon.propertiesin either site or admin project, depending on which app is starting[specific-environment].propertiesin either site or admin project, depending on which app is starting- JVM Args:
-Dproperty-override-sharedspecified value, if any-Dproperty-overridespecified value, if any
The following is a list of all runtime properties that are available:
Account Module
- account.pending-order.notification.email.fromAddress
- "From" address for pending order notification emails
- account.pending-order.notification.email.subject
- Subject line for pending order notification emails
- account.solr.search.method
- Runtime configuration property for account solr search method
- Default:
METHOD.POST
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- enable.account.archive
- Enable soft delete for Account and AccountXref
- typeahead.quick_order_products.limit
- Batch size or maximum number of items processed per batch for typeahead quick order products
- Default:
6
- use.account.name.for.id
- Runtime configuration property for use account name for id
- Default:
true
- use.email.for.site.login
- Account identifier or username for use email for site
- Default:
true
- validate.customer.owned.data
- Runtime configuration property for validate customer owned data
- Default:
true
Advanced CMS
- advancedcms.contentItem.showEmptyGroups
- Setting this property to
truewill force the Admin to display ContentData that don't have any fields on ContentItems
- Setting this property to
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- category.site.map.generator.row.limit
- Max number of rows queried at a time by the CategorySiteMapGenerator
- htmlPropertyValidator.allowThymeleafExpressions
- Runtime configuration property for html property validator allow thymeleaf expressions
- Default:
true
- htmlPropertyValidator.requireStrictXml
- Runtime configuration property for html property validator require strict xml
- Default:
true
- include.non.overridden.sc.items
- Make override SCItems opt-out by default
- notifications.email.tracking
- Setting this property to
truewill track email sending and add records to the BLC_EMAIL_TRACKING table - resolve.widgets.from.classpath
- Runtime configuration property for resolve widgets from classpath
- Default:
true
- widget.classpath.prefix
- Configures the prefix string for widget classpath
- Default:
widgets/
Advanced Inventory
- advanced-inventory.import.batchSize
- How many inventory import records should be dealt with at a time This number should be tailored to your imports and machine specs
- Default:
50
- advanced-inventory.import.retries
- The amount of times the inventory import should retry because it was unsuccessful due to the inventory record being changed while trying to set it via the import
- Default:
2
- advanced-inventory.item.reservation.strategy
- In order to customize how inventory reservations are distributed within a FulfillmentGroup, there is a common interface called InventoryReservationStrategy.
- To select between the OOB strategies, override the this system property with one of the following values:
SINGLE_PER_GROUP- Single location per gorupSINGLE_PER_ITEM- Single location per itemMULTIPLE_PER_ITEM- Multiple locations per item
- advanced-inventory.notification.email.fromAddress
- From address for inventory notification emails
- advanced-inventory.notification.email.subject
- Subject line for inventory notification emails
- advanced-inventory.notification.job.pagesize
- How many notifications to process at a time
- advanced-inventory.operation.maxretries
- Retry policy for inventory modifications.
- This is used to wrap around invocations to
inventoryService#save()that could throw a ConcurrentInventoryModificationException in a high-contention scenario
- advanced-inventory.prioritize.higher.quantity
- Used to give the maximum inventory quantity available at a FulfillmentLocation first priority
- advanced-inventory.prioritize.lower.quantity
- Used to give the minimum inventory quantity available at a FulfillmentLocation first priority
- advanced-inventory.quantityOnHand.management.enabled
- Whether the quantityOnHand field should display anywhere in the Admin.
- This is not enabled by default, as this is not incremented or decremented
Advanced Offer
- advancedOffers.export.api.defaultPageSize
- Runtime configuration property for advanced offers export api default page size
- advancedOffers.export.batchSize
- Batch size or maximum number of items processed per batch for advancedOffers export
- Default:
100
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- event.generateoffercodes.worker.type
- Specifies the node where offer codes generation event will be consumed
- ADMIN by default
- import.offerCode.batch.size
- Runtime configuration property for import offer code batch size
- Default:
100
- offer.code.addPromo.path
- File system or resource path configuration for offer code addPromo
- Default:
/cart/promo
- offer.code.cookie.max.age
- This is the time, in seconds, that an offer code cookie should be set for. A value of -1 means never expire. 0 (zero) means don't set the cookie or expire immediately. A value greater than 0 is the number of seconds that a cookie should last. The default value is 86400, or 24 hours.
- offer.code.cookie.name
- This is the name of the offer code cookie(s)
- Default:
_blOfferCode
- offer.code.cookie.value.delimiter
- This is the delimiter that should be used to parse the cookie. By default, it is an plus sign (+). Because of security features surrounding the use of HTTP Cookies, this delimiter must be one of the following: - * . + _
- offer.code.removePromo.path
- File system or resource path configuration for offer code removePromo
- Default:
/cart/promo/remove
- offer.code.request.param.name
- This is the name of the offer code request parameter(s)
- Default:
_blOfferCode
- offer.code.storage.use.session
- Property that dictates how the offer code is stored (in cookie or in session)
- Default:
false
- offer.code.use.old.flow
- Runtime configuration property for offer code use old flow
- Default:
true
- offerCode.maxCodeGeneration
- Runtime configuration property for offer code max code generation
- Default:
100000
- offerCodeGeneration.batchSize
- Batch size or maximum number of items processed per batch for offerCodeGeneration
- offerCodeGeneration.retryCount
- Maximum number of retry attempts for offerCodeGeneration
- Default:
3
- promotion.message.default.cache.seconds
- Configures the duration or polling interval for promotion message default cache
Affiliate Module
- tracking.code.attribution.model
- Model for source attribution ( LIFO or FIFO )
- Default:
LIFO
- tracking.code.url.param
- URL Parameter for a tracking code
- Default:
tc
API
- product.wrapper.include.price.data
- Whether or not detailed price data should be included in API response for Product data Note: This serves as a default value & can be overridden using a request parameter
- product.wrapper.include.promotion.messages
- Whether or not Promotion Messages should be included in API response for Product data Note: This serves as a default value & can be overridden using a request parameter
- request.uri.encoding
- Runtime configuration property for request uri encoding
Amazon S3 Integration
- aws.s3.accessKeyId
- Amazon AWS S3. Used in blc-amazon module
- aws.s3.bucketSubDirectory
- Runtime configuration property for aws s3 bucket sub directory
- aws.s3.defaultBucketName
- Runtime configuration property for aws s3 default bucket name
- aws.s3.defaultBucketRegion
- Runtime configuration property for aws s3 default bucket region
- aws.s3.endpointURI
- Runtime configuration property for aws s3 endpoint u r i
- Default:
https://s3.amazonaws.com
- aws.s3.secretKey
- Runtime configuration property for aws s3 secret key
- aws.s3.sse
- Enable or disable server side encryption for S3 Uploads
- Default:
false
- aws.s3.useInstanceProfile
- Get credentials from instance if on EC2
- Default:
false
Authorize.net
- gateway.authorizenet.acceptJsUrl
- Runtime configuration property for gateway authorizenet accept js url
- Default:
https://js.authorize.net/v1/Accept.js
- gateway.authorizenet.apple.keyStoreFilePath
- Runtime configuration property for gateway authorizenet apple key store file path
- gateway.authorizenet.apple.keyStorePassword
- Runtime configuration property for gateway authorizenet apple key store password
- gateway.authorizenet.apple.merchantId
- Account identifier or username for gateway authorizenet apple
- gateway.authorizenet.apple.verifiedDomainDisplayName
- Runtime configuration property for gateway authorizenet apple verified domain display name
- gateway.authorizenet.apple.verifiedDomainName
- Runtime configuration property for gateway authorizenet apple verified domain name
- gateway.authorizenet.clientKey
- Runtime configuration property for gateway authorizenet client key
- gateway.authorizenet.confirmUrl
- Runtime configuration property for gateway authorizenet confirm url
- gateway.authorizenet.errorUrl
- Runtime configuration property for gateway authorizenet error url
- gateway.authorizenet.gatewayMerchantId
- Runtime configuration property for gateway authorizenet gateway merchant id
- gateway.authorizenet.loginId
- Account identifier or username for gateway authorizenet
- gateway.authorizenet.merchantMd5Key
- Runtime configuration property for gateway authorizenet merchant md5 key
- gateway.authorizenet.responseUrl
- Runtime configuration property for gateway authorizenet response url
- gateway.authorizenet.sandbox
- Runtime configuration property for gateway authorizenet sandbox
- Default:
true
- gateway.authorizenet.serverUrl
- Runtime configuration property for gateway authorizenet server url
- gateway.authorizenet.transactionKey
- Runtime configuration property for gateway authorizenet transaction key
- gateway.authorizenet.transactionVersion
- Runtime configuration property for gateway authorizenet transaction version
- gateway.authorizenet.xTestRequest
- Runtime configuration property for gateway authorizenet x test request
Braintree
- gateway.braintree.environment
- Runtime configuration property for gateway braintree environment
- gateway.braintree.merchantId
- Account identifier or username for gateway braintree
- gateway.braintree.privateKey
- Runtime configuration property for gateway braintree private key
- gateway.braintree.publicKey
- Runtime configuration property for gateway braintree public key
- gateway.braintree.transparentRedirectCreditCardUrl
- Runtime configuration property for gateway braintree transparent redirect credit card url
- gateway.braintree.transparentRedirectCustomerUrl
- Runtime configuration property for gateway braintree transparent redirect customer url
- gateway.braintree.transparentRedirectTransactionUrl
- Runtime configuration property for gateway braintree transparent redirect transaction url
Broadleaf Commerce Private
CMS
- admin.image.file.extensions
- Specifies valid image extensions for the Admin
- allowed.file.extensions
- Specifies a comma-separated whitelist of upload file extensions, if specified disabled.file.extensions are ignored
- asset.server.allow.unnamed.image.manipulation
- Dis/allows image manipulation through URL parameters and not only through named operations
- asset.server.file.buffer.size
- The number of bytes from the input stream that will be read at a time
- asset.server.max.generated.file.system.directories
- This value will be used to determine the number of directories created to store images and other assets on the filesystem using a set of generated directories based on the MD5 value of the filename.
2supports a distribution of about 10 million files and is suitable for most purposes.3would add support for over 2 billion, but for implementations of this size, distributed file system options should be considered.
- asset.server.max.uploadable.file.size
- The maximum file size that can be uploaded (10 Meg)
- Implementors should tune this according to their needs.
- asset.server.max.uploadable.image.size
- backwards-compatibility checks, only use the image-size specific property if it is not the default value. Otherwise, delegate to the old property
- asset.server.url.prefix
- When serving custom Pages or StructuredContent fields, the URL prefix defined above will be replaced with the string below.
- This is useful for sites that have a separate image domain or use a CDN to render images.
- This works well with CMSs that own the image part of your domain CNAME
- asset.server.url.prefix.internal
- The following property defines the prefix used internally by the CMS system to identify requests that it needs to process
- asset.server.url.prefix.secure
- Prefix used by CMS for secure channel.
- Useful when your regular prefix begins with "http:"
- asset.use.filesystem.storage
- Controls whether the AssetService stores (and retrieves) the binary asset from the filesystem or database
- automatically.approve.pages
- Cause CMS sandbox items to be automatically approved without workflow
- No longer used
- automatically.approve.structured.content
- No longer used
- disabled.file.extensions
- Specifies a comma-separated blacklist of upload file extensions
- image.artifact.recompress.formats
- Runtime configuration property for image artifact recompress formats
- Default:
png
- page.site.map.generator.row.limit
- Max number of rows queried at a time by the PageSiteMapGenerator
- preserveQueryStringOnRedirect
- When a URL redirect happens via the UrlHandlerFilter, if this property is true, it will append the old query params to the new URL
- should.accept.non.image.asset
- Runtime configuration property for should accept non image asset
- Default:
true
- static.asset.exception.on.invalid.char.in.filename
- in case this property is set to true, error will be presented instead of invalid chars replacement
- Default:
false
- static.asset.invalid.chars.in.filename
- if static asset file name that is uploading contains the following chars they will be replaced(no effect on existing assets)
- Default:
+,*,%
- static.asset.invalid.chars.replacement
- the string that will replace invalid chars from above
- Default:
_
- store.front.webapp.prefix
- Prefix in front of all URLs that hit your storefront from the Admin.
- This is useful when the storefront is located on a different server from the Admin (e.g. http://storefront:8080/)
Common
- SLF4JSupportLoggerAdapter.defaultLevel
- Runtime configuration property for s l f4 j support logger adapter default level
- SupportLogger.adapter.fqcn
- Runtime configuration property for support logger adapter fqcn
- SystemSupportLoggerAdapter.dateTimeFormat
- Runtime configuration property for system support logger adapter date time format
- Default:
HH:mm:ss
- SystemSupportLoggerAdapter.levelInBrackets
- Runtime configuration property for system support logger adapter level in brackets
- Default:
true
- SystemSupportLoggerAdapter.showDateTime
- Runtime configuration property for system support logger adapter show date time
- Default:
true
- SystemSupportLoggerAdapter.showLogName
- Runtime configuration property for system support logger adapter show log name
- Default:
true
- SystemSupportLoggerAdapter.showNonSupportLevels
- Runtime configuration property for system support logger adapter show non support levels
- Default:
false
- SystemSupportLoggerAdapter.showThreadName
- Runtime configuration property for system support logger adapter show thread name
- Default:
false
- ThreadLocalManager.notify.orphans
- Runtime configuration property for thread local manager notify orphans
- admin.baseurl
- Used to determine the base URL of the Admin
- admin.entity.duplication.isactive
- Runtime configuration property for admin entity duplication isactive
- Default:
false
- admin.entity.duplication.suffix.default
- Runtime configuration property for admin entity duplication suffix default
- admin.strict.validate.production.changes
- Determines whether update restrictions are enforced on all workflow enabled entities inside of the Admin.
- It is unlikely that this property would be changed at the property file level; rather, it is more usual to change the value on the BroadleafRequestContext on a case-by-case basis for a given request.
- asset.server.file.classpath.directory
- The system will check for assets in this directory before checking the file system
- This field was primarily added to support needs like the Broadleaf Demo Site where we wish to provide assets as part of the distribution of the software.
- It is blank by default to indicate to the system that it should not to check this directory.
- Note Do not use in production environments
- asset.server.file.system.path
- The base path where file system assets will be stored. Should begin but not end with a "/"
- If not set, the system will use
System.setProperty("java.io.tmpdir") - Deprecated: Should use
asset.server.file.system.pathinstead
- asset.server.max.generated.file.system.directories
- This value will be used to determine the number of directories created to store images and other assets on the filesystem using a set of generated directories based on the MD5 value of the filename.
2supports a distribution of about 10 million files and is suitable for most purposes.3would add support for over 2 billion, but for implementations of this size, distributed file system options should be considered.
- asset.server.url.prefix
- When serving custom Pages or StructuredContent fields, the URL prefix defined above will be replaced with the string below.
- This is useful for sites that have a separate image domain or use a CDN to render images.
- This works well with CMSs that own the image part of your domain CNAME
- asset.server.url.prefix.secure
- Prefix used by CMS for secure channel.
- Useful when your regular prefix begins with "http:"
- auto.correct.sequence.generator.inconsistencies
- Turn on auto correction of corrupt primary key generation configuration
- blCMSStorage.hibernate.cache.use_query_cache
- Runtime configuration property for bl c m s storage hibernate cache use query cache
- blCMSStorage.hibernate.cache.use_second_level_cache
- Runtime configuration property for bl c m s storage hibernate cache use second level cache
- blCMSStorage.hibernate.dialect
- Runtime configuration property for bl c m s storage hibernate dialect
- blCMSStorage.hibernate.hbm2ddl.auto
- Runtime configuration property for bl c m s storage hibernate hbm2ddl auto
- blCMSStorage.hibernate.hbm2ddl.import_files
- Runtime configuration property for bl c m s storage hibernate hbm2ddl import files
- blCMSStorage.hibernate.hbm2ddl.import_files_sql_extractor
- Runtime configuration property for bl c m s storage hibernate hbm2ddl import files sql extractor
- blCMSStorage.hibernate.implicit_naming_strategy
- Configures the execution strategy or mode for blCMSStorage hibernate implicit naming
- blCMSStorage.hibernate.physical_naming_strategy
- Configures the execution strategy or mode for blCMSStorage hibernate physical naming
- blCMSStorage.hibernate.show_sql
- Runtime configuration property for bl c m s storage hibernate show sql
- blPU.hibernate.cache.use_query_cache
- Runtime configuration property for bl p u hibernate cache use query cache
- blPU.hibernate.cache.use_second_level_cache
- Runtime configuration property for bl p u hibernate cache use second level cache
- blPU.hibernate.dialect
- Runtime configuration property for bl p u hibernate dialect
- blPU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl p u hibernate hbm2ddl auto
- blPU.hibernate.hbm2ddl.import_files
- Runtime configuration property for bl p u hibernate hbm2ddl import files
- blPU.hibernate.hbm2ddl.import_files_sql_extractor
- Runtime configuration property for bl p u hibernate hbm2ddl import files sql extractor
- blPU.hibernate.implicit_naming_strategy
- Configures the execution strategy or mode for blPU hibernate implicit naming
- blPU.hibernate.physical_naming_strategy
- Configures the execution strategy or mode for blPU hibernate physical naming
- blPU.hibernate.show_sql
- Runtime configuration property for bl p u hibernate show sql
- blSecurePU.hibernate.cache.use_query_cache
- Runtime configuration property for bl secure p u hibernate cache use query cache
- blSecurePU.hibernate.cache.use_second_level_cache
- Runtime configuration property for bl secure p u hibernate cache use second level cache
- blSecurePU.hibernate.dialect
- Runtime configuration property for bl secure p u hibernate dialect
- blSecurePU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl secure p u hibernate hbm2ddl auto
- blSecurePU.hibernate.hbm2ddl.import_files
- Runtime configuration property for bl secure p u hibernate hbm2ddl import files
- blSecurePU.hibernate.hbm2ddl.import_files_sql_extractor
- Runtime configuration property for bl secure p u hibernate hbm2ddl import files sql extractor
- blSecurePU.hibernate.implicit_naming_strategy
- Configures the execution strategy or mode for blSecurePU hibernate implicit naming
- blSecurePU.hibernate.physical_naming_strategy
- Configures the execution strategy or mode for blSecurePU hibernate physical naming
- blSecurePU.hibernate.show_sql
- Runtime configuration property for bl secure p u hibernate show sql
- bundle.charset
- Runtime configuration property for bundle charset
- bundle.enabled
- If true, resources inside of a
blc:bundletag within a template will be bundled into a single file. - Note that when
bundle.enabledis set to true that changes to file-system based resources will not be picked up until the server is restarted.- For this reason,
bundle.enabledis normally set to false in development (typically indevelopment.properties).
- For this reason,
- If true, resources inside of a
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- cache.stat.log.resolution
- Number of milliseconds between cache hit statistics log output
- Only occurs if log level for StatisticsServiceImpl is set to
INFOor higher
- catalog.copier.optimization.enabled
- Determines whether catalog copier optimization is enabled
- Default:
false
- cookies.use.secure
- Runtime configuration property for cookies use secure
- Default:
false
- currency.default
- Runtime configuration property for currency default
- default.schema.sequence.generator
- Qualify unqualified table name with this schema name when performing sequence generator inconsistency detection
- demo.import.sql.enabled
- Determines whether demo import sql is enabled
- Default:
true
- detect.sequence.generator.inconsistencies
- Turn on BLC detection support for corrupt primary key generation configuration
- disable.all.process.detail.logging
- Whether ProcessDetailLogger will attempt to log anything
- The ProcessDetailLogger functionality can be completely turned off here
- enterprise.use.production.sandbox.mode
- Determines whether production sandbox mode is used
- Also declared in BroadleafCommercePrivate Common module
- exception.handler.enabled
- Determines whether exception handler is enabled
- Default:
false
- exploitProtection.xsrfEnabled
- Used by ExploitProtectionServiceImpl to determine whether to check the CSRF token for the web session
- True by default
- exploitProtection.xssEnabled
- Used by ExploitProtectionServiceImpl to determine whether to clean input strings
- Also defined in BroadleafCommercePrivate Common module
- file.service.temp.file.base.directory
- Determines the directory where temporary files reside if you want to use something besides
java.io.tmpfor your temp directory
- Determines the directory where temporary files reside if you want to use something besides
- filter.compression.allow.static.file.cache
- Whether or not to cache static file compression results. The default value is false (don't use the cache).
- filter.compression.blacklist.uri.regex
- A comma delimited list of URI matching regular expressions for requests that should be ignored for any compression. The default value is '.\.jpg,.\.jpeg,.\.gif,.\.png'.
- filter.compression.cache.default.environment
- It is likely resource versioning will be disabled in the default, development environment. This setting will tell the system to not cache static resources in the local filesystem in the default environment to avoid static asset caching issues where a versioned name change is not involved.
- filter.compression.enabled
- Provides either dynamic, or cached static compression of response data. The 'filter.compression.enabled' property must be set to true to enable this filter. Cached static file compression generally refers to compression requests for static artifacts, such as css, js and similar files. To allow static file caching, the 'filter.compression.allow.static.file.cache' property must be true and the file must be recognized in the list of extension to mimetype mapping represented in the 'filter.compression.extension.mime.mappings' property. Should a static file fail to be found in the mapping list, the system will fallback to dynamic compression for the artifact. The 'filter.compression.extension.mime.mappings' property is a comma delimited list of request URI matching regular expressions to mime types. For example, the following property setting would limit static compressed file caching to only files that end in the '.css' and '.js' extensions: {@code filter.compression.extension.mime.mappings=.\.css:text/css,.\.js}. See the javadoc for {@link #compressionExtensionToMimeMappings} for the default values. 'filter.compression.allow.static.file.cache' is false by default, which makes the most sense when a CDN is in place, since the CDN will be the primary source of asset caching. The directory in which cached static files should be stored is denoted via the 'filter.compression.file.temp.directory' property. By default, this property is set to 'none', which signifies that the standard java temp directory should be used. If using static file compression caching, make sure you have enough free hard disk space to accommodate compressed versions of all the interesting static files. Dynamic compression generally refers to compression requests for dynamic web pages, such a standard HTML page requests, or JSON responses for RESTful endpoints. There is no caching of the compressed response and the response is compressed on every request. There is an additional sendfile optimization for static/cached files. For larger files, the OS can use the 'sendfile' optimization to increase network throughput and reduce CPU overhead. By default, this is enabled for files over 49152 bytes. This threshold can be changed via the 'filter.compression.sendfile.size' property. While the sendfile feature is enabled by default, it can be turned off altogether via the 'filter.compression.use.sendfile' property (set to false). Certain request URI can be blacklisted for compression altogether via the 'filter.compression.blacklist.uri.regex' property. This is a comma delimited list of regular expression that, when matched against a request URI, will cause that URI to not be compressed. @author Jeff Fischer
- filter.compression.extension.mime.mappings
- Comma delimited URI matching regular expression to mime type mapping. The default value is {@code .\.svg:image/svg+xml,.\.png:image/png,.\.xml:text/xml,.\.css:text/css,.\.js:application/javascript,.\.otf:application/x-font-opentype,.\.json:application/json,.\.css.map:application/json,.*\.js.map:application/json}
- filter.compression.file.temp.directory
- Specify a filesystem directory in which to store compressed static files. 'none' by default, which means use the java temp directory.
- filter.compression.sendfile.size
- The minimum size of a cached,compressed file (in bytes) for which to use the OS sendfile feature. 49152 bytes by default.
- filter.compression.use.default.environment
- Whether or not compression is enabled in the default Spring environment. Used to turn off during development. True by default (compression enabled).
- filter.compression.use.sendfile
- Whether or not to ever use the OS sendfile feature. True by default (use the feature).
- filter.html.minification.enabled
- Enable html minification. All unnecessary white space will be removed from html, inline CSS and inline JS. This should serve to provide some reduction in byte size of the response. This is a suggested pagespeed optimization from Google. The drawbacks of this filter include: a slight expense in processing the response payload, and the page response is kept entirely in memory to facilitate processing before responding to the caller (usually the http response can be (is) pushed back incrementally to avoid keeping the entire page contents in memory). The filter is disabled by default. Activate by including this property declaration in your Spring environment property file(s): {@code filter.html.minification.enabled=true}. @author Jeff Fischer
- global.admin.prefix
- Use to make the Global Admin accessible by a domain prefix (subdomain style)
- e.g.,
global.mysite.com
- e.g.,
- Use to make the Global Admin accessible by a domain prefix (subdomain style)
- global.admin.url
- Use to make the Global Admin accessible by a subdirectory
- e.g.,
www.mysite.com/global
- e.g.,
- Use to make the Global Admin accessible by a subdirectory
- googleAnalytics.testLocal
- Determines whether to force the domain to 127.0.0.1
- Useful to determine if the Google Analytics tag is sending a request to Google
- hibernate.cache.region.factory_class
- Runtime configuration property for hibernate cache region factory class
- Default:
#{null
- hibernate.javax.cache.provider
- Runtime configuration property for hibernate javax cache provider
- Default:
#{null
- hibernate.javax.cache.uri
- URL endpoint for hibernate javax cache
- Default:
#{null
- hibernate.javax.cache.uri.relative
- Runtime configuration property for hibernate javax cache uri relative
- Default:
true
- i18n.translation.enabled
- Whether to enable I18n translations
- ignore.no.process.detail.logger.configuration
- Whether to display a support message when the ProcessDetailLogger is used but not configured by a backing logging system
- import.sql.enabled
- Determines whether import sql is enabled
- Default:
true
- java.home
- Runtime configuration property for java home
- jcache.create.cache.forceJavaConfig
- Runtime configuration property for jcache create cache force java config
- Default:
false
- jcache.create.cache.ifMissing
- Runtime configuration property for jcache create cache if missing
- Default:
true
- jcache.disable.cache
- Runtime configuration property for jcache disable cache
- Default:
false
- listGrid.forceShowIdColumns
- Used in the admin to show ID columns when displaying list grids.
- log.transaction.lifecycle.abbreviate.statements
- Runtime configuration property for log transaction lifecycle abbreviate statements
- Default:
true
- log.transaction.lifecycle.abbreviate.statements.length
- Runtime configuration property for log transaction lifecycle abbreviate statements length
- Default:
200
- log.transaction.lifecycle.decompress.statement
- Runtime configuration property for log transaction lifecycle decompress statement
- Default:
false
- log.transaction.lifecycle.info.count.max
- Runtime configuration property for log transaction lifecycle info count max
- Default:
5000
- log.transaction.lifecycle.logging.polling.resolution.millis
- Configures the duration or polling interval for log transaction lifecycle logging polling resolution
- Default:
30000
- log.transaction.lifecycle.logging.threshold.millis
- Configures the duration or polling interval for log transaction lifecycle logging threshold
- Default:
600000
- log.transaction.lifecycle.query.list.max.size
- Runtime configuration property for log transaction lifecycle query list max size
- Default:
100
- log.transaction.lifecycle.reporting.lag.threshold.millis
- Configures the duration or polling interval for log transaction lifecycle reporting lag threshold
- Default:
300000
- log.transaction.lifecycle.stuck.threshold.millis
- Configures the duration or polling interval for log transaction lifecycle stuck threshold
- Default:
300000
- log.transaction.lifecycle.use.compression
- Runtime configuration property for log transaction lifecycle use compression
- Default:
true
- messages.cacheSeconds
- Number of seconds to cache loaded properties files
- Used by BroadleafMergeResourceBundleMessageSource
- Leave set to
-1as this ensures that codes are always obtained from a merged property list.
- messages.useCodeAsDefaultMessage
- Fallback to use the default message in the Admin.
- This will ensure that client-specific friendly names are not required to appear in an internationalized properties file
- minify.allowSingleMinification
- Runtime configuration property for minify allow single minification
- minify.closure.compiler.languageIn
- Sets the language spec to which input sources should conform.
- Options: ECMASCRIPT3, ECMASCRIPT5, ECMASCRIPT5_STRICT, ECMASCRIPT6_TYPED (experimental), ECMASCRIPT_2015, ECMASCRIPT_2016, ECMASCRIPT_2017, ECMASCRIPT_NEXT
- ECMASCRIPT5 by default
- minify.closure.compiler.languageOut
- Sets the language spec to which output should conform.
- Options: ECMASCRIPT3, ECMASCRIPT5, ECMASCRIPT5_STRICT, ECMASCRIPT6_TYPED (experimental), ECMASCRIPT_2015, ECMASCRIPT_2016, ECMASCRIPT_2017, ECMASCRIPT_NEXT, NO_TRANSPILE
- NO_TRANSPILE by default
- minify.closure.compiler.strictMode
- Runtime configuration property for minify closure compiler strict mode
- Default:
false
- minify.closure.compiler.warningLevel
- Specifies the warning level to use.
- Options: QUIET, DEFAULT, VERBOSE
- QUIET by default
- minify.disableOptimizations
- Runtime configuration property for minify disable optimizations
- minify.enabled
- Whether to minify JS and CSS resources inside of a
blc:bundletag with a template
- Whether to minify JS and CSS resources inside of a
- minify.linebreak
- Runtime configuration property for minify linebreak
- minify.munge
- Runtime configuration property for minify munge
- minify.preserveAllSemiColons
- Runtime configuration property for minify preserve all semi colons
- minify.verbose
- Runtime configuration property for minify verbose
- mt.loaded.flag
- Used by the system to determine if the multitenant module is loaded
- org.broadleafcommerce.extensibility.context.merge.handlers.merge.properties
- Runtime configuration property for org broadleafcommerce extensibility context merge handlers merge properties
- precached.sparse.override.translation.template.enabled
- Whether or not {@link #getLocaleBasedTemplateValue(String, String, TranslatedEntity, String, String, String, String, String)} will be utilized from this strategy. If false, the fallback {@link ThresholdCacheTranslationOverrideStrategy#getLocaleBasedTemplateValue(String, String, TranslatedEntity, String, String, String, String, String)} will be used instead. If the 'template' repository (MT concept) is large, this value should be left true. However, if the 'template' repository is relatively small, you may want to consider setting this to false in order to leverage the possibility of complete caching in the default strategy. See {@link TranslationSupport#getThresholdForFullCache()} for more info on this option. The default value is true. Set the 'precached.sparse.override.translation.template.enabled' property to change the value. This value is meaningless if the current standard site is found to contain active isolated values for translations. Review the documentation in com.broadleafcommerce.tenant.service.cache.SparseOverridePreCacheServiceImpl for more information.
- precached.sparse.override.translation.template.search.restrict.association
- Whether or not to restrict the template search to the catalog/site of an associated item. For example, restrict the translation of name for a Sku to the catalog of the Sku. Or, restrict the translation of StructuredContent property to the site discriminator of the StructuredContent. This value is false by default. Change the 'precached.sparse.override.translation.template.search.restrict.association' to true to enable.
- query.cacheable
- JPA second level cache to use for queries
- Not Used
- remove.order.customer.entity.l2cache
- Runtime configuration property for remove order customer entity l2cache
- Default:
false
- resource.caching.enabled
- Determines whether BroadleafCachingResourceResolver should cache resources
- resource.transformer.caching.enabled
- Determines whether BroadleafCachingResourceTransformer should cache resource transformations
- resource.versioning.enabled
- Used by BroadleafVersionResourceResolver to determine if resources should be versioned.
- When the staticResourceBrowserCacheSeconds is set to a non-zero number, resources should be versioned to prevent client browsers from caching a stale JS or CSS file.
- runtime.environment
- Runtime configuration property for runtime environment
- site.baseurl
- Used to determine the base URL of the Site
- site.domain.resolver.strip.subdomains
- Comma separated list of subdomains
- Used by the Domain Site Identifier Type to remove expected subdomains
- For example, stripping 'www' from www.domain.com to resolve to domain.com
- site.strict.validate.production.changes
- Determines whether update restrictions are enforced on workflow enabled entities outside of the admin.
- If enabled, updates to entity properties (e.g. sku.retailPrice) will not be allowed unless performed in the Admin.
- This would serve to guarantee change auditing, but could cause pain for alternative update pathways, such as REST services.
- False by default.
- sitemap.cache.seconds
- Amount of time to rely on the local cache for a sitemap file in seconds
- sitemap.createIfNotFound
- Determines whether the system will create a sitemap if none exists when a sitemap is requested
- Should be set to false for large catalogs, which should generate the sitemap with an offline job.
- sitemap.createIfTimeoutExpired
- Runtime configuration property for sitemap create if timeout expired
- Default:
false
- sitemap.gzip.files
- Determines whether sitemap files are gzipped during generation
- stale.state.protection.enabled
- Determines whether stale state protection is enabled
- Default:
false
- stateless.request.path
- If the request starts with this path prefix, it will be used by the StatelessSessionFilter to prevent out of box filters from creating sessions
- staticResourceBrowserCacheSeconds
- Number of seconds to add to static file cache headers.
- This property is used in the applicationContext to set the cache-seconds property for HTTPResourceHandlers
- See
org.springframework.web.servlet.resource.ResourceHttpRequestHandler
- streaming.transaction.item.page.size
- The amount of sandbox items to process in a single transaction.
- This is a useful setting for large sandboxes, as it would not be performant to process a large amount of sandbox items in a single transaction
- e.g., updating the price on a 100,000 products in production
- By processing sandbox items in smaller chunks, the transactions are kept small and there is less chance of interfering with customer experience.
- Note this setting is not the same as jdbc batch size.
- Also declared in BroadleafCommercePrivate Common module
- streaming.transaction.lock.retry.max
- Max number of times the system will retry a persistence operation for jobs or events when it fails to obtain a transactional lock
- system.property.cache.timeout
- Cache timeout in seconds for system properties
- By default, set to
-1, which means the cache is eternal
- thymeleaf.threadLocalCleanup.enabled
- Unused
- thymeleaf.useLayoutDialect
- Whether to use Thymeleaf Layout Dialect when resolving Thymeleaf views
- transaction.lifecycle.events.enabled
- Determines whether transaction lifecycle events is enabled
- Default:
false
- translation.thresholdForFullCache
- The default is 1000. Use the 'translation.thresholdForFullCache' to change the value.
- url.fragment.separator
- Determine the character to replace whitespaces with for Entity forms when automatically generating URLs based on the entity's name, such as for Categories
- e.g., if the Category's name is "Hot Sauces", then its URL is automatically generated to be "hot-sauces"
- Determine the character to replace whitespaces with for Entity forms when automatically generating URLs based on the entity's name, such as for Categories
- validator.custom.enabled
- Determines whether validator custom is enabled
- workflow.auto.rollback.on.error
- Make any RollbackHandler instances registered with the ActivityStateManager rollback automatically on a workflow error
Framework
- auto.flush.on.query.during.add.to.cart
- Advanced setting. Should Hibernate auto flush before queries during an add-to-cart workflow. This should generally be able to be left false. This is a performance measure and add-to-cart operations will be more efficient when this is false.
- Default:
false
- auto.flush.on.query.during.cart.pricing.save
- Advanced setting. Should Hibernate auto flush before queries during an order save pricing flow. This should generally be able to be left false. This is a performance measure and save operations will be more efficient when this is false.
- Default:
false
- auto.flush.on.query.during.remove.from.cart
- Advanced setting. Should Hibernate auto flush before queries during an remove-from-cart workflow. This should generally be able to be left false. This is a performance measure and remove-from-cart operations will be more efficient when this is false.
- Default:
false
- auto.flush.on.query.during.update.cart
- Advanced setting. Should Hibernate auto flush before queries during an update-cart workflow. This should generally be able to be left false. This is a performance measure and update-cart operations will be more efficient when this is false.
- Default:
false
- automatically.add.complete.items
- If true, an item with child items will skip the configuration step if there is not required configuration.
- Default:
true
- automatically.merge.like.items
- If true and if the same item is added to the cart, the quantity will automatically be updated.
- blc.site.enable.xssWrapper
- Runtime configuration property for blc site enable xss wrapper
- Default:
false
- blc.site.search.url.wrapper
- Runtime configuration property for blc site search url wrapper
- Default:
false
- blc.site.xssWrapper.whitelist.params
- Runtime configuration property for blc site xss wrapper whitelist params
- Default:
payment_method_nonce,password,passwordConfirm,currentPassword,newPassword,newPasswordConfirm
- blc.site.xssWrapper.whitelist.uri
- URL endpoint for blc site xssWrapper whitelist
- Default:
/crossappauth,/crossappsessioninvalidate
- catalogUriService.appendIdToRelativeURI
- If true, relative URLs will have an id appended
- e.g. productId=123
- If true, relative URLs will have an id appended
- catalogUriService.categoryIdParam
- Runtime configuration property for catalog uri service category id param
- Default:
categoryId
- catalogUriService.productIdParam
- Runtime configuration property for catalog uri service product id param
- Default:
productId
- catalogUriService.useUrlKey
- If true, the catalogUriService will call
product.getUrlKeyorcategory.getUrlKeyto get the last fragment of the URL instead of parsing the results of Product or CategorygetURL()method
- If true, the catalogUriService will call
- category.site.map.generator.row.limit
- Max number of rows queried at a time by the CategorySiteMapGenerator
- clearCartOnLocaleSwitch
- Indicates the cart should be cleared if the locale changes
- custom.strip.xss
- Runtime configuration property for custom strip xss
- Default:
false
- default.payment.gateway.checkout.useGatewayBillingAddress
- If true, the DefaultPaymentGatewayCheckoutService will use the billing address sent back from the gateway.
- disableThymeleafTemplateCaching
- If true, the BroadleafCacheProcessor will not cache templates
- enable.purge.order.history
- Save protection from unexpected purge order history
- Default:
false
- enable.sku.minOrderQuantity.field
- Runtime configuration property for enable sku min order quantity field
- Default:
false
- exploitProtection.xssEnabled
- Used by ExploitProtectionServiceImpl to determine whether to clean input strings
- Also defined in BroadleafCommercePrivate Common module
- gateway.config.global.enablePendingPayments
- Runtime configuration property for gateway config global enable pending payments
- gateway.config.global.expDateFormat
- Runtime configuration property for gateway config global exp date format
- geolocation.api
- Runtime configuration property for geolocation api
- i18n.translation.enabled
- Whether to enable I18n translations
- item.offer.percent.rounding.mode
- Configures the execution strategy or mode for item offer percent rounding
- item.offer.percent.rounding.scale
- Runtime configuration property for item offer percent rounding scale
- Default:
-1
- merge.orders.after.registration
- Runtime configuration property for merge orders after registration
- Default:
false
- order.lock.database.session.affinity
- Runtime configuration property for order lock database session affinity
- Default:
true
- order.lock.database.time.to.live
- Runtime configuration property for order lock database time to live
- Default:
-1L
- order.outOfSyncCache.refresh
- Runtime configuration property for order out of sync cache refresh
- Default:
false
- org.broadleafcommerce.core.util.lock.DistributedLock.canParticipate
- Global property indicating that, generally, this environment can obtain a distributed lock such as org.broadleafcommerce.core.util.lock.ReentrantDistributedZookeeperLock
- Default:
true
- password.site.encoder
- Determine the implementation of
org.springframework.security.crypto.password.PasswordEncoderto use on the site for encoding passwords
- Determine the implementation of
- pricing.retry.count.for.lock.failure
- Number of times to retry acquiring lock when saving pricing changes to an Order
- pricing.retry.wait.interval.for.lock.failure
- Interval in milliseconds between attempts to acquire lock to save pricing changes to an Order
- product.site.map.generator.row.limit
- Max number of rows queried at a time by the ProductSiteMapGenerator
- promotion.fulfillmentgroup.qualifyAcrossAllOrderItems
- Runtime configuration property for promotion fulfillmentgroup qualify across all order items
- Default:
false
- query.dateResolution.category
- Runtime configuration property for query date resolution category
- Default:
10000
- query.dateResolution.offer
- Runtime configuration property for query date resolution offer
- Default:
10000
- query.dateResolution.product
- Runtime configuration property for query date resolution product
- Default:
10000
- query.dateResolution.searchredirect
- Runtime configuration property for query date resolution searchredirect
- Default:
10000
- query.dateResolution.sku
- Runtime configuration property for query date resolution sku
- Default:
10000
- searchRedirect.is.null.activeStartDate.active
- Runtime configuration property for search redirect is null active start date active
- Default:
false
- seo.category.pagination.param
- Runtime configuration property for seo category pagination param
- Default:
page
- singleFulfillmentGroup.fgItem.sync.qty
- There are edge cases where the OrderItem and FulfillmentGroupItem quantities can fall out of sync.
- If this happens, by setting the
singleFulfillmentGroup.fgItem.syncflag to true, the system will correct the fulfillmentGroup quantity from the OrderItem and save/reprice the Order to synchronize them.
- If this happens, by setting the
- This flag is only valid for single FulfillmentGroups.
- There are edge cases where the OrderItem and FulfillmentGroupItem quantities can fall out of sync.
- sku.media.display-order.enabled
- Determines whether sku media display order is enabled
- Default:
false
- sku.site.map.generator.row.limit
- Max number of rows queried at a time by the SkuSiteMapGenerator
- solr.boost.category.results
- Runtime configuration property for solr boost category results
- Default:
false
- solr.catalog.useLegacySolrIndexer
- If true, use standard legacy flow for reindex, if false, use multithread solr reindex, defauls is true
- solr.cloud.configName
- When creating a collection in SolrCloud, you can specify the configuration by name as it is stored in Zookeeper
- solr.cloud.defaultNumReplicas
- Runtime configuration property for solr cloud default num replicas
- solr.cloud.defaultNumShards
- This is the default number of SolrCloud shards that will be created if a collection has to be created by the application
- This number needs to be less than or equal to the number of Solr nodes in the cluster.
- solr.global.facets.category.search
- Runtime configuration property for solr global facets category search
- Default:
false
- solr.index.commit
- Set this to false to disable API-based commits.
- If set to false, you must ensure that autoCommit is enabled in
solrconfig.xml(on the Solr server).- You should also consider configuring autoSoftCommit if setting this to false.
- solr.index.errorOnConcurrentReIndex
- This indicates that the SolrIndexService should throw an exception if more than one thread attempt concurrent reindexing
- If false, the service will log it and return gracefully.
- solr.index.product.pageSize
- Page (or batch) size for Solr reindexing
- solr.index.product.reindexCommitInterval
- Runtime configuration property for solr index product reindex commit interval
- Default:
30000
- solr.index.product.workerThreads
- Runtime configuration property for solr index product worker threads
- Default:
10
- solr.index.site.alias.name
- Runtime configuration property for solr index site alias name
- Default:
site
- solr.index.site.collection.name
- Runtime configuration property for solr index site collection name
- Default:
blcSite
- solr.index.site.collections
- Runtime configuration property for solr index site collections
- Default:
false
- solr.index.softCommit
- This is for making incremental updates to the index.
- It's best to use hard commits for full reindexing in the reindex core.
- Soft commits are best if you are sending small, incremental updates to the primary index.
- If this is true, you must turn on autoCommit inside
solrconfig.xml. Otherwise, changes will not get written to disk
- This is for making incremental updates to the index.
- solr.index.status.dead.event.purge.seconds
- Configures the duration or polling interval for solr index status dead event purge
- Default:
3600
- solr.index.status.dead.event.ttl.seconds
- Configures the duration or polling interval for solr index status dead event ttl
- Default:
165600
- solr.index.status.error.retry.count
- Runtime configuration property for solr index status error retry count
- Default:
3
- solr.index.use.sku
- This indicates if we should be indexing/browsing by Sku instead of by Product (experimental)
- solr.index.waitFlush
- Indicates if Solr should block until data is flushed to disk.
- Default is true.
- Should set it to false if
solr.index.softCommit=true
- solr.index.waitSearcher
- This indicates if Solr should block until a new searcher is configured.
- Default is true.
- solr.search.method
- Runtime configuration property for solr search method
- Default:
POST
- solr.showDebugQuery
- Runtime configuration property for solr show debug query
- Default:
false
- solr.sortable.field.types
- These are the default sortable field types, if a client has additional field types to sort by, redefine this list with those types included
- stop.checkout.on.single.payment.failure
- Unused
- use.quantity.only.tier.calculation
- Runtime configuration property for use quantity only tier calculation
- Default:
false
- validator.address.fullNameOnly
- Runtime configuration property for validator address full name only
- web.defaultPageSize
- Default SearchCriteria page size for SearchFacet results
- workflow.auto.rollback.on.error
- Make any RollbackHandler instances registered with the ActivityStateManager rollback automatically on a workflow error
Framework Web
- allowCategoryResolutionUsingIdParam
- If true, allows Categories to be retrieved using the ID parameter.
- This approach can be more efficient for large catalogs and more easily support dynamic URL building
- allowProductResolutionUsingIdParam
- If true, allows Products to be retrieved using the ID parameter.
- This approach can be more efficient for large catalogs and more easily support dynamic URL building
- asset.server.url.prefix
- When serving custom Pages or StructuredContent fields, the URL prefix defined above will be replaced with the string below.
- This is useful for sites that have a separate image domain or use a CDN to render images.
- This works well with CMSs that own the image part of your domain CNAME
- asset.server.url.prefix.secure
- Prefix used by CMS for secure channel.
- Useful when your regular prefix begins with "http:"
- automatically.add.complete.items
- If true, an item with child items will skip the configuration step if there is not required configuration.
- Default:
true
- blc.site.search.url.wrapper
- Runtime configuration property for blc site search url wrapper
- Default:
false
- blc.site.xssWrapper.whitelist.params
- Runtime configuration property for blc site xss wrapper whitelist params
- Default:
payment_method_nonce,password,passwordConfirm,currentPassword,newPassword,newPasswordConfirm
- blc.site.xssWrapper.whitelist.uri
- URL endpoint for blc site xssWrapper whitelist
- Default:
/crossappauth,/crossappsessioninvalidate
- breadcrumb.homepageText
- Runtime configuration property for breadcrumb homepage text
- Default:
Home
- breadcrumb.removeAllParamsExceptCategoryId
- Runtime configuration property for breadcrumb remove all params except category id
- Default:
true
- clearCartOnLocaleSwitch
- Indicates the cart should be cleared if the locale changes
- cookie.content.targeting.enabled
- Determines whether cookie content targeting is enabled
- currency.locale.change
- Runtime configuration property for currency locale change
- Default:
{
- custom.strip.xss
- Runtime configuration property for custom strip xss
- Default:
false
- enable.current.password.check
- Runtime configuration property for enable current password check
- Default:
true
- geolocation.api.enabled
- Determines whether geolocation api is enabled
- Default:
false
- googleAnalytics.accountId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.affiliation
- Runtime configuration property for google analytics affiliation
- googleAnalytics.clientId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.clientSecret
- Left blank to be used as placeholder for client overrides
- googleAnalytics.enableDisplayAdvertising
- Runtime configuration property for google analytics enable display advertising
- Default:
false
- googleAnalytics.enableLinkAttribution
- Runtime configuration property for google analytics enable link attribution
- Default:
true
- googleAnalytics.masterWebPropertyId
- See
googleAnalytics.webPropertyId - Used for multi-site installations only
- See
- googleAnalytics.profileId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.testLocal
- Determines whether to force the domain to 127.0.0.1
- Useful to determine if the Google Analytics tag is sending a request to Google
- googleAnalytics.webPropertyId
- Can be used in conjunction with the
masterWebPropertyIdto provide a more site-specific tracker that can be overridden via database System Properties.- In a single-site scenario you would typically only modify 1 or the other.
- If both are set them multiple trackers appear on the page. This might also be suitable if you have 2 analytics accounts that you want to capture traffic for.
- Can be used in conjunction with the
- googleAnalytics4.affiliation
- Runtime configuration property for google analytics4 affiliation
- googleAnalytics4.enableDisplayAdvertising
- Runtime configuration property for google analytics4 enable display advertising
- Default:
false
- googleAnalytics4.enableLinkAttribution
- Runtime configuration property for google analytics4 enable link attribution
- Default:
true
- googleAnalytics4.masterWebPropertyId
- Global value, intentionally only retrieved as a file property NOT via the system properties service
- googleAnalytics4.tagIdForProperty
- Google analytics 4 tag id for gtag
- googleAnalytics4.testLocal
- This will force the domain to 127.0.0.1 which is useful to determine if the Google Analytics tag is sending a request to Google
- Default:
false
- googleAnalytics4.webPropertyId
- Runtime configuration property for google analytics4 web property id
- googleTagManager.accountId
- Runtime configuration property for google tag manager account id
- order.lock.databaseLockAcquisitionNumRetries
- Number of attempts to acquire lock on Order
- order.lock.databaseLockPollingIntervalMs
- Time to sleep in milliseconds between attempts to acquire lock on Order
- order.lock.errorInsteadOfQueue
- Determines whether to queue the Order transaction or throw exception after failure to acquire lock on the Order
- password.valid.regex
- Runtime configuration property for password valid regex
- Default:
DEFAULT_VALID_PASSWORD_REGEX
- request.uri.encoding
- Runtime configuration property for request uri encoding
- saved.customer.payments.enabled
- Determines whether saved customer payments is enabled
- Default:
true
- seo.category.description.pattern
- Runtime configuration property for seo category description pattern
- seo.category.title.pattern
- Runtime configuration property for seo category title pattern
- seo.product.description.pattern
- Runtime configuration property for seo product description pattern
- seo.product.pagination.enabled
- Determines whether seo product pagination is enabled
- Default:
false
- seo.product.pagination.param
- Runtime configuration property for seo product pagination param
- seo.product.title.pattern
- Runtime configuration property for seo product title pattern
- site.baseurl.secure
- Specifies whether to use a secure SSL connection for the site
- site.customerService.number
- Runtime configuration property for site customer service number
- site.emailAddress
- Runtime configuration property for site email address
- site.logo
- Runtime configuration property for site logo
- site.name
- Runtime configuration property for site name
- site.search
- Runtime configuration property for site search
- site.social.accounts
- Runtime configuration property for site social accounts
- structured.data.context
- Runtime configuration property for structured data context
- Default:
DEFAULT_STRUCTURED_CONTENT_CONTEXT
- use.email.for.site.login
- Account identifier or username for use email for site
- Default:
true
- validate.customer.owned.data
- Runtime configuration property for validate customer owned data
- Default:
true
- web.defaultPageSize
- Default SearchCriteria page size for SearchFacet results
- web.maxPageSize
- Max SearchCriteria page size for SearchFacet results
Open Admin Platform
- admin.available.timezone.codes
- List of available time zones that can be selected in the Admin
- Default:
US/Eastern,US/Central,US/Mountain,US/Pacific,US/Alaska,US/Hawaii
- admin.category.treeViewEnabled
- Use Category tree view by default
- Also declared in BroadleafCommercePrivate Open Admin module
- admin.default.max.results
- Max number of entities to fetch in Admin
- admin.enum.minCountForDropDown
- Minimum number of Enum values required before displaying them in a drop-down rather than a list with radio buttons
- admin.form.validation.errors.hideTopLevelFieldErrors
- Prevent error messages from showing up on the top of the forms in the Admin
- Default:
false
- admin.password.regex.validation
- Regular expression for admin user password should be validated against
- admin.search.string.onlyStartsWith
- Setting this property to true will force Admin String searches to only match if the value starts with the search string
- admin.user.requireUniqueEmailAddress
- Determines whether Admin Users have to have unique email addresses
- adminResetPassword.emailTemplate
- Template for emails sent to Admin Users to reset their passwords
- adminResetPassword.fromAddress
- From (sender) email address for emails sent to Admin Users to reset their passwords
- adminResetPassword.subject
- Subject line of emails sent to Admin Users to reset their passwords
- adminUserNameEmail.emailTemplate
- Template for emails sent to Admin Users who forget their usernames
- adminUserNameEmail.fromAddress
- From (sender) email address for emails sent to Admin Users who forget their usernames
- adminUserNameEmail.subject
- Subject line of emails sent to Admin Users who forget their usernames
- cache.entity.dao.metadata.ttl
- Time to Live (ttl) for Entity Field Metadata cache
- Used by SkuCustomPersistenceHandler and DynamicEntityDao
-1means cache eternally
- escape.html.main.link
- Runtime configuration property for escape html main link
- Default:
false
- exception.enableStacktrace
- Runtime configuration property for exception enable stacktrace
- Default:
false
- exception.showDebugMessage
- Determines whether AdminMappingExceptionResolver will display debug message when an Exception is thrown while working in the Admin
- exploitProtection.xssEnabled
- Used by ExploitProtectionServiceImpl to determine whether to clean input strings
- Also defined in BroadleafCommercePrivate Common module
- ignore.entities.for.cleaning.list
- Comma separated list of full name of classes that should be ignored by "clean" procedure during add and update "clean" procedure is using antisamy to check/clean html in DynamicEntityRemoteService this could cause unwanted validation errors. Like during import for something that is not client-facing(shown on site) and invalid/incomplete html can be accepted
- listGrid.forceShowIdColumns
- Used in the admin to show ID columns when displaying list grids.
- password.admin.encoder
- Determine the implementation of
org.springframework.security.crypto.password.PasswordEncoderto use in the Admin for encoding passwords
- Determine the implementation of
- product.sku.generation.max
- Maximum number of skus that will be generated
- Default:
400
- resetPasswordURL
- URL of page to send Admin User to in order to reset their password
- tokenExpiredMinutes
- Length of session after logging into the Admin before being automatically logged out
- uriPropertyValidator.allowTrailingSlash
- Determines whether relative URLs ending with a "/" should pass validation by UriPropertyValidator
- uriPropertyValidator.ignoreFullUrls
- Determines whether full URLs should pass validation by UriPropertyValidator
- uriPropertyValidator.requireLeadingSlash
- Determines whether relative URLs that do not begin with a "/" should pass validation by the UriPropertyValidator
- use.translation.search
- Runtime configuration property for use translation search
- Default:
false
- validate.metadata.cache.sizes
- Whether or not we should use {@link #METADATA_CACHE_SIZES} in the normal runtime of the application
- Default:
false
Profile
- name.valid.regex
- Runtime configuration property for name valid regex
- Default:
DEFAULT_VALID_NAME_REGEX
Profile Web
- filter.sessionFixationProtection.legacy.enabled
- Determines whether filter sessionFixationProtection legacy is enabled
- Default:
true
- validate.password
- Security credential / API key configuration for validate
- Default:
validatePasswordExpression
Admin Module
- admin.offer.isactive.filter
- Runtime configuration property for admin offer isactive filter
- Default:
false
- allow.category.delete.with.children
- Runtime configuration property for allow category delete with children
- Default:
false
- allow.product.parent.category.sorting
- Runtime configuration property for allow product parent category sorting
- Default:
false
- cache.entity.dao.metadata.ttl
- Time to Live (ttl) for Entity Field Metadata cache
- Used by SkuCustomPersistenceHandler and DynamicEntityDao
-1means cache eternally
- product.eager.fetch.associations.admin
- Runtime configuration property for product eager fetch associations admin
- Default:
true
- product.query.limit
- Batch size or maximum number of items processed per batch for product query
- Default:
500
- product.sku.generation.max
- Maximum number of skus that will be generated
- Default:
400
- use.to.one.lookup.sku.product.option.value
- Runtime configuration property for use to one lookup sku product option value
- Default:
false
Cardinal Commerce
- gateway.cardinal.configuration.messageVersion
- Runtime configuration property for gateway cardinal configuration message version
- gateway.cardinal.configuration.timeoutConnect
- Runtime configuration property for gateway cardinal configuration timeout connect
- gateway.cardinal.configuration.timeoutRead
- Runtime configuration property for gateway cardinal configuration timeout read
- gateway.cardinal.configuration.transactionPwd
- Runtime configuration property for gateway cardinal configuration transaction pwd
- gateway.cardinal.configuration.transactionUrl
- Runtime configuration property for gateway cardinal configuration transaction url
- gateway.cardinal.payPalCredit.configuration.merchantId
- Account identifier or username for gateway cardinal payPalCredit configuration
- gateway.cardinal.payPalCredit.configuration.processorId
- Runtime configuration property for gateway cardinal pay pal credit configuration processor id
- gateway.cardinal.payPalExpress.configuration.authCaptureVersion
- if paypal path 2 is set and is paypalexpress, run cmpi_order stuff create cmpi_order centinelRequest, run communicationService process, make sure it is valid, if not, throw exception.
- Default:
2
- gateway.cardinal.payPalExpress.configuration.completeCheckoutOnCallback
- Runtime configuration property for gateway cardinal pay pal express configuration complete checkout on callback
- gateway.cardinal.payPalExpress.configuration.merchantId
- Account identifier or username for gateway cardinal payPalExpress configuration
- gateway.cardinal.payPalExpress.configuration.processorId
- Runtime configuration property for gateway cardinal pay pal express configuration processor id
Cart Rules
- automatically.merge.like.items
- If true and if the same item is added to the cart, the quantity will automatically be updated.
- query.dateResolution.cartrule
- Runtime configuration property for query date resolution cartrule
- Default:
10000
Catalog Access Policy
- query.dateResolution.cap
- Runtime configuration property for query date resolution cap
- Default:
10000
Cloudinary
- asset.server.url.prefix.internal
- The following property defines the prefix used internally by the CMS system to identify requests that it needs to process
- broadleaf.cloudinary.apiKey
- Security credential / API key configuration for broadleaf cloudinary
- broadleaf.cloudinary.apiSecret
- Runtime configuration property for broadleaf cloudinary api secret
- broadleaf.cloudinary.clientCache.ttlSeconds
- Runtime configuration property for broadleaf cloudinary client cache ttl seconds
- broadleaf.cloudinary.cloudName
- Runtime configuration property for broadleaf cloudinary cloud name
- broadleaf.cloudinary.defaultCropType
- Runtime configuration property for broadleaf cloudinary default crop type
- broadleaf.cloudinary.defaultResourceType
- Runtime configuration property for broadleaf cloudinary default resource type
- broadleaf.cloudinary.staticAssetFolderName
- Runtime configuration property for broadleaf cloudinary static asset folder name
- Default:
STATIC_ASSET_FOLDER_PROP_DEFAULT_VAL
Common Enterprise Modules
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- mt.loaded.flag
- Used by the system to determine if the multitenant module is loaded
- relationship.queries.page.size
- Property used for override StreamingTransactionCapableUtil.pageSize in RelationshipOverridesUtil
- Default:
800
- streaming.transaction.item.page.size
- The amount of sandbox items to process in a single transaction.
- This is a useful setting for large sandboxes, as it would not be performant to process a large amount of sandbox items in a single transaction
- e.g., updating the price on a 100,000 products in production
- By processing sandbox items in smaller chunks, the transactions are kept small and there is less chance of interfering with customer experience.
- Note this setting is not the same as jdbc batch size.
- Also declared in BroadleafCommercePrivate Common module
Common Presentation
None
Content Tests
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- googleAnalytics.accountId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.apiScope
- Runtime configuration property for google analytics api scope
- Default:
https://www.googleapis.com/auth/analytics
- googleAnalytics.clientId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.clientSecret
- Left blank to be used as placeholder for client overrides
- googleAnalytics.editableInGaUi
- Runtime configuration property for google analytics editable in ga ui
- Default:
false
- googleAnalytics.embedExperimentInGA
- Runtime configuration property for google analytics embed experiment in g a
- Default:
true
- googleAnalytics.experimentsUri
- Runtime configuration property for google analytics experiments uri
- Default:
https://www.googleapis.com/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments
- googleAnalytics.oauthRedirectUri
- Runtime configuration property for google analytics oauth redirect uri
- Default:
/content-tests/google/process-auth
- googleAnalytics.oauthTokenUri
- Runtime configuration property for google analytics oauth token uri
- Default:
https://accounts.google.com/o/oauth2/token
- googleAnalytics.oauthUri
- Runtime configuration property for google analytics oauth uri
- Default:
https://accounts.google.com/o/oauth2/auth
- googleAnalytics.profileId
- Left blank to be used as placeholder for client overrides
- googleAnalytics.testLocal
- Determines whether to force the domain to 127.0.0.1
- Useful to determine if the Google Analytics tag is sending a request to Google
- googleAnalytics.webPropertyId
- Can be used in conjunction with the
masterWebPropertyIdto provide a more site-specific tracker that can be overridden via database System Properties.- In a single-site scenario you would typically only modify 1 or the other.
- If both are set them multiple trackers appear on the page. This might also be suitable if you have 2 analytics accounts that you want to capture traffic for.
- Can be used in conjunction with the
- query.dateResolution.contenttest
- Runtime configuration property for query date resolution contenttest
- Default:
86400000
Custom Field
- customfield.validation.uniqueFriendlyName
- Runtime configuration property for customfield validation unique friendly name
- Default:
true
Customer Segment
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- customerSegments.export.api.defaultPageSize
- Runtime configuration property for customer segments export api default page size
- customerSegments.export.batchSize
- Batch size or maximum number of items processed per batch for customerSegments export
- Default:
100
- import.offerCode.batch.size
- Runtime configuration property for import offer code batch size
- Default:
100
- preview.customer.segments.rest
- This is a secondary endpoint that should be used when working with previewing segments for a stateless API. This is disabled from getting scanned by default and can be enabled by setting the property "preview.customer.segments.rest" to true. @author Nick Crum ncrum
- purchase.based.customer.segment.batch.size
- Runtime configuration property for purchase based customer segment batch size
- Default:
100
CyberSource Flex Microform Payment
- gateway.cybersource.payment.allowedCardNetworks
- Runtime configuration property for gateway cybersource payment allowed card networks
- gateway.cybersource.payment.authAndCapture
- Runtime configuration property for gateway cybersource payment auth and capture
- Default:
false
- gateway.cybersource.payment.authenticationType
- Runtime configuration property for gateway cybersource payment authentication type
- Default:
http_signature
- gateway.cybersource.payment.enableLog
- Runtime configuration property for gateway cybersource payment enable log
- gateway.cybersource.payment.keyAlias
- Runtime configuration property for gateway cybersource payment key alias
- gateway.cybersource.payment.keyFileName
- Runtime configuration property for gateway cybersource payment key file name
- gateway.cybersource.payment.keyPass
- Runtime configuration property for gateway cybersource payment key pass
- gateway.cybersource.payment.keysDirectory
- Runtime configuration property for gateway cybersource payment keys directory
- gateway.cybersource.payment.logDirectory
- Runtime configuration property for gateway cybersource payment log directory
- gateway.cybersource.payment.logFilename
- Runtime configuration property for gateway cybersource payment log filename
- gateway.cybersource.payment.logMaximumSize
- Runtime configuration property for gateway cybersource payment log maximum size
- gateway.cybersource.payment.merchantId
- Account identifier or username for gateway cybersource payment
- gateway.cybersource.payment.merchantKeyId
- Runtime configuration property for gateway cybersource payment merchant key id
- gateway.cybersource.payment.merchantSecretKey
- Runtime configuration property for gateway cybersource payment merchant secret key
- gateway.cybersource.payment.runEnvironment
- Runtime configuration property for gateway cybersource payment run environment
- Default:
apitest.cybersource.com
- gateway.cybersource.payment.targetOrigins
- Runtime configuration property for gateway cybersource payment target origins
- gateway.cybersource.payment.useMLEGlobally
- Runtime configuration property for gateway cybersource payment use m l e globally
CyberSource Payment
- gateway.cybersource.cardinal.api.identifier
- Runtime configuration property for gateway cybersource cardinal api identifier
- gateway.cybersource.cardinal.api.key
- Security credential / API key configuration for gateway cybersource cardinal api
- gateway.cybersource.cardinal.org.unit.id
- Runtime configuration property for gateway cybersource cardinal org unit id
- gateway.cybersource.rest.keyId
- Runtime configuration property for gateway cybersource rest key id
- gateway.cybersource.rest.merchantId
- Account identifier or username for gateway cybersource rest
- gateway.cybersource.rest.serverUrl
- Runtime configuration property for gateway cybersource rest server url
- gateway.cybersource.rest.sharedSecret
- Runtime configuration property for gateway cybersource rest shared secret
- gateway.cybersource.rest.targetOrigin
- Runtime configuration property for gateway cybersource rest target origin
- gateway.cybersource.secureAcceptance.accessKey
- Runtime configuration property for gateway cybersource secure acceptance access key
- gateway.cybersource.secureAcceptance.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance cancel url
- gateway.cybersource.secureAcceptance.paymentToken.create.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token create cancel url
- gateway.cybersource.secureAcceptance.paymentToken.create.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token create return url
- gateway.cybersource.secureAcceptance.paymentToken.createUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token create url
- gateway.cybersource.secureAcceptance.paymentToken.update.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token update cancel url
- gateway.cybersource.secureAcceptance.paymentToken.update.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token update return url
- gateway.cybersource.secureAcceptance.paymentToken.updateUrl
- Runtime configuration property for gateway cybersource secure acceptance payment token update url
- gateway.cybersource.secureAcceptance.profileId
- Runtime configuration property for gateway cybersource secure acceptance profile id
- gateway.cybersource.secureAcceptance.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance return url
- gateway.cybersource.secureAcceptance.secretKey
- Runtime configuration property for gateway cybersource secure acceptance secret key
- gateway.cybersource.secureAcceptance.serverUrl
- Runtime configuration property for gateway cybersource secure acceptance server url
- gateway.cybersource.secureAcceptance.success.reasonCodes
- Runtime configuration property for gateway cybersource secure acceptance success reason codes
- gateway.cybersource.secureAcceptance.webMobile.accessKey
- Runtime configuration property for gateway cybersource secure acceptance web mobile access key
- gateway.cybersource.secureAcceptance.webMobile.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile cancel url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.create.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token create cancel url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.create.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token create return url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.createUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token create url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.update.cancelUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token update cancel url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.update.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token update return url
- gateway.cybersource.secureAcceptance.webMobile.paymentToken.updateUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile payment token update url
- gateway.cybersource.secureAcceptance.webMobile.profileId
- Runtime configuration property for gateway cybersource secure acceptance web mobile profile id
- gateway.cybersource.secureAcceptance.webMobile.returnUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile return url
- gateway.cybersource.secureAcceptance.webMobile.secretKey
- Runtime configuration property for gateway cybersource secure acceptance web mobile secret key
- gateway.cybersource.secureAcceptance.webMobile.serverUrl
- Runtime configuration property for gateway cybersource secure acceptance web mobile server url
- gateway.cybersource.soap.libVersion
- Runtime configuration property for gateway cybersource soap lib version
- gateway.cybersource.soap.masterpass.createSubscriptionToken
- Runtime configuration property for gateway cybersource soap masterpass create subscription token
- Default:
false
- gateway.cybersource.soap.merchantId
- Account identifier or username for gateway cybersource soap
- gateway.cybersource.soap.p12.keyAlias
- Runtime configuration property for gateway cybersource soap p12 key alias
- gateway.cybersource.soap.p12.keyFile
- Runtime configuration property for gateway cybersource soap p12 key file
- gateway.cybersource.soap.p12.keyPass
- Runtime configuration property for gateway cybersource soap p12 key pass
- gateway.cybersource.soap.serverUrl
- Runtime configuration property for gateway cybersource soap server url
- gateway.cybersource.soap.transactionKey
- Runtime configuration property for gateway cybersource soap transaction key
- gateway.cybersource.useRelativeUrls
- Runtime configuration property for gateway cybersource use relative urls
CyberSource Tax
- cybersource.lib.version
- Runtime configuration property for cybersource lib version
- Default:
1.4/1.5.1
- cybersource.merchant.id
- Runtime configuration property for cybersource merchant id
- Default:
?
- cybersource.server.url
- URL endpoint for cybersource server
- Default:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor
- cybersource.transaction.key
- Security credential / API key configuration for cybersource transaction
- Default:
?
- gateway.cybersource.soap.transactionKey
- Runtime configuration property for gateway cybersource soap transaction key
Database Starters
- demo.database.autoConfigEnabled
- @author Jeff Fischer
Data Feed
- site.baseurl
- Used to determine the base URL of the Site
Enterprise
- addition.status.sku.batch.size
- Runtime configuration property for addition status sku batch size
- Default:
50
- admin.allow.user.promotion.retry
- Runtime configuration property for admin allow user promotion retry
- Default:
true
- admin.category.treeViewEnabled
- Use Category tree view by default
- Also declared in BroadleafCommercePrivate Open Admin module
- admin.default.max.results
- Max number of entities to fetch in Admin
- admin.eager.fetch.promotion.details
- Runtime configuration property for admin eager fetch promotion details
- Default:
false
- admin.fetch.enable.large.result.paging
- Runtime configuration property for admin fetch enable large result paging
- Default:
false
- admin.image.file.extensions
- Specifies valid image extensions for the Admin
- allow.parentcategory.resultset.sandbox.collection.batch.fetch
- Runtime configuration property for allow parentcategory resultset sandbox collection batch fetch
- Default:
false
- allow.productoptionvalue.resultset.sandbox.collection.batch.fetch
- Runtime configuration property for allow productoptionvalue resultset sandbox collection batch fetch
- Default:
false
- allow.resultset.sandbox.collection.batch.fetch
- Runtime configuration property for allow resultset sandbox collection batch fetch
- Default:
false
- allowed.file.extensions
- Specifies a comma-separated whitelist of upload file extensions, if specified disabled.file.extensions are ignored
- asset.server.max.uploadable.image.size
- Runtime configuration property for asset server max uploadable image size
- Default:
2000000
- audit.entity.enabled
- Spring configuration required for both site and admin. @author Jeff Fischer
- Default:
false
- basic.collection.rebalance.decimal.increment
- Runtime configuration property for basic collection rebalance decimal increment
- Default:
0.0001
- blCategories.cache.region.evict.threshold
- See previous
- blOffers.cache.region.evict.threshold
- See previous
- blProducts.cache.region.evict.threshold
- Number of cache evictions belonging to a particular region at which individual evictions are no longer sent and the entire cache region is simply evicted instead
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- category.product.displayOrder.increment.value
- Runtime configuration property for category product display order increment value
- category.sequence.interval.on.add
- Property used to balance display order and gives ability to put categories between other categories
- Default:
10
- category.uri.search.using.url
- Determines whether to allow searching for products using
Product.url
- Determines whether to allow searching for products using
- category.uri.search.using.urlKey
- Determines whether to allow searching for products using
Product.urlKey
- Determines whether to allow searching for products using
- change.details.rewrite.batchsize
- Batch size or maximum number of items processed per batch for change details rewrite
- Default:
100
- crossapp.msvalid
- How long tokens used for authentication between the Admin and site apps are valid, in milliseconds
- crossapp.requireSsl
- Determines whether authentication between the Admin and site apps require SSL
- csr.clearCartOnCheckout
- Determines whether to clear the Cart after checking out in CSR mode
- csr.clearCustomerOnCheckout
- Determines whether to clear the Customer after checking out in CSR mode
- csr.multi.customer.session.enabled
- Determines whether csr multi customer session is enabled
- Default:
false
- csr.multi.customer.session.https
- Runtime configuration property for csr multi customer session https
- Default:
true
- csr.multi.customer.session.secretKey
- Runtime configuration property for csr multi customer session secret key
- Default:
blc-default-key
- disabled.file.extensions
- Specifies a comma-separated blacklist of upload file extensions
- enable.current.password.check
- Runtime configuration property for enable current password check
- Default:
true
- enable.enterprise.status.timing
- Runtime configuration property for enable enterprise status timing
- Default:
false
- enterprise.audit.log.directory
- The directory in the filesystem that contains the workflow logs
- Default:
${java.io.tmpdir:-/tmp
- enterprise.audit.log.file.date.format.pattern
- The pattern used to parse the date from the log file name
- Default:
yyyy-MM-dd
- enterprise.audit.log.line.date.format.pattern
- The pattern used to parse the log line timestamp
- Default:
MM-dd-yyyy HH:mm:ss
- enterprise.audit.log.line.detection.regex
- The regex pattern used to match a line in the log file that contains the timestamp information
- Default:
^\\[DEBUG\\] (\\d\\d-\\d\\d-\\d\\d\\d\\d \\d\\d:\\d\\d:\\d\\d).*
- enterprise.fetch.by.clone.on.batch
- Advanced property. Can help to reduce clone lib query quantity in heavy {@link SandBoxHelper#getOriginalId(Class, Long)} usage scenarios, at the cost of a slightly more complex batch fetch query. A rule of thumb would be to use this property if the multitenant module is in play, and the quantity of standard site production overrides per high-traffic entity is relatively low. If in question, load tests with this property on and off will be more definitive.
- Default:
false
- enterprise.fetch.clone.warn.message.threshold
- Runtime configuration property for enterprise fetch clone warn message threshold
- Default:
0.7
- enterprise.loaded.flag
- Used by the system to determine if the enterprise module is loaded
- enterprise.long.lifecycle.clone.lib.cache.maxsize.hint
- At 500,000 items, this cache will weight in at roughly 300 MB of heap. This is a relatively good tradeoff for site override caching for all sandboxable entities against heap usage. Most sites will not reach this threshold. Note, this is a hint to the system. It is possible for the system to exceed this limit on occasion, but it tries to return to the max size limit whenever possible. This only applies to {@link CloneLibCacheWrapper#MODE_PARTIAL}.
- Default:
500000
- enterprise.long.lifecycle.clone.lib.cache.ttl.millis
- Unless otherwize evicted, site override cache items will remain active in the cache for 24 hours (by default). This only applies to {@link CloneLibCacheWrapper#MODE_PARTIAL}.
- enterprise.sku.generation.context
- Runtime configuration property for enterprise sku generation context
- enterprise.sku.generation.context.permutation.threshold
- Runtime configuration property for enterprise sku generation context permutation threshold
- Default:
100
- enterprise.solr.search.method
- Runtime configuration property for enterprise solr search method
- Default:
METHOD.POST
- enterprise.use.long.lifecycle.clone.lib.cache
- Whether or not the long lifecycle cache should be employed. Without it, the system will fall back to the threadlocal cache behavior.
- Default:
true
- enterprise.use.production.sandbox.mode
- Determines whether production sandbox mode is used
- Also declared in BroadleafCommercePrivate Common module
- enterprise.workflow.logger.enabled
- Whether enterprise workflow logging is enabled
- Recommended for troubleshooting and support
- enterprise.workflow.logger.non.production.enabled
- Whether enterprise workflow logging is enabled for both production and non-production operations
- Recommended for troubleshooting and support
- fetch.all.references.max
- Determines the max number of overrides a request can have to qualify for fetching everything up front
- The request cache for clone lib can be entirely fetched up front in a single query for request contexts with few overrides.
- fetch.all.references.max.multi
- The threshold used to determine if all the WorkflowCloneLibrary entities are loaded into the cache up-front (see {@link CloneLibCacheWrapper#MODE_COMPLETE}).
- Default:
100000
- fetch.all.references.max.single
- The threshold used to determine if all the WorkflowCloneLibrary entities are loaded into the cache up-front. For sites with smaller amounts of sandbox clone references, this is an efficiency measure, as it reduces the number of queries required to determine sandbox references. Larger reference quantities should not be loaded in this fashion, as they would likely overrun available memory. If this threshold is eclipsed, the system will instead default to loading clone references on demand into cache. This measure only comes into play when using the threadlocal cache ({@link #isLongLifecycleCache} is false).
- fetch.collection.batch.pageSize
- Property used to paginate the query used to retrieve collections to prevent parameter size limit from DB dialects.
- Default:
800
- hsqldb.method_class_names
- Runtime configuration property for hsqldb method class names
- Default:
com.broadleafcommerce.autoconfigure.CustomFunctions.fromHex
- multitenant.draftImport.sandboxColor
- Runtime configuration property for multitenant draft import sandbox color
- Default:
#20C0F0
- multitenant.draftImport.sandboxName
- Runtime configuration property for multitenant draft import sandbox name
- Default:
Draft Import
- multitenant.static.asset.unset.behavior
- Determines whether static assets with unset StaticAssetShareableType are always or never shared with other MT sites
- order.lock.errorInsteadOfQueue
- Determines whether to queue the Order transaction or throw exception after failure to acquire lock on the Order
- order.outOfSyncCache.refresh
- Runtime configuration property for order out of sync cache refresh
- Default:
false
- password.admin.encoder
- Determine the implementation of
org.springframework.security.crypto.password.PasswordEncoderto use in the Admin for encoding passwords
- Determine the implementation of
- password.valid.regex
- Runtime configuration property for password valid regex
- Default:
DEFAULT_VALID_PASSWORD_REGEX
- product.uri.search.using.url
- Unused
- product.uri.search.using.urlKey
- Unused
- promotion.early.abort.threshold.seconds
- Configures the duration or polling interval for promotion early abort threshold
- Default:
60
- query.dateResolution.workflowcategory
- Runtime configuration property for query date resolution workflowcategory
- Default:
10000
- sandbox.allow.auto.sync
- Determines whether changes from a parent sandbox are synced to the current sandbox before promotion.
- If set to false, and the current sandbox is not up-to-date, the user will be notified that a sync is required.
- Defaults to true after 5.0.0-GA
- sandbox.auto.promote.prod
- Whether changes are immediately promoted to production (effectively skipping workflow altogether)
- sandbox.include.deleted.items.production.optimization
- Runtime configuration property for sandbox include deleted items production optimization
- Default:
false
- sandbox.lifecycle.strategy.simple.enabled
- Determines whether sandbox lifecycle strategy simple is enabled
- Default:
true
- sandbox.lifecycle.strategy.simple.mysql.tzconversion
- Runtime configuration property for sandbox lifecycle strategy simple mysql tzconversion
- Default:
false
- sandbox.lifecycle.strategy.simple.pageSize
- Batch size or maximum number of items processed per batch for sandbox lifecycle strategy simple
- Default:
1
- sandbox.lifecycle.strategy.simple.sqlserver.tzconversion
- Runtime configuration property for sandbox lifecycle strategy simple sqlserver tzconversion
- Default:
false
- sandbox.orders.admin.visibility
- Determines which kinds of orders to display in the Admin interface.
- Acceptable values are:
PROD- for displaying orders made in a non-sandbox environment (e.g., production)PREVIEW- for displaying orders made only in a sandbox environment
- sandbox.promotion.global.disabled
- Runtime configuration property for sandbox promotion global disabled
- Default:
false
- sandbox.transition.strategy.qualification.batch.size
- Runtime configuration property for sandbox transition strategy qualification batch size
- Default:
800
- seo.autogenerate.openGraphUrl
- Determines whether the SeoTagService should generate an OpenGraph URL for Products, Categories, and Pages if there isn't one already
- seo.autogenerate.twitterCardUrl
- Determines whether the SeoTagService should generate a Twitter Card URL for Products, Categories, and Pages if there isn't one already
- seo.generatedDescriptionField.maxLength
- Determines the max length of HTML meta-descriptions generated by the SeoTagService for Products, Categories, and Pages
- seo.generatedTitleField.maxLength
- Determines the max length of HTML meta-titles generated by the SeoTagService for Products, Categories, and Pages
- should.create.cache.invalidation.event.on.sandbox.items.purge
- Runtime configuration property for should create cache invalidation event on sandbox items purge
- Default:
false
- site.enable.direct.csr.auth
- Optional configuration to include CSR and admin user discovery in the site application. @author Jeff Fischer
- site.sandbox.type.persistence.allow
- When an update is requested on a sandboxable entity from a non-admin context, the occurrence, by default, is allowed to persist. This property controls whether or not the occurrence is allowed to persist. By default, the value is true and the occurrence is allowed to persist.
- site.sandbox.type.persistence.warn.log
- When an update is requested on a sandboxable entity from a non-admin context, the occurrence is logged. This property controls whether or not the log is ever emitted. By default, the value is true and the log is emitted.
- site.sandbox.type.persistence.warn.log.frequency
- When an update is requested on a sandboxable entity from a non-admin context, the occurrence is logged. This property controls how often the log is actually emitted. By default, every 100th occurrence, a log is emitted.
- sku.media.display-order.enabled
- @author Jon Fleschler (jfleschler) @author Chris Kittrell (ckittrell)
- Default:
false
- skumetadata.cache.invalidation.productoption.batchsize
- Property used to determine the batch size of a product's skumetadata cache to invalidate
- Default:
100
- solr.cache.global
- Determines whether Solr uses a global cache that all VMs can update
- If running in stand-alone Solr, you will only want one of the VMs to update the index, as it would be shared between all VMs. In that case, this boolean should be set to false.
- spring.http.multipart.maxRequestSize
- Runtime configuration property for spring http multipart max request size
- Default:
104857600
- spring.session.jdbc.maxInactiveIntervalInSeconds
- Runtime configuration property for spring session jdbc max inactive interval in seconds
- Default:
1800
- spring.session.jdbc.tableName
- Runtime configuration property for spring session jdbc table name
- Default:
BLC_SPRING_SESSION
- strategy.simple.merge.on.promote
- Runtime configuration property for strategy simple merge on promote
- Default:
true
- transfer.cart.anonymous.clear.pii
- Runtime configuration property for transfer cart anonymous clear pii
- Default:
true
- transfer.cart.anonymous.token.expired.minutes
- Runtime configuration property for transfer cart anonymous token expired minutes
- Default:
30
- transfer.cart.anonymous.token.length
- Runtime configuration property for transfer cart anonymous token length
- Default:
20
- use.patch.sandBoxSimplifiedFilter
- Runtime configuration property for use patch sand box simplified filter
- Default:
false
- use.translation.search
- Runtime configuration property for use translation search
- Default:
false
- workflow.promote.transactional.email.send.on.success
- Determines whether an email is sent after a successful promotion event
- workflow.purge.batchSize
- This property determines the batch size for pulling the {@link WorkflowSandBoxItem}s to remove. Defaults to 375. For maximizing performance on datasets that haven't been purged before, this number should be tuned so that it's taking up a single digit percentage of the CPU usage during the purge. Balance maxItemsBeforePersist first since the majority of the time is spent in persisting the deletes and not grabbing the {@link WorkflowSandBoxItem}s
- workflow.purge.keepSiteOverrides
- This property determines if we should keep site overrides if they exist. It is set to true by default
- workflow.purge.maxBatches
- This property determines the maximum number of batches we should process. Defaults to 10 (-1 will make the purge run until it's finished) For a general rule of thumb, it takes 30 - 60 seconds per batch (indicated by batchSize) with the default settings. If batchSize and maxItemsBeforePersist are optimized correctly where GC isn't spiking then it should be fairly safe to set this to -1
- workflow.purge.maxItems
- This property determines the maximum number of elements that can accumulate before forcing a purge. Defaults to 200 For maximizing performance on datasets that haven't been purged before, this is the first number to start tuning. If this number is too high then this purge may consume too much memory between purges resulting in too much time spent garbage collecting.
- workflow.scheduled.deploy.showEmpty
- Determins whether to show empty deployments in the deployment history
- workflow.scheduled.deploy.transactional.email.distro
- Email address to send promotion and deployment event statuses
- workflow.scheduled.deploy.transactional.sms.distro
- Runtime configuration property for workflow scheduled deploy transactional sms distro
- workflowcategory.filter.active.date.in.query
- Runtime configuration property for workflowcategory filter active date in query
- Default:
true
Enterprise Search
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- event.solrindex.worker.type
- Specifies the node where Solr index events will be consumed
- ADMIN by default
- query.dateResolution.boostrule
- Runtime configuration property for query date resolution boostrule
- Default:
10000
- query.dateResolution.typeahead
- Runtime configuration property for query date resolution typeahead
- Default:
10000
- show.search.score.default
- Determines whether to display the search score of Products after doing a search by default
- Note Can be toggled when in Preview on Site mode
- solr.category.type.ahead.limit
- Batch size or maximum number of items processed per batch for solr category type ahead
- Default:
3
- solr.match.type.ahead.limit
- Batch size or maximum number of items processed per batch for solr match type ahead
- Default:
5
- solr.query.edit.distance
- Runtime configuration property for solr query edit distance
- solr.type.ahead.ps
- Runtime configuration property for solr type ahead ps
- Default:
10
- typeahead.categories.limit
- Batch size or maximum number of items processed per batch for typeahead categories
- Default:
5
- typeahead.categories.mincount
- Runtime configuration property for typeahead categories mincount
- Default:
1
- typeahead.contributors.default
- Runtime configuration property for typeahead contributors default
- typeahead.keywords.limit
- Batch size or maximum number of items processed per batch for typeahead keywords
- Default:
8
- typeahead.products.limit
- Batch size or maximum number of items processed per batch for typeahead products
- Default:
3
- typeahead.solr.search.method
- Runtime configuration property for typeahead solr search method
- Default:
METHOD.POST
Export
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
Gift Card and Customer Credit
- admin.creditAccount.canRefundTransaction
- Whether a user has permission to refund a transaction
- admin.creditAccount.canVoidTransaction
- Whether a user has permission to void a transaction
- blc.site.enable.xssWrapper
- Runtime configuration property for blc site enable xss wrapper
- Default:
false
Google Cloud Storage
- broadleaf.google.storage.bucket
- Runtime configuration property for broadleaf google storage bucket
- broadleaf.google.storage.pathToJsonKeyFile
- Runtime configuration property for broadleaf google storage path to json key file
- broadleaf.google.storage.projectId
- Runtime configuration property for broadleaf google storage project id
- broadleaf.google.storage.subdirectory
- Runtime configuration property for broadleaf google storage subdirectory
I18n Enterprise
- i18n.regional.form.enabled
- Enable region based DynamicForms
- i18nMessages.thresholdForFullCache
- Runtime configuration property for i18n messages threshold for full cache
- Default:
1000
- international.message.cache.timeout
- Cache timeout in seconds for message sources
- By default, set to
-1which is an eternal cache
- international.message.resolution.enabled
- Resolution flag on whether the BroadleafI18nMergeResourceExtensionHandler should resolve the message
- Off by default.
- precached.sparse.override.internationalmessage.template.enabled
- Whether or not {@link #getLocaleBasedTemplateValue(String, String, String, String, String, String)} will be utilized from this strategy. If false, the fallback {@link ThresholdCacheInternationalMessageOverrideStrategy#getLocaleBasedTemplateValue(String, String, String, String, String, String)} will be used instead. If the 'template' repository (MT concept) is large, this value should be left true. However, if the 'template' repository is relatively small, you may want to consider setting this to false in order to leverage the possibility of complete caching in the default strategy. See {@link InternationalMessageSupport#getThresholdForFullCache()} for more info on this option. The default value is true. Set the 'precached.sparse.override.internationalmessage.template.enabled' property to change the value. This value is meaningless if the current standard site is found to contain active isolated values for international messages. Review the documentation in com.broadleafcommerce.tenant.service.cache.SparseOverridePreCacheServiceImpl for more information.
Import
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- import.catalog.columnName
- The column name to use when searching for either a catalog discriminator or the catalog name during import
- Default:
catalog
- import.csv.batch.size
- Runtime configuration property for import csv batch size
- Default:
50
- import.sandbox.container
- When importing into a sandbox, whether or not each item in the import happens all under a container (meaning, you can only promote/approve the import as a whole) or individually for each record (all are managed separately)
- Default:
false
- import.server.file.buffer.size
- The number of bytes from the input stream that will be read at a time
- Default:
8192
- import.server.max.uploadable.file.size
- The maximum file size that can be uploaded (10 Meg) Implementors should tune this according to their needs.
- Default:
10000000
- import.server.uploadable.file.allowed.extension
- List of allowed extensions of files to upload, must be comma-separated( jpg, txt, pdf etc.). If blank all extensions are available. Implementors should tune this according to their needs.
- sandbox.lifecycle.strategy.simple.enabled
- Determines whether sandbox lifecycle strategy simple is enabled
- Default:
false
Importer
- absolute.path.imageMagick
- mandatory absolute path for imageMagick converter
- admin.import.allowed.image.size
- Runtime configuration property for admin import allowed image size
- Default:
-1
- admin.import.download.image.url.connection.timeout
- Timeout duration (in ms or seconds) for admin import download image url connection
- Default:
10
- admin.import.download.image.url.path
- File system or resource path configuration for admin import download image url
- Default:
#{null
- admin.import.download.image.url.socket.timeout
- Timeout duration (in ms or seconds) for admin import download image url socket
- Default:
30
- admin.import.image.download.batch.size
- Runtime configuration property for admin import image download batch size
- Default:
100
- admin.import.image.download.max.retry.count
- Runtime configuration property for admin import image download max retry count
- Default:
10
- admin.import.image.download.wait.before.retry.millis
- Configures the duration or polling interval for admin import image download wait before retry
- Default:
300000
- admin.import.image.send.invalidate.cache.event
- Runtime configuration property for admin import image send invalidate cache event
- Default:
true
- asset.import.folder.name
- Runtime configuration property for asset import folder name
- Default:
IMPORT
- asset.server.url.prefix.internal
- The following property defines the prefix used internally by the CMS system to identify requests that it needs to process
- asset.use.filesystem.storage
- Controls whether the AssetService stores (and retrieves) the binary asset from the filesystem or database
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- import.category.batch.size
- Runtime configuration property for import category batch size
- Default:
100
- import.csv.default.field.separator
- Runtime configuration property for import csv default field separator
- import.customer.address.batch.size
- Runtime configuration property for import customer address batch size
- Default:
100
- import.customer.batch.size
- Runtime configuration property for import customer batch size
- Default:
100
- import.image.event.worker.type
- Configures the execution strategy or mode for import image event worker
- Default:
ADMIN
- import.order.batch.size
- Runtime configuration property for import order batch size
- Default:
100
- import.process.event.worker.type
- Configures the execution strategy or mode for import process event worker
- Default:
ADMIN
- import.product.batch.size
- Runtime configuration property for import product batch size
- Default:
100
- import.product.useCatalogDiscForOptions
- Runtime configuration property for import product use catalog disc for options
- Default:
false
- import.server.file.buffer.size
- The number of bytes from the input stream that will be read at a time
- Default:
8096
- import.server.max.uploadable.file.size
- The maximum file size that can be uploaded (10 Meg) Implementors should tune this according to their needs.
- Default:
10000000
- import.server.uploadable.file.allowed.extension
- List of allowed extensions of files to upload, must be comma-separated( jpg, txt, pdf etc.). If blank all extensions are available. Implementors should tune this according to their needs.
- Default:
#{null
- import.xlsx.default.sheet.name
- Runtime configuration property for import xlsx default sheet name
- multitenant.static.asset.unset.behavior
- Determines whether static assets with unset StaticAssetShareableType are always or never shared with other MT sites
- spring.http.multipart.max-file-size
- Set max file and request size (Spring Boot v1)
- Default:
10MB
- spring.http.multipart.max-request-size
- Runtime configuration property for spring http multipart max request size
- Default:
10MB
- spring.servlet.multipart.max-file-size
- Set max file and request size (Spring Boot v2+)
- Default:
10MB
- spring.servlet.multipart.max-request-size
- Runtime configuration property for spring servlet multipart max request size
- Default:
10MB
Marketplace
- broadleaf.marketplace.enable.fulfillmentgroup.vendor.split
- Runtime configuration property for broadleaf marketplace enable fulfillmentgroup vendor split
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- fetch.collection.batch.pageSize
- Property used to paginate the query used to retrieve collections to prevent parameter size limit from DB dialects.
- Default:
800
- listGrid.forceShowCatalogColumns
- Runtime configuration property for list grid force show catalog columns
- Default:
false
MaxMind Geolocation
- maxmind.geolocation.city.database.path
- File system or resource path configuration for maxmind geolocation city database
- maxmind.geolocation.country.database.path
- File system or resource path configuration for maxmind geolocation country database
- maxmind.geolocation.service.license.key
- Security credential / API key configuration for maxmind geolocation service license
- maxmind.geolocation.service.user.id
- Runtime configuration property for maxmind geolocation service user id
Menu
None
Merchandising Group
None
Multi-Tenant Single Schema
- admin.baseurl.context
- See
site.baseurl.context - Set to "admin" to specify the Admin app
- See
- admin.baseurl.domain
- See
site.baseurl.domain
- See
- admin.baseurl.port
- See
site.baseurl.port
- See
- admin.baseurl.prefix
- See
site.baseurl.prefix
- See
- admin.baseurl.secure
- See
site.baseurl.secure
- See
- admin.category.treeViewEnabled
- Use Category tree view by default
- Also declared in BroadleafCommercePrivate Open Admin module
- admin.entity.duplication.isactive
- Runtime configuration property for admin entity duplication isactive
- Default:
false
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- catalog.requesturi.cache.alternative.fetch
- The default fetch behavior is to fetch a catalog product or category once per site, even if that product or category are the same across multiple sites. This provides the most efficient fetch behavior when there are few sites. However, this property can be set to true to cause each fetch to check what catalogs are available to the current context site, which provides an opportunity to avoid re-fetching the same product or category, at the cost of iterating through assigned catalogs to make the determination. Therefore, it is only suggested to set this property to true when you have many sites with a small number of catalogs assigned to each site. The default is false.
- catalog.requesturi.cache.max.count
- Runtime configuration property for catalog requesturi cache max count
- Default:
25000
- mt.loaded.flag
- Used by the system to determine if the multitenant module is loaded
- multi.site.key
- Parameter to control single-site behavior
- Default:
xdmFsdWU9dHJ1ZQ==
- multitenant.blPriceLists.solr.priceListCatalogFieldName
- Runtime configuration property for multitenant bl price lists solr price list catalog field name
- Default:
priceListCatalog_s
- multitenant.copy.config.validation.enabled
- Determines whether multitenant copy config validation is enabled
- Default:
true
- multitenant.copy.config.validation.fail.on.problem
- Runtime configuration property for multitenant copy config validation fail on problem
- Default:
false
- multitenant.draftImport.sandboxColor
- Runtime configuration property for multitenant draft import sandbox color
- Default:
#20C0F0
- multitenant.draftImport.sandboxName
- Runtime configuration property for multitenant draft import sandbox name
- Default:
Draft Import
- multitenant.static.asset.unset.behavior
- Determines whether static assets with unset StaticAssetShareableType are always or never shared with other MT sites
- precached.sparse.override.cache.enable
- Determines whether precached sparse override cache is enabled
- Default:
false
- precached.sparse.override.incremental.cache.grooming.enabled
- Determines whether precached sparse override incremental cache grooming is enabled
- Default:
true
- precached.sparse.override.max.elements.inmemory
- Runtime configuration property for precached sparse override max elements inmemory
- Default:
5000
- precached.sparse.override.refresh.interval.millis
- Configures the duration or polling interval for precached sparse override refresh interval
- Default:
3600000
- sandbox.include.deleted.items.production.optimization
- Runtime configuration property for sandbox include deleted items production optimization
- Default:
false
- sandbox.lifecycle.strategy.simple.enabled
- Determines whether sandbox lifecycle strategy simple is enabled
- Default:
false
- single.site.id
- When in single site mode, be sticky to a specific site id (disabled global access too)
- Default:
0
- site.baseurl.context
- Used to differentiate between the site and Admin apps
- site.baseurl.domain
- This property is used for site URL resolution when the site is configured with the
DOMAIN_PREFIXresolution type. - For example, if the value of a given site is "test" and this property is "domain.com", the resulting url would be http://test.domain.com
- This property is used for site URL resolution when the site is configured with the
- site.baseurl.port
- Specifies the server port for site URL resolution
- site.baseurl.prefix
- This property is used for site URL resolition when the site is configured with the
DOMAINresolution type
- This property is used for site URL resolition when the site is configured with the
- site.baseurl.secure
- Specifies whether to use a secure SSL connection for the site
- site.enable.direct.csr.auth
- Optional configuration to include CSR and admin user discovery in the site application. @author Jeff Fischer
- solr.cache.global
- Determines whether Solr uses a global cache that all VMs can update
- If running in stand-alone Solr, you will only want one of the VMs to update the index, as it would be shared between all VMs. In that case, this boolean should be set to false.
- solr.index.catalog.concurrentCatalogThreads
- The number of threads that will be used by the com.broadleafcommerce.tenant.service.search.indexer.MultiTenantCatalogSolrIndexUpdateCommandHandlerImpl to concurrently reindex catalogs.
- Default:
5
- use.global.solr.product.override.cache
- Runtime configuration property for use global solr product override cache
- Default:
false
OMS
- admin.default.max.results
- Max number of entities to fetch in Admin
- blPU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl p u hibernate hbm2ddl auto
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- csr.review.order.enable.manual.payment.auth
- This property defines whether or not the Add Manual Authorization fields are shown in the CSR mode. If set to true, this simply hides the fields from this view, but does not disable the functionality if the backing data is present.
- Default:
false
- event.fulfillmentorderreindex.worker.type
- Specifies the node where fulfillment order reindex event will be consumed
- SITE by default
- event.omscustomerreindex.worker.type
- Specifies the node where oms customer reindex event will be consumed
- SITE by default
- event.omsorderreindex.worker.type
- Specifies the node where oms order reindex event will be consumed
- SITE by default
- gateway.config.global.manualAuthGatewayType
- Runtime configuration property for gateway config global manual auth gateway type
- gateway.config.global.manualAuthPaymentType
- Runtime configuration property for gateway config global manual auth payment type
- oms.changeOrder.payment.gateway.customerPayment.redirectUrl
- URL for the payment gateway to redirect to in order to save a new payment method for an *
- oms.default.secondary.status
- Runtime configuration property for oms default secondary status
- oms.order.block.total.limit
- Batch size or maximum number of items processed per batch for oms order block total
- Default:
0
- oms.order.fulfillButton.enabled
- The value of this property is used to enable the Order Fulfillment button only for development environment
- Default is false
- oms.order.lock.database.time.to.live
- Runtime configuration property for oms order lock database time to live
- Default:
-1L
- oms.order.lock.message
- Runtime configuration property for oms order lock message
- Default:
This order is locked for edit by another user
- oms.order.return.shipping.charge
- Runtime configuration property for oms order return shipping charge
- Default:
0
- oms.returns.ra.splitMessage
- This message gets added to a note when an RA is split.
- This is a message that can be overridden in a properties file or in the
BLC_SYSTEM_PROPERTYtable.
- oms.rma.search.default.behavior
- This property determines how the RMA search page is rendered, by default the page will be rendered like the other entities in the admin. The non default behavior is to have a text where when you input a return auth key it will go directly to that return authorization, this behavior is beneficial when using bar code scanners
- oms.rma.search.use.id
- This property only changes behavior when the default rma search behavior is not being used. It determines which attribute is used to find the return authorization. By default the search will use the RMA number to find the return authorization. If this property is set to true, it will use the entity id.
- oms.search.customer.service.className
- This indicates the implementation class name for the com.broadleafcommerce.oms.search.service.OrderSearchService
- Default:
com.broadleafcommerce.oms.search.service.SolrCustomerSearchServiceImpl
- oms.search.customer.service.solr.admin.location
- Same as
oms.search.order.service.solr.admin.locationexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.className
- If injecting a bean with the name "blOrderSearchSolrServer", which implementation of Solr do we use? Options are org.apache.solr.client.solrj.impl.HttpSolrClient, org.apache.solr.client.solrj.impl.LBHttpSolrClient, or org.apache.solr.client.solrj.impl.CloudSolrServer. Note EmbeddedSolrServer is not supported for this functionality!
- Default:
org.apache.solr.client.solrj.impl.HttpSolrClient
- oms.search.customer.service.solr.namespace
- Same as
oms.search.order.service.solr.namespaceexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.primary.location
- Same as
oms.search.order.service.solr.primary.locationexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.primary.name
- Same as
oms.search.order.service.solr.primary.nameexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.reindex.location
- Same as
oms.search.order.service.solr.reindex.locationexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.reindex.name
- Same as
oms.search.order.service.solr.reindex.nameexcept for Customers rather than Orders
- Same as
- oms.search.fulfillmentOrder.service.solr.admin.location
- Runtime configuration property for oms search fulfillment order service solr admin location
- Default:
http://localhost:8983/solr
- oms.search.fulfillmentOrder.service.solr.className
- If injecting a bean with the name "blOrderSearchSolrServer", which implementation of Solr do we use? Options are org.apache.solr.client.solrj.impl.HttpSolrClient, org.apache.solr.client.solrj.impl.LBHttpSolrClient, or org.apache.solr.client.solrj.impl.CloudSolrServer. Note EmbeddedSolrServer is not supported for this functionality!
- Default:
org.apache.solr.client.solrj.impl.HttpSolrClient
- oms.search.fulfillmentOrder.service.solr.namespace
- Namespace to be used for indexing orders in Solr
- Default:
fulfillment_orders
- oms.search.fulfillmentOrder.service.solr.primary.location
- The value of this property depends on the version of the Solr server defined above. If using HttpSolrServer, this will be a single URL to Solr. If using LBHttpSolrServer, this will be a comma-separated list of URLs to Solr servers. If using CloudSolrServer, this will be a comma-separated list of Zookeeper Servers (e.g. zkHost1:1234,zkHost2:1234)
- Default:
http://localhost:8983/solr/fulfillment_orders
- oms.search.fulfillmentOrder.service.solr.primary.name
- This is the name of the Solr Core or Solr Collection (in the case of SolrCloud).
- Default:
fulfillment_orders
- oms.search.fulfillmentOrder.service.solr.reindex.location
- Runtime configuration property for oms search fulfillment order service solr reindex location
- Default:
http://localhost:8983/solr/fulfillment_orders_reindex
- oms.search.fulfillmentOrder.service.solr.reindex.name
- Runtime configuration property for oms search fulfillment order service solr reindex name
- Default:
fulfillment_orders_reindex
- oms.search.order.service.className
- This indicates the implementation class name for the com.broadleafcommerce.oms.search.service.OrderSearchService
- Default:
com.broadleafcommerce.oms.search.service.SolrOrderSearchServiceImpl
- oms.search.order.service.solr.admin.location
- URL of the OMS Order Solr admin
- See
oms.search.order.service.solr.primary.location
- oms.search.order.service.solr.className
- If injecting a bean with the name "blOrderSearchSolrServer", which implementation of Solr do we use? Options are org.apache.solr.client.solrj.impl.HttpSolrClient, org.apache.solr.client.solrj.impl.LBHttpSolrClient, or org.apache.solr.client.solrj.impl.CloudSolrServer. Note EmbeddedSolrServer is not supported for this functionality!
- Default:
org.apache.solr.client.solrj.impl.HttpSolrClient
- oms.search.order.service.solr.namespace
- Namespace to be used for indexing orders in Solr
- oms.search.order.service.solr.primary.location
- URL of the OMS Order Primary Solr server
- The value of this property depends on the version of the Solr server in use.
- If using HttpSolrServer, this will be a single URL to Solr.
- If using LBHttpSolrServer, this will be a comma-separated list of URLs to Solr servers.
- If using CloudSolrServer, this will be a comma-separated list of Zookeeper Servers (e.g. zkHost1:1234,zkHost2:1234).
- oms.search.order.service.solr.primary.name
- This is the name of the Solr Core or Solr Collection (in the case of SolrCloud).
- oms.search.order.service.solr.reindex.location
- URL of the OMS Order Solr server for reindexing
- See
oms.search.order.service.solr.primary.location
- oms.search.order.service.solr.reindex.name
- See
oms.search.order.service.solr.primary.name
- See
- oms.search.service.solr.index.pageSize
- Page size when doing full reindex
- oms.search.solr.index.commit
- This tells the client whether to issue a commit to Solr or not.
- It's best for performance to turn this off and use autoSoftCommit.
- oms.search.solr.index.softCommit
- This tells Solr whether to issue a soft or hard commit.
- This only matters if
oms.search.solr.index.commit=true. - Soft is better for performance, but it is advised to use autoSoftCommit.
- Default is true.
- oms.search.solr.index.waitFlush
- Indicates if a the commit process should wait for a flush to disk.
- This only matters if
oms.search.solr.index.commit=true. - Default is false.
- oms.search.solr.index.waitSearcher
- Indicates if a the commit process should wait for a searcher.
- This only matters if
oms.search.solr.index.commit=true. - Default is false.
- oms.smart.search.param
- Runtime configuration property for oms smart search param
- Default:
q
- oms.solr.search.method
- Runtime configuration property for oms solr search method
- Default:
METHOD.POST
- refund.activity.use.settled.only
- Runtime configuration property for refund activity use settled only
- solr.reindex.order.batch.size
- Runtime configuration property for solr reindex order batch size
- Default:
1000
- validator.address.fullNameOnly
- Runtime configuration property for validator address full name only
Paymetrics
- gateway.paymetrics.configuration.accessTokenUrl
- Runtime configuration property for gateway paymetrics configuration access token url
- gateway.paymetrics.configuration.baseUrl
- Runtime configuration property for gateway paymetrics configuration base url
- gateway.paymetrics.configuration.fail.on.potential.fraud
- Runtime configuration property for gateway paymetrics configuration fail on potential fraud
- Default:
false
- gateway.paymetrics.configuration.fraud.service.level
- Runtime configuration property for gateway paymetrics configuration fraud service level
- Default:
0
- gateway.paymetrics.configuration.guid
- Runtime configuration property for gateway paymetrics configuration guid
- gateway.paymetrics.configuration.iframe.cssUrl
- Runtime configuration property for gateway paymetrics configuration iframe css url
- gateway.paymetrics.configuration.iframe.hostUrl
- Runtime configuration property for gateway paymetrics configuration iframe host url
- gateway.paymetrics.configuration.integrationMethod
- Runtime configuration property for gateway paymetrics configuration integration method
- Default:
form
- gateway.paymetrics.configuration.merchant.id
- Runtime configuration property for gateway paymetrics configuration merchant id
- gateway.paymetrics.configuration.password
- Security credential / API key configuration for gateway paymetrics configuration
- gateway.paymetrics.configuration.preloaderUrl
- Runtime configuration property for gateway paymetrics configuration preloader url
- gateway.paymetrics.configuration.processUrl
- Runtime configuration property for gateway paymetrics configuration process url
- gateway.paymetrics.configuration.secret
- Security credential / API key configuration for gateway paymetrics configuration
- gateway.paymetrics.configuration.user
- Runtime configuration property for gateway paymetrics configuration user
- gateway.paymetrics.configuration.xipay.endpoint
- URL endpoint for gateway paymetrics configuration xipay
PayPal Checkout
- gateway.paypal.checkout.rest.cancelUrl
- Runtime configuration property for gateway paypal checkout rest cancel url
- gateway.paypal.checkout.rest.clientId
- Runtime configuration property for gateway paypal checkout rest client id
- gateway.paypal.checkout.rest.description
- Runtime configuration property for gateway paypal checkout rest description
- gateway.paypal.checkout.rest.mode
- Configures the execution strategy or mode for gateway paypal checkout rest
- gateway.paypal.checkout.rest.populate.shipping.create.payment
- Runtime configuration property for gateway paypal checkout rest populate shipping create payment
- Default:
true
- gateway.paypal.checkout.rest.returnUrl
- Runtime configuration property for gateway paypal checkout rest return url
- gateway.paypal.checkout.rest.secret
- Security credential / API key configuration for gateway paypal checkout rest
- gateway.paypal.checkout.rest.webProfileId
- Runtime configuration property for gateway paypal checkout rest web profile id
- gateway.paypal.expressCheckout.shippingDisplayType
- Runtime configuration property for gateway paypal express checkout shipping display type
- gateway.paypal.smart.button.env
- Runtime configuration property for gateway paypal smart button env
PayPal Payflow Pro
- gateway.paypal.payflow.cancelUrl
- Runtime configuration property for gateway paypal payflow cancel url
- gateway.paypal.payflow.errorUrl
- Runtime configuration property for gateway paypal payflow error url
- gateway.paypal.payflow.hostAddress
- "payflowpro.paypal.com"; //LIVE mode
- gateway.paypal.payflow.hostPort
- Runtime configuration property for gateway paypal payflow host port
- gateway.paypal.payflow.mode
- return "LIVE";
- gateway.paypal.payflow.partner
- Runtime configuration property for gateway paypal payflow partner
- gateway.paypal.payflow.password
- Security credential / API key configuration for gateway paypal payflow
- gateway.paypal.payflow.payflowLinkHostedAddress
- "https://payflowlink.paypal.com"; //LIVE MODE
- gateway.paypal.payflow.returnUrl
- Runtime configuration property for gateway paypal payflow return url
- gateway.paypal.payflow.silentPostUrl
- Runtime configuration property for gateway paypal payflow silent post url
- gateway.paypal.payflow.silentTrans
- Runtime configuration property for gateway paypal payflow silent trans
- gateway.paypal.payflow.usePayflowLinkHosted
- Runtime configuration property for gateway paypal payflow use payflow link hosted
- gateway.paypal.payflow.useTransparentRedirect
- Runtime configuration property for gateway paypal payflow use transparent redirect
- gateway.paypal.payflow.user
- Runtime configuration property for gateway paypal payflow user
- gateway.paypal.payflow.vendor
- Runtime configuration property for gateway paypal payflow vendor
Presentation Layer
- cache.template.exists.for.path
- File system or resource path configuration for cache template exists for
- Default:
true
- disableThymeleafTemplateCaching
- If true, the BroadleafCacheProcessor will not cache templates
- theme.templates.folder
- Where Theme Templates are located on the file system
- This folder should end in a slash
- thymeleaf.useLayoutDialect
- Whether to use Thymeleaf Layout Dialect when resolving Thymeleaf views
- thymeleaf.view.resolver.cache
- Runtime configuration property for thymeleaf view resolver cache
- Default:
true
Price List
- blPriceLists.solr.documentType
- Runtime configuration property for bl price lists solr document type
- Default:
PRICE
- blPriceLists.solr.priceListActiveEndDateFieldName
- Runtime configuration property for bl price lists solr price list active end date field name
- Default:
plActiveEndDate_dt
- blPriceLists.solr.priceListActiveStartDateFieldName
- Runtime configuration property for bl price lists solr price list active start date field name
- Default:
plActiveStartDate_dt
- blPriceLists.solr.priceListIdFieldName
- Runtime configuration property for bl price lists solr price list id field name
- Default:
priceListId_l
- blPriceLists.use.contract.pricing
- Runtime configuration property for bl price lists use contract pricing
- Default:
false
- blPriceLists.use.nested.pricing
- Common properties for price lists
- Default:
false
- blPriceLists.use.sale.pricing
- Runtime configuration property for bl price lists use sale pricing
- Default:
false
- precached.sparse.override.pricelist.template.enabled
- Whether or not {@link #getTemplate(String, PriceList, Sku)} will be utilized from this strategy. If false, the fallback {@link ThresholdCachePriceListOverrideStrategy#getTemplate(String, PriceList, Sku)} will be used instead. If the 'template' repository (MT concept) is large, this value should be left true. However, if the 'template' repository is relatively small, you may want to consider setting this to false in order to leverage the possibility of complete caching in the default strategy. See {@link PriceListSupport#getThresholdForFullCache()} for more info on this option. The default value is true. Set the 'precached.sparse.override.pricelist.template.enabled' property to change the value. This value is meaningless if the current standard site is found to contain active isolated values for SkuPriceData. Review the documentation in com.broadleafcommerce.tenant.service.cache.SparseOverridePreCacheServiceImpl for more information.
- precached.sparse.override.pricelist.template.search.restrict.association
- Whether or not to restrict the template search to the catalog of an associated item. For example, restrict the retrieval of the SkuPriceData to the catalog of the Sku. This value is false by default. Change the 'precached.sparse.override.pricelist.template.search.restrict.association' to true to enable.
- pricelist.salePrice.returnValueOnEqualToRetailPrice
- Runtime configuration property for pricelist sale price return value on equal to retail price
- Default:
false
- pricelist.thresholdForFullCache
- Runtime configuration property for pricelist threshold for full cache
- Default:
1000
- query.dateResolution.pricelist
- Runtime configuration property for query date resolution pricelist
- Default:
600000
- solr.index.activeDates.priceList
- Runtime configuration property for solr index active dates price list
- Default:
true
Process
- blEventPU.hibernate.cache.use_query_cache
- Runtime configuration property for bl event p u hibernate cache use query cache
- blEventPU.hibernate.cache.use_second_level_cache
- Runtime configuration property for bl event p u hibernate cache use second level cache
- blEventPU.hibernate.dialect
- Runtime configuration property for bl event p u hibernate dialect
- blEventPU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl event p u hibernate hbm2ddl auto
- blEventPU.hibernate.hbm2ddl.import_files
- Runtime configuration property for bl event p u hibernate hbm2ddl import files
- blEventPU.hibernate.hbm2ddl.import_files_sql_extractor
- Runtime configuration property for bl event p u hibernate hbm2ddl import files sql extractor
- blEventPU.hibernate.implicit_naming_strategy
- Configures the execution strategy or mode for blEventPU hibernate implicit naming
- blEventPU.hibernate.physical_naming_strategy
- Configures the execution strategy or mode for blEventPU hibernate physical naming
- blEventPU.hibernate.show_sql
- Runtime configuration property for bl event p u hibernate show sql
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- process.optimisticLock.maxRetryCount
- Runtime configuration property for process optimistic lock max retry count
- Default:
10
Procurement cXML
- procurement.cxml.password.encoder
- Runtime configuration property for procurement cxml password encoder
- Default:
org.springframework.security.crypto.password.NoOpPasswordEncoder
- punchout.cxml.authentication.url
- URL endpoint for punchout cxml authentication
- Default:
/cxml-punchout
- punchout.cxml.autoProvisionCustomer
- Runtime configuration property for punchout cxml auto provision customer
- Default:
true
- punchout.cxml.cleanPaymentData
- Runtime configuration property for punchout cxml clean payment data
- Default:
true
- punchout.cxml.defaultClassificationDomain
- Runtime configuration property for punchout cxml default classification domain
- punchout.cxml.defaultPunchoutOrderName
- Runtime configuration property for punchout cxml default punchout order name
- punchout.cxml.defaultUom
- Runtime configuration property for punchout cxml default uom
- punchout.cxml.errorUrl
- Runtime configuration property for punchout cxml error url
- Default:
punchoutCXML/error
- punchout.cxml.forceOnlyPunchoutCarts
- Runtime configuration property for punchout cxml force only punchout carts
- Default:
false
- punchout.cxml.order.url
- URL endpoint for punchout cxml order
- Default:
/cxml-order
- punchout.cxml.removeOrderedItemsFromPunchoutOrder
- Runtime configuration property for punchout cxml remove ordered items from punchout order
- Default:
false
- punchout.cxml.setup.url
- URL endpoint for punchout cxml setup
- Default:
/cxml
- punchout.cxml.token.msvalid
- Runtime configuration property for punchout cxml token msvalid
- Default:
60000
- punchout.cxml.transferBackView
- Runtime configuration property for punchout cxml transfer back view
- Default:
punchoutCXML/transferForm
- punchout.cxml.validate.order.line.items
- Runtime configuration property for punchout cxml validate order line items
- Default:
true
- punchout.cxml.validate.order.line.numbers
- Runtime configuration property for punchout cxml validate order line numbers
- Default:
true
- punchout.max.order.attribute.column.size
- Runtime configuration property for punchout max order attribute column size
- Default:
256
Procurement OCI
- procurement.oci.password.encoder
- Runtime configuration property for procurement oci password encoder
- Default:
org.springframework.security.crypto.password.NoOpPasswordEncoder
- punchout.oci.defaultAcceptCharset
- Runtime configuration property for punchout oci default accept charset
- punchout.oci.defaultPunchoutOrderName
- Runtime configuration property for punchout oci default punchout order name
- punchout.oci.defaultTarget
- Runtime configuration property for punchout oci default target
- punchout.oci.defaultUom
- Runtime configuration property for punchout oci default uom
- punchout.oci.errorUrl
- Runtime configuration property for punchout oci error url
- Default:
punchoutOCI/error
- punchout.oci.transferBackView
- Runtime configuration property for punchout oci transfer back view
- Default:
punchoutOCI/transferForm
Product Type
- allow.deprecated.product.bundle.admin.creation
- Runtime configuration property for allow deprecated product bundle admin creation
- Default:
false
- automatically.add.complete.items
- If true, an item with child items will skip the configuration step if there is not required configuration.
- Default:
true
- expectedAddOns.validation.addToCart.enable
- Determines whether expectedAddOns validation addToCart is enabled
- Default:
true
PunchOut2Go
- punchout2go.apiKey
- Security credential / API key configuration for punchout2go
- punchout2go.apiVersion
- Runtime configuration property for punchout2go api version
- Default:
1.0
- punchout2go.autoProvisionCustomer
- Runtime configuration property for punchout2go auto provision customer
- Default:
false
- punchout2go.defaultUom
- Runtime configuration property for punchout2go default uom
- punchout2go.errorUrl
- Runtime configuration property for punchout2go error url
- Default:
punchout2Go/error
- punchout2go.gatewayReturnToUrl
- Runtime configuration property for punchout2go gateway return to url
- Default:
https://connect.punchout2go.com/gateway/link/return/id/{pos}/?redirect=1
- punchout2go.gatewayTransferToUrl
- Runtime configuration property for punchout2go gateway transfer to url
- Default:
https://connect.punchout2go.com/gateway/link/punchin/id/{pos}
- punchout2go.transferBackView
- Runtime configuration property for punchout2go transfer back view
- Default:
punchout2Go/transferForm
Quote
- admin.baseurl.context
- See
site.baseurl.context - Set to "admin" to specify the Admin app
- See
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- quote.auto.accept.csr.submit
- Quote - Allow CSR orders to be automatically accepted on submit
- Default:
true
- quote.config.days.valid
- Runtime configuration property for quote config days valid
- Default:
14
- quote.config.singleuse
- Runtime configuration property for quote config singleuse
- Default:
true
Rackspace Cloud Files
- broadleaf.rackspace.cloudfiles.apikey
- Security credential / API key configuration for broadleaf rackspace cloudfiles
- broadleaf.rackspace.cloudfiles.container
- Runtime configuration property for broadleaf rackspace cloudfiles container
- broadleaf.rackspace.cloudfiles.container.subdirectory
- Runtime configuration property for broadleaf rackspace cloudfiles container subdirectory
- broadleaf.rackspace.cloudfiles.provider
- Runtime configuration property for broadleaf rackspace cloudfiles provider
- broadleaf.rackspace.cloudfiles.region
- Runtime configuration property for broadleaf rackspace cloudfiles region
- broadleaf.rackspace.cloudfiles.username
- Account identifier or username for broadleaf rackspace cloudfiles
Reference Site (Demo Site)
- admin.baseurl.context
- See
site.baseurl.context - Set to "admin" to specify the Admin app
- See
- admin.baseurl.domain
- See
site.baseurl.domain
- See
- admin.baseurl.port
- See
site.baseurl.port
- See
- admin.baseurl.prefix
- See
site.baseurl.prefix
- See
- asset.server.url.prefix.internal
- The following property defines the prefix used internally by the CMS system to identify requests that it needs to process
- b2b.enabled
- Determines whether b2b is enabled
- Default:
false
- blPU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl p u hibernate hbm2ddl auto
- blc.api.doc.autogeneration.enabled
- ******************************************* Below is required swagger configuration for the APIs with Basic Authentication. If you do not want to use Swagger then remove everything below as well as the springfox dependency ********************************************
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- ddos.filter.block.map.timeout
- block for 5 minutes
- Default:
300000
- ddos.filter.ddos.map.timeout
- Reset counters every 1 minute
- Default:
60000
- ddos.filter.enabled
- Determines whether ddos filter is enabled
- Default:
true
- ddos.filter.excluded.request.patterns
- Runtime configuration property for ddos filter excluded request patterns
- ddos.filter.request.threshold
- Allow up to 200 requests per minute
- Default:
200
- enforce.secure
- Runtime configuration property for enforce secure
- Default:
true
- http.server.port
- Spring Boot does not support the configuration of both an HTTP connector and an HTTPS connector via properties. In order to have both, we’ll need to configure one of them programmatically (HTTP). Below is the recommended approach according to the Spring docs: {@link https://github.com/spring-projects/spring-boot/blob/1.5.x/spring-boot-docs/src/main/asciidoc/howto.adoc#configure-ssl} @param httpServerPort @return ServletWebServerFactory
- Default:
8081
- jmx.app.name
- Runtime configuration property for jmx app name
- marketplace.enabled
- Determines whether marketplace is enabled
- Default:
false
- oms.search.customer.service.solr.admin.location
- Same as
oms.search.order.service.solr.admin.locationexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.primary.location
- Same as
oms.search.order.service.solr.primary.locationexcept for Customers rather than Orders
- Same as
- oms.search.customer.service.solr.reindex.location
- Same as
oms.search.order.service.solr.reindex.locationexcept for Customers rather than Orders
- Same as
- oms.search.fulfillmentOrder.service.solr.admin.location
- Runtime configuration property for oms search fulfillment order service solr admin location
- Default:
http://localhost:8983/solr
- oms.search.fulfillmentOrder.service.solr.primary.location
- The value of this property depends on the version of the Solr server defined above. If using HttpSolrServer, this will be a single URL to Solr. If using LBHttpSolrServer, this will be a comma-separated list of URLs to Solr servers. If using CloudSolrServer, this will be a comma-separated list of Zookeeper Servers (e.g. zkHost1:1234,zkHost2:1234)
- Default:
http://localhost:8983/solr/fulfillment_orders
- oms.search.fulfillmentOrder.service.solr.reindex.location
- Runtime configuration property for oms search fulfillment order service solr reindex location
- Default:
http://localhost:8983/solr/fulfillment_orders_reindex
- oms.search.order.service.solr.admin.location
- URL of the OMS Order Solr admin
- See
oms.search.order.service.solr.primary.location
- oms.search.order.service.solr.primary.location
- URL of the OMS Order Primary Solr server
- The value of this property depends on the version of the Solr server in use.
- If using HttpSolrServer, this will be a single URL to Solr.
- If using LBHttpSolrServer, this will be a comma-separated list of URLs to Solr servers.
- If using CloudSolrServer, this will be a comma-separated list of Zookeeper Servers (e.g. zkHost1:1234,zkHost2:1234).
- oms.search.order.service.solr.reindex.location
- URL of the OMS Order Solr server for reindexing
- See
oms.search.order.service.solr.primary.location
- product.quickView.path
- File system or resource path configuration for product quickView
- Default:
DEFAULT_PRODUCT_QUICKVIEW_PATH
- registration.api.url
- URL endpoint for registration api
- registration.database.driver
- Runtime configuration property for registration database driver
- registration.database.password
- Security credential / API key configuration for registration database
- registration.database.url
- URL endpoint for registration database
- registration.database.user
- Runtime configuration property for registration database user
- saved.customer.payments.enabled
- @author Chris Kittrell (ckittrell) @author Jacob Mitash
- server.port
- Runtime configuration property for server port
- Default:
8445
- site.baseurl.context
- Used to differentiate between the site and Admin apps
- site.baseurl.domain
- This property is used for site URL resolution when the site is configured with the
DOMAIN_PREFIXresolution type. - For example, if the value of a given site is "test" and this property is "domain.com", the resulting url would be http://test.domain.com
- This property is used for site URL resolution when the site is configured with the
- site.baseurl.port
- Specifies the server port for site URL resolution
- site.baseurl.prefix
- This property is used for site URL resolition when the site is configured with the
DOMAINresolution type
- This property is used for site URL resolition when the site is configured with the
- site.emailAddress
- Runtime configuration property for site email address
- solr.cloud.configName
- When creating a collection in SolrCloud, you can specify the configuration by name as it is stored in Zookeeper
- solr.cloud.defaultNumReplicas
- Runtime configuration property for solr cloud default num replicas
- solr.cloud.defaultNumShards
- This is the default number of SolrCloud shards that will be created if a collection has to be created by the application
- This number needs to be less than or equal to the number of Solr nodes in the cluster.
- solr.url.admin
- Runtime configuration property for solr url admin
- solr.url.primary
- Runtime configuration property for solr url primary
- solr.url.reindex
- Runtime configuration property for solr url reindex
- theme.templates.folder
- Where Theme Templates are located on the file system
- This folder should end in a slash
- typeahead.manufacturers.limit
- Batch size or maximum number of items processed per batch for typeahead manufacturers
- Default:
5
- typeahead.manufacturers.mincount
- Runtime configuration property for typeahead manufacturers mincount
- Default:
1
- using.solr.cloud
- @author Phillip Verheyden (phillipuniverse)
SagePay Form
- gateway.sagepay.form.allowGiftAid
- Runtime configuration property for gateway sagepay form allow gift aid
- Default:
0
- gateway.sagepay.form.billingErrorMessage
- Runtime configuration property for gateway sagepay form billing error message
- gateway.sagepay.form.cartDescription
- Runtime configuration property for gateway sagepay form cart description
- gateway.sagepay.form.emailMessage
- Runtime configuration property for gateway sagepay form email message
- gateway.sagepay.form.encryptionPassword
- Runtime configuration property for gateway sagepay form encryption password
- gateway.sagepay.form.failureUrl
- Runtime configuration property for gateway sagepay form failure url
- gateway.sagepay.form.genericErrorMessage
- Runtime configuration property for gateway sagepay form generic error message
- gateway.sagepay.form.purchaseUrl
- Runtime configuration property for gateway sagepay form purchase url
- gateway.sagepay.form.sendEmail
- Runtime configuration property for gateway sagepay form send email
- Default:
1
- gateway.sagepay.form.successUrl
- Runtime configuration property for gateway sagepay form success url
- gateway.sagepay.form.vendor
- Runtime configuration property for gateway sagepay form vendor
- gateway.sagepay.form.vendorEmail
- Runtime configuration property for gateway sagepay form vendor email
Sample Payment Gateway
None
Scheduled Jobs and Events
- blPU.hibernate.hbm2ddl.auto
- Runtime configuration property for bl p u hibernate hbm2ddl auto
- database.deploy.event.polling.interval.seconds
- Number of seconds between each polling attempt to the database in search of new deploy system events to process. Only applicable for database-based event implementations, which is the default. Other implementations, such as JMS, may be used instead. Note, if processing of the last batch of events took longer than 5 seconds, then the system will poll again immediately. This setting comes mostly into play when there are no events to process, and the system will wait 5 seconds (by default) to check again for any new events. Default property and value: database.deploy.event.polling.interval.seconds=5
- database.deploy.event.quantity.per.poll
- The number of scheduled deploy events to consume per poll from the database Default property and value: database.deploy.event.quantity.per.poll=20
- database.event.candidate.deletion.pagesize
- Maximum number of defunct events to purge in a single pass
- database.event.compression.collapse.detail.enabled
- Determines whether database event compression collapse detail is enabled
- Default:
false
- database.event.compression.enabled
- Determines whether database event compression is enabled
- Default:
true
- database.event.consumption.enabled
- Whether or not the schedulers for event consumption are intialized at startup. When false, new SystemEvents will not be consumed. Default is true. Can be set via property ${database.event.consumption.enabled}.
- database.event.deletion.pagesize
- Maximum number of defunct events to purge in a single pass
- Default:
100
- database.event.global.check.pagesize
- Maximum number of defunct events to purge in a single pass
- Default:
50
- database.event.lock.threshold
- Number of milliseconds for the event lock threshold. Default 10800000
- database.event.node.log.interval
- The interval for DEBUG level logging in this class. If set to -1, DEBUG logging will always be emitted when the log level is set to DEBUG. However, if the interval is set to a positive integer, the DEBUG logging will be emitted (if the log level is set to DEBUG) every [interval] times a batch of events is passed into this class for processing. Default is -1. Can be set via property ${database.event.node.log.interval}.
- database.event.polling.interval.seconds
- Number of seconds between each polling attempt to the database in search of new system events to process.
- Only applicable for database-based event implementations, which is the default. Other implementations, such as JMS, may be used instead.
- database.event.quantity.per.poll
- Number of jobs/events to process during a single polling attempt
- database.global.event.polling.interval.seconds
- Period of time between attempts to retrieve a new batch of {@link EventScopeType#GLOBAL} events from the database. If the last batch of events has not been depleted yet by the configured worker threads (see {@link #globalJobThreadPoolCount}) at the time of polling, the current polling round is skipped. See {@link GlobalConsumeWorkerImpl} for more information. Default is 5. Can be set via property ${database.global.event.polling.interval.seconds}. @see GlobalConsumeWorkerImpl
- database.global.event.quantity.per.poll
- The number of {@link EventScopeType#GLOBAL} events to retrieve from the datastore and queue up for consumption during a polling attempt ({@link #globalPollingIntervalSeconds}). See {@link GlobalConsumeWorkerImpl} for more information. Default is 10. Can be set via property ${database.global.event.quantity.per.poll}. @see GlobalConsumeWorkerImpl
- database.global.job.thread.pool.count
- The quantity of threads use to consume {@link EventScopeType#GLOBAL} events. This can be increased to increase potential throughput via multiple, concurrent threads consuming events, at the possible cost of additional CPU usage. Since consuming events is often not the primary work of a given node in the cluster, it is important to throttle event consumption appropriately to not interfere with the nodes primary purpose. The default is 3. Can be set via property ${database.global.job.thread.pool.count}. See {@link #eventsPerPoll} and {@link #pollingIntervalSeconds} for other properties that can be used to affect throughput, possibly without changing the job thread pool count.
- database.job.thread.pool.count
- The quantity of threads used to consume {@link EventScopeType#VM} events. This can be increased to increase potential throughput via multiple, concurrent threads consuming events, at the possible cost of additional CPU usage. Since consuming events is often not the primary work of a given node in the cluster, it is important to throttle event consumption appropriately to not interfere with the nodes primary purpose. The default is 2. Can be set via property ${database.job.thread.pool.count}. See {@link #eventsPerPoll} and {@link #pollingIntervalSeconds} for other properties that can be used to affect throughput, possibly without changing the job thread pool count.
- database.missed.durable.event.polling.threshold.seconds
- The maximum age of a durable events (in seconds) that a node will consume. A value of -1 means there is no max age and all available missed durable events will be processed. 604800 is the default (7 days). Can be set via property ${database.missed.durable.event.polling.threshold.seconds}.
- database.priority.event.polling.interval.seconds
- Period of time between attempts to retrieve a new batch of priority events from the database. If the last batch of events has not been depleted yet by the configured worker threads (see {@link #priorityJobThreadPoolCount}) at the time of polling, the current polling round is skipped. See {@link PriorityConsumeWorkerImpl} for more information on priority events. Default is 5. Can be set via property ${database.priority.event.polling.interval.seconds}. @see PriorityConsumeWorkerImpl
- database.priority.event.quantity.per.poll
- The number of priority events to retrieve from the datastore and queue up for consumption during a polling attempt ({@link #priorityPollingIntervalSeconds}). See {@link PriorityConsumeWorkerImpl} for more information on priority events. Default is 20. Can be set via property ${database.priority.event.quantity.per.poll}. @see PriorityConsumeWorkerImpl
- database.priority.job.thread.pool.count
- The quantity of threads used to consume priority events. Priority events are those whose {@link SystemEvent#getPriority()} value is less than 0. This property can be increased to increase potential throughput via multiple, concurrent threads consuming events, at the possible cost of additional CPU usage. Since consuming events is often not the primary work of a given node in the cluster, it is important to throttle event consumption appropriately to not interfere with the nodes primary purpose. The default is 4. Can be set via property ${database.priority.job.thread.pool.count}. See {@link #priorityEventsPerPoll} and {@link #priorityPollingIntervalSeconds} for other properties that can be used to affect throughput, possibly without changing the job thread pool count.
- deploy.node.purge.interval.seconds
- Number of seconds between each polling attempt to the database in search of defunct nodes to purge. Default property and value: deploy.node.purge.interval.seconds=30
- deploy.node.purge.threshold.seconds
- Number of seconds a node can miss heartbeat detection before determining that the node has become defunct. Default property and value: deploy.node.purge.threshold.seconds=60
- event.data.source
- Runtime configuration property for event data source
- Default:
jdbc/event
- event.global.check.interval.seconds
- Number of seconds between each polling attempt to the database in search of completed GlobalEvents before marking it as completed.
- Default:
10
- event.purge.interval.seconds
- Number of seconds between each polling attempt to the database in search of defunct SystemEvents to purge.
- master.deploy.node.enabled
- Determines whether master deploy node is enabled
- Default:
true
- master.deploy.node.heartbeat.interval.seconds
- Number of seconds between each hearbeat check event for a node. During this check, a node has the opportunity to ascend to master status if there isn't a master, or if the current master is determined to be defunct. Default property and value: master.deploy.node.heartbeat.interval.seconds=10
- master.node.heartbeat.interval.seconds
- Number of seconds between each hearbeat check event for a node.
- During this check, a node has the opportunity to ascend to master status if there isn't a master or if the current master is determined to be defunct.
- master.node.incognito
- Runtime configuration property for master node incognito
- Default:
false
- master.node.incognito.id
- Runtime configuration property for master node incognito id
- Default:
NONE
- master.node.job.management.enabled
- Determines whether master node job management is enabled
- Default:
true
- min.time.collision.threshold.ms
- Runtime configuration property for min time collision threshold ms
- Default:
2000
- node.purge.interval.seconds
- Number of seconds between each polling attempt to the database in search of defunct nodes to purge.
- node.purge.threshold.seconds
- Number of seconds a node can miss heartbeat detection before determining that the node has become defunct.
- process.abandoned.allow.retry
- Runtime configuration property for process abandoned allow retry
- Default:
true
- process.abandoned.handle.interval.seconds
- Configures the duration or polling interval for process abandoned handle interval
- Default:
60
- process.abandoned.handle.threshold.seconds
- Configures the duration or polling interval for process abandoned handle threshold
- Default:
60
- process.abandoned.purge.threshold.seconds
- Configures the duration or polling interval for process abandoned purge threshold
- Default:
86400
- process.manager.enabled
- Determines whether process manager is enabled
- Default:
true
- process.manager.status.update.interval.seconds
- Configures the duration or polling interval for process manager status update interval
- Default:
5
Solr Starter
- solr.server.autoConfigEnabled
- @author Jeff Fischer
Stripe
- gateway.stripe.apiVersion
- Runtime configuration property for gateway stripe api version
- gateway.stripe.auth_and_capture
- Runtime configuration property for gateway stripe auth and capture
- Default:
performAuthorizeAndCapture
- gateway.stripe.environment
- Runtime configuration property for gateway stripe environment
- gateway.stripe.level_3_data_enabled
- Determines whether gateway stripe level 3 data is enabled
- Default:
false
- gateway.stripe.payment_intent_return_url
- URL endpoint for gateway stripe payment intent return
- gateway.stripe.privateKey
- Runtime configuration property for gateway stripe private key
- gateway.stripe.publicKey
- Runtime configuration property for gateway stripe public key
Subscription
- subscriptions.autopending.batch.size
- Runtime configuration property for subscriptions autopending batch size
- Default:
100
- subscriptions.autopending.threads
- Runtime configuration property for subscriptions autopending threads
- Default:
5
- subscriptions.autosuspend.batch.size
- Runtime configuration property for subscriptions autosuspend batch size
- Default:
100
- subscriptions.autosuspend.threads
- Runtime configuration property for subscriptions autosuspend threads
- Default:
5
- subscriptions.expiration.notice.length
- Runtime configuration property for subscriptions expiration notice length
- Default:
10
- subscriptions.expiration.notification.nonrepeat.period
- Runtime configuration property for subscriptions expiration notification nonrepeat period
- Default:
5
- subscriptions.grace.period
- Runtime configuration property for subscriptions grace period
- Default:
10
- subscriptions.mark.as.due.batch.size
- Runtime configuration property for subscriptions mark as due batch size
- Default:
100
- subscriptions.mark.as.due.threads
- Runtime configuration property for subscriptions mark as due threads
- Default:
5
- subscriptions.payment.batch.size
- Runtime configuration property for subscriptions payment batch size
- Default:
100
- subscriptions.payment.threads
- Runtime configuration property for subscriptions payment threads
- Default:
5
- subscriptions.soft.declined.failover.max
- Runtime configuration property for subscriptions soft declined failover max
- Default:
3
- subscriptions.tender.notification.batch.size
- Runtime configuration property for subscriptions tender notification batch size
- Default:
100
- subscriptions.tender.notification.threads
- Runtime configuration property for subscriptions tender notification threads
- Default:
5
Theme
- bundle.enabled
- If true, resources inside of a
blc:bundletag within a template will be bundled into a single file. - Note that when
bundle.enabledis set to true that changes to file-system based resources will not be picked up until the server is restarted.- For this reason,
bundle.enabledis normally set to false in development (typically indevelopment.properties).
- For this reason,
- If true, resources inside of a
- cache.page.templates
- Whether to cache page templates
- In non development environments, we should aggressively cache page templates.
- cache.page.templates.ttl
- The time to live for page templates
- Defaults to 1 day
- include.theme.classpath.locations
- Runtime configuration property for include theme classpath locations
- Default:
true
- query.dateResolution.themeconfiguration
- Runtime configuration property for query date resolution themeconfiguration
- Default:
10000
- resource.caching.enabled
- Determines whether BroadleafCachingResourceResolver should cache resources
- resource.versioning.enabled
- Used by BroadleafVersionResourceResolver to determine if resources should be versioned.
- When the staticResourceBrowserCacheSeconds is set to a non-zero number, resources should be versioned to prevent client browsers from caching a stale JS or CSS file.
- theme.classpath.prefix
- Configures the prefix string for theme classpath
- Default:
themes/
- theme.files.basedir
- Where Theme Files are located on the file system
- theme.templates.folder
- Where Theme Templates are located on the file system
- This folder should end in a slash
Vertex Tax
- vertex.field.character.limit
- Batch size or maximum number of items processed per batch for vertex field character
- Default:
40
Vyze Financing
- gateway.vyze.accountUrl
- Runtime configuration property for gateway vyze account url
- gateway.vyze.apiKey
- Security credential / API key configuration for gateway vyze
- gateway.vyze.authUrl
- Runtime configuration property for gateway vyze auth url
- gateway.vyze.brand
- Runtime configuration property for gateway vyze brand
- gateway.vyze.channelPartner
- Runtime configuration property for gateway vyze channel partner
- gateway.vyze.failureApplicationRedirectUrl
- Runtime configuration property for gateway vyze failure application redirect url
- gateway.vyze.failureRedirectUrl
- Runtime configuration property for gateway vyze failure redirect url
- gateway.vyze.flowType
- Runtime configuration property for gateway vyze flow type
- Default:
COMPLETE
- gateway.vyze.notificationUrl
- Runtime configuration property for gateway vyze notification url
- gateway.vyze.posSystemId
- Runtime configuration property for gateway vyze pos system id
- gateway.vyze.sessionUrl
- Runtime configuration property for gateway vyze session url
- gateway.vyze.store
- Runtime configuration property for gateway vyze store
- gateway.vyze.successApplicationRedirectUrl
- Runtime configuration property for gateway vyze success application redirect url
- gateway.vyze.successRedirectUrl
- Runtime configuration property for gateway vyze success redirect url
- gateway.vyze.transactionsUrl
- Runtime configuration property for gateway vyze transactions url
Apple Pay
None (Configured via client integration)
Avalara Tax
None (Configured via database ModuleConfiguration in the Admin UI)
FedEx
None (Configured via database ModuleConfiguration in the Admin UI)
TaxCloud
None (Configured via database ModuleConfiguration in the Admin UI)
UPS
None (Configured via database ModuleConfiguration in the Admin UI)