Promotion component configuration file (wc-admin-component.xml)
The promotions component configuration file (wc-admin-component.xml) contains properties that are related to configuring promotions features for the Lab. You can change the properties to suit the business needs of your site by creating a custom wc-admin-component.xml file that contains the changed properties only.
- HCL-Commerce-Transaction-Server\src\projects\ts-ear\resources-ext\xml\config\com.ibm.commerce.promotion\wc-admin-component.xml
| Property | Description |
|---|---|
PromotionUniqueCodeValidation
|
Controls validation of unique promotion codes. This
property indicates whether a validation error message is to be thrown
when a public promotion code (manually entered by the user) is reused in
another active promotion. The Value parameter can be set to following values:
In an extended site model, promotion code validation is a site-wide setting. This setting applies to the asset store and extended site stores. If an active promotion has promotion code ABC, no other active promotion in the asset store or an extended site store can have this promotion code. |
PromotionUniquePriorityValidation
|
Controls validation of unique promotion priorities.
This property indicates whether a validation error message is to be
thrown when a promotion priority is reused in another active promotion.
The Value parameter can be set to the following values:
In an extended site model, priority validation is a site-wide setting. This setting applies to the asset store and extended site stores. If an active promotion has a priority of 10, no other active promotion in the asset store or an extended site store can this priority level. |
PromotionSiteWideValidation
|
This property indicates whether site-wide validation
is to be performed or not. If a promotion is marked as site-wide, then
it should not have any catalog entries or categories for inclusion. If a
promotion is marked as not site-wide, then it should have at least one
catalog entry or category for inclusion. The
Value parameter can be set to the following values:
|
PopulateCodeColumnOfPxPromotionTable
|
This property indicates whether the PX_PROMOTION.CODE
column is to be populated with a list of public promotion codes. The
PX_PROMOTION.CODE column has a length of 128 characters and might not
accommodate many public promotion codes for a promotion. The public
promotion codes are saved one per row to the PX_PROMOCD table. The
Value parameter can be set to the following values:
|
| Promotion Runtime property | Description |
|---|---|
PromotionCatalogEntryAttributeRuleValidation
|
This property indicates whether a catalog entry attribute rule
validation must be applied upon the activation of a promotion.
The validation is for catalog entry promotions where attributes
are specified. This validation ensures that the attribute name
and values that are specified in a promotion exist for all of
the catalog entries that are targeted in the promotion.
The Value parameter can be set to the
following values:
|
maxNumberOfActivePromotionsWithRedemptionLimits
|
Use this property to set the maximum number of
active promotions in your system that can contain redemption limits.
If this maximum number is reached, the activation of a promotion is
prevented until an active promotion that contains redemption limits
is deactivated. Set the Value parameter to
-1 to allow an unlimited number of active
promotions with redemption limits. The default value is
-1. |
maxNumberOfActivePromotionsWithAttributes
|
Use this property to set the maximum number of
active promotions in your system that can target product attributes.
If this maximum number is reached, the activation of the promotion
is prevented until another promotion that targets attributes is
deactivated. Set the Value parameter to
-1 to allow an unlimited number of active
promotions that target product attributes. The default value is
-1. |
maxTargetedCatalogEntriesPerPromotion
|
Use this property to set the maximum number of
catalog entries that can be targeted for a promotion. If this
maximum number is reached, the activation of this promotion is
prevented until the promotion is corrected. Set the
Value parameter to -1 to
allow an unlimited number of catalog entries to be targeted for a
promotion. The default value is -1. |
maxTargetedCategoriesPerPromotion
|
Use this property to set the maximum number of
categories that can be targeted for a promotion. If this maximum
number is reached, the activation of this promotion is prevented
until the promotion is corrected. Set the Value
parameter to -1 to allow an unlimited number of categories to be
targeted for a promotion. The default value is
-1. |
ListOnlyPromotionsNotInFolders
|
This property controls whether promotions that are
in a folder display in the main Promotions -
List view in the Promotions tool. The following are
the possible values for this property:
|
ConvertPromotionDatesToUTC
|
Use this property to convert promotion start date,
end date, start time of day and end time of day values to UTC
(Coordinated Universal Time) before the values are saved to the
promotion runtime XML.
|
AllowDeactivatingPromotionWhileGeneratingCodes
|
Use this property to determine whether users can
cancel the generation of promotion codes by deactivating the
promotion while code generation is in progress.
|
TrackPublicPromotionCodeUsage |
Use this property to indicate whether public promotion code usage
is recorded in the PX_CDUSAGE database table. You
can set the following values for this property:
|
| Unique promotion code property | Description |
CodePopulateBatchSize
|
Controls the number of unique promotion codes to be included in
a batch to be populated to your database.
The Value parameter can be set to a positive integer value. The default value is 1000. |
CodeDeleteBatchSize
|
Use this property to indicate the number of promotion codes to include in a batch when promotion codes are deleted. This property is used when codes are deleted codes because a code generation process is canceled before completion, or when a promotion that generates codes is activated while codes exist in the database previously for that promotion. The Value parameter can be set to a positive integer value. The default value is 1000. |
HostForPromotionCodePopulationScheduledJob
|
Use this property to identify the scheduler instance that should execute the unique promotion code population scheduled job. If you leave the Value parameter as an empty string, the job runs on any scheduler instance. Each scheduler instance can have a unique instance name; by default the name is the web server host name. The default value for this property is an empty string. |
PriorityForPromotionCodePopulationScheduledJob
|
Use this property to identify the priority of the
unique promotion code population scheduled job. If you leave the
Value parameter as an empty string, the job
is assigned the default priority of 5
(java.lang.Thread.NORM_PRIORTY). The values
that are valid for this property are between the range of 1
(java.lang.Thread.MIN_PRIORITY) and 10
(java.lang.Thread.MAX_PRIORITY). |
ApplicationTypeForPromotionCodePopulationScheduledJob
|
Use this property to identify the application schedule pool that the unique promotion code population scheduled job is a part of. If you leave the Value parameter as an empty string, the job is assigned to the default application type. The application types, and the rules that govern their access to resources, are defined under the administrative console. The default value is an empty string. |
com.ibm.commerce.promotion.uniquecode.generator.AlphabeticLowerPatternCharacters
|
Controls the input and output values that are
generated with advanced system-generated unique promotion codes. The
default input and output pattern values are based on English
alphanumeric characters. The Value parameter of each property can be set to custom alphanumeric character values to support your custom characters. For the default values of these properties, review the wc-admin-component.xml promotion component configuration file. |
WaitingPeriodForUniqueCodeRelease
|
Controls the number of minutes until a unique
promotion code applied by a guest shopper from an abandoned order is
released. The promotion code can then be applied by another
customer. The Value parameter can be set
to a positive integer value in minutes. The value can also be
set to |
ShopperTypeForUniqueCodeRelease
|
Controls the behavior for how unique promotion
codes are released. By default, when a guest shopper adds a unique
promotion code to a shopping cart the code is locked to that order
for the amount of time that is specified in the
WaitingPeriodForUniqueCodeRelease configuration
property. When the specified time is reached, any guest or
registered shopper can then claim the promotion code. If a
registered shopper adds a unique code to a shopping cart, the code
is not released until the shopper removes the code from the order.
By using the ShopperTypeForUniqueCodeRelease
configuration property, an administrator can select one of the
following behaviors for how a unique promotion code is released:
|
HostForPromotionCodeExportScheduledJob
|
Use this property to identify the scheduler instance that is to be used to execute a promotion code export scheduled job. |
CompressPromotionCodeExportFile
|
Controls whether promotion codes are exported into
a compressed downloadable file when you are exporting promotion
codes with Lab. The Value parameter can be set to the following values:
|
ApplyPromotionOnLowestPricedOrderItemsFirst |
Controls whether the promotion is applied to the
lowest priced item first or to the highest priced item first. For
more information on adding constraints, see To make a promotion apply to
the least expensive item.
|