Documentation Home

Module Installation

NOTE: The Cart Rules module is dependent on the Customer Segment module. Please follow the Customer Segment module installation instructions before proceeding.

Setup

To include CartRules in your project include the following dependency in your projects parent POM:

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-cart-rules</artifactId>
    <version>${broadleaf-cart-rules.version}</version>
    <type>jar</type>
    <scope>compile</scope>
</dependency>

where the version is defined as:

<broadleaf-cart-rules.version>1.0.0-SNAPSHOT</broadleaf-cart-rules.version>

Next in your project's core POM reference this dependency:

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-cart-rules</artifactId>
</dependency>

If you are allowing hibernate to create and modify your tables, this will be done automatically when you restart with the new configuration settings.

Otherwise, you will need to generate the SQL to customize your Broadleaf implementation. See the Broadleaf Schema Upgrade Documentation for details.

Finally, if you are starting your project with create, add the following to your blPU.hibernate.hbm2ddl.import_files property in the development-shared.properties file:

/config/bc/sql/load_cart_rules_admin_security.sql

Otherwise, refer to the SQL file mentioned above for the necessary admin security changes required to utilize the module.