Documentation Home

Initial Configuration

NOTE: The Customer Segment module is dependent on the Advanced CMS and Price List modules. Please follow the Advanced CMS module installation instructions and Price List module installation instructions before proceeding.

At the time of writing, these instructions were based on a version of the Heat Clinic sample project targeting Broadleaf version 5.0.0-GA, Advanced CMS module version 2.0.0-GA, and Price List module version 3.0.0-GA.

Configuration Changes

  1. Add the following to the dependency management section of your parent pom.xml:

    <dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-customer-segment</artifactId>
    <version>1.0.0-GA</version>
    <type>jar</type>
    <scope>compile</scope>
</dependency>

    Note: You must have previously configured your pom to reference the Broadleaf private repositories. This information will be provided as part of your license agreement.

  2. Pull these dependencies into your core/pom.xml:

    <dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-customer-segment</artifactId>
</dependency>

  3. When starting your application server, you need to ensure support for load time weaving. Please see the Load Time Weaving instructions for more details.

Data Changes

Schema Changes

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.

Admin Security Changes

To maintain theme configurations in the Broadleaf admin, you will need to load new permissions. The recommended changes are located in the following files:

/config/bc/sql/load_customer_segment_admin_security.sql

Note: In development, you can automatically load this SQL by adding this file to the blPU.hibernate.hbm2ddl.import_files property in the development-shared.properties file.

Optional Data Changes

If you want to augment the Heat Clinic demo with some out-of-box Customer Segments, you can utilize the following file:

/config/bc/sql/samples/load_customer_segment_demo_data.sql