Price rule element template parameters

Format of price rule element template parameters

The format depends on where the data is coming from. There are two options:

1. Data is coming from the user interface.
   If the data the task command needs is data that a business user enters when setting up the condition or action, then the format looks like this:

   <Argument name="paramName" value="PRICERULE_paramName" />

   All parameter values that come from the user interface start with this prefix: PRICERULE_. Here is an example; in this case, it is for a condition that evaluates whether the customer has registered on, before, or after a specific date:

   <Argument name = "registrationTime" value = "PRICERULE_registrationTime"/>

   When a business user inputs data about a condition or action used in a price rule and then saves it, the name-value pairs for each price rule element template parameter are saved to the PRELEMENTATTR table. Here is an example of a row in the table for a condition with the PRELEMENT_ID of 1000:

   Sample PRELEMENTATTR table content

   PRELEMENT_ID	NAME	VALUE
   1000	"registrationTime"	2010-07-01 00:00:00

   When the price rule is used on the storefront to set pricing:

   • The pricing services look up the paramName in the PRELEMENTATTR table, and replace the value PRICERULE_paramName in the runtime XML with the corresponding value.
   • If the paramName is not found in the PRELEMENTATTR table, then value will be set to any empty string, and that parameter will be ignored.
2. Data is specified directly in the template definition.

   For certain conditions and actions, the task command needs data that a business user does not enter. In this case, the parameter value does not have the prefix PRICERULE_.

   For example, if a task command must check whether a user is registered, then the following parameter can pass this information to the task command:

   <Argument name="userType" value="R" />

Parameters for lists captured in grid objects

For some price rule elements, business users can specify lists of things like categories, or catalog entries, or member groups. For example, a business user can specify more than one category for the Catalog Condition element. In the properties view of the price rule element, the lists are captured using a grid object. When the list is persisted in the PRELEMENTATTR table, each row in the grid corresponds to one row in the PRELEMENTATTR table, and each row refers to the same property name. For example:

When this type of parameter is included in a price rule element template definition, the parameter needs to specify only one element. For example, the parameter for the previous example looks like this:

<Argument name="categoryIdList" value="PRICERULE_categoryIdList"/>

To get the list from the user interface, the corresponding price rule element task command must call the method getElementParameters. The method returns a comma separated list of all the values from the PRELEMENTATTR table. For the previous example, the code getElementParameters().get("categoryIdList") returns 10101,10102,10103.

Common parameters used in price rule elements

The conditions and actions shipped with the Management Center have many parameters defined. If you are creating a new condition or action, you can use the parameters defined here to send user interface data to the task command, or you can create your own.