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 Management Center. 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.

The promotion component configuration files are stored in the following locations:

WC_eardir\xml\config\com.ibm.commerce.promotion\wc-admin-component.xml
WC_eardir\xml\config\com.ibm.commerce.promotion-fep\wc-admin-component.xml

The following table summarizes the configurable properties in the `WC_eardir`\xml\config\com.ibm.commerce.promotion\wc-admin-component.xml file:
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: false Validation is not enabled. A business user can assign the same promotion code to more than one active promotion in the same store. This setting is the default setting. true Validation is enabled. Prevents business users from assigning the same promotion code to more than one active promotion in the same store. This setting enforces unique promotion codes so that only one associated promotion can apply to a customer's order on the storefront. When a business user activates a promotion, the promotion engine checks the store for active promotions that use the same promotion code. If there are any, the business user is prevented from activating the promotion. An error message informs the business user that the promotion code is being used so that the user can assign a different code. 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: false Validation is not enabled. Allows business users to assign the same priority to more than one active promotion in the same promotion group in the same store. This setting is the default setting. true Validation is enabled. Prevents business users from assigning the same priority to more than one active promotion in the same promotion group in the same store. For example, only one active shipping promotion can be assigned a priority of 1. This setting ensures that business users assign unique priorities to control the order in which the promotion engine evaluates promotions in the same promotion group. When a business user activates a promotion, the promotion engine checks for active promotions in the same promotion group that have the same priority. If there are any, the business user is prevented from activating the promotion. An error message informs the business user that the priority is being used so that the user can assign a different priority. 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: false Validation is not to be performed site-wide. true Validation is to be performed. This value is the default value.
`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: false Disables writing to this database column. If you create a promotion that has many public promotion codes, you are recommended to set this flag to be false. true Enables writing to this database column. This value is the default value.

The following table summarizes the configurable properties in the `WC_eardir`\xml\config\com.ibm.commerce.promotion-fep\wc-admin-component.xml file:
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: false Validation is not enabled true Validation is enabled. This value is the default value.
`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: true The main Promotions - List view does not display any promotions that are included within a folder. false All promotions display in the main Promotions - List view (Default value).
`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. true The property is enabled and the dates and times are read and interpreted in UTC when a promotion is propagated to the production server. This property can help ensure that your time zone conditions are consistent on both your staging and production servers. For example, a promotion that is defined in Management Center on the staging server to run during a specified time period runs during that same time period on the production server. false (Default value).
`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. true Users can cancel the code generation by clicking the Deactivate button for the promotion. false Users must wait until the promotion code generation finishes before the user can deactivate the promotion (Default value).
`TrackPublicPromotionCodeUsage`¹	Use this property to indicate whether public promotion code usage is recorded in the PX_CDUSAGE database table. By default when you apply the interim fix for APAR #JR53901, only the use of unique promotion codes in orders is recorded in the PX_CDUSAGE database table. You can set the following values for this property: true The usage of public promotion codes is recorded along with the usage of unique codes. When a shopper uses a public promotion code, a record is added to the PX_CDUSAGE database table. Enabling this usage tracking can affect performance. When this property is enabled and your store is experiencing high volume traffic, shoppers might experience delays or possibly timeouts during order checkout. Specifically, when public promotion codes are shared across multiple promotions. false The usage of public promotion codes is not tracked (default value). This setting does not affect the recording of unique promotion codes.
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 WebSphere Commerce Server 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` `com.ibm.commerce.promotion.uniquecode.generator.AlphabeticLowerPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.AlphabeticMixPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.AlphabeticMixPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.AlphabeticUpperPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.AlphabeticUpperPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.AlphaLowerNumericPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.AlphaLowerNumericPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.AlphaMixNumericPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.AlphaMixNumericPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.AlphaUpperNumericPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.AlphaUpperNumericPatternCode` `com.ibm.commerce.promotion.uniquecode.generator.NumericPatternCharacters` `com.ibm.commerce.promotion.uniquecode.generator.NumericPatternCode`	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 `-1` where the promotion code is not released unless it is manually removed by the guest shopper. The default value is 1440 minutes.
`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: 1 Guest shopper codes are released when the time that is specified for the `WaitingPeriodForUniqueCodeRelease` property is reached. Registered shoppers do not lose their unique promotion codes unless the shopper removes the code from the order. This behavior is the default behavior and value for the `ShopperTypeForUniqueCodeRelease` property. 2 Registered shopper codes are released when the time that is specified for the `WaitingPeriodForUniqueCodeRelease` property is reached. Guest shoppers do not lose their unique promotion codes unless the shopper removes the code from the order. 3 The unique promotion codes for all shoppers are released when the time that is specified for the `WaitingPeriodForUniqueCodeRelease` property is reached.
`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 Management Center. The Value parameter can be set to the following values: false Promotion codes are exported into a non-compressed comma-separated values (CSV) format. This setting is the default setting for this property. true Promotion codes are exported into a compressed file format.
`ApplyPromotionOnLowestPricedOrderItemsFirst`	Controls whether the promotion is applied to the lowest priced item first or to the highest priced item first. To use this property, you need to install and enable the interim fix for JR50130. false This is the default value. The promotion is applied to the highest priced item first. true The promotion is applied to the lowest priced item first.

Note: As an administrator, you can configure the Promotion tool so that promotions that are included in a folder no longer displays in the main Promotions - List view. If your store has hundreds or thousands of promotions, preventing promotions that are sorted in folders from displaying in the Promotions - List view can make finding promotions easier. With this configuration, business users can browse through folders to find sorted promotions and browse the main Promotions - List view to find unsorted promotions. For more information, see Finding promotions.

¹ You must apply the interim fix for APAR #JR53901 to use this property.

You must apply the interim fix for APAR #JR48776 to use this property.