Module Installation

By following the steps below, you will be able to add customer Account enhancements to your Broadleaf powered site. At the time of writing,
these instructions were based on a version of the Heat Clinic sample project targeting Broadleaf version
4.0.0.

Configuration Changes

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

   <dependency>
       <groupId>com.broadleafcommerce</groupId>
       <artifactId>broadleaf-account</artifactId>
       <version>${broadleaf-account.version}</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-account</artifactId>
   </dependency>
   

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.
The account module adds the column ACCOUNT_ID onto BLC_ORDER

Optional Data Changes

If you want to augment the heat clinic demo data with account sample data, reference the additional SQL file in development-shared.properties in the blPU.hibernate.hbm2ddl.import_files property:

/config/bc/sql/samples/load_account_demo_data.sql

Demo Site Code Changes

If you wish to use the sample heat clinic demo data above, you may wish to also enable to account functionality
in the demo site to demonstrate the following account functionality:

Enable Accounts on the Request

To put the account of the logged in customer on the request you must specify the blAccountRequestFilter in your applicationContext-filter.xml file of your site:

    <bean id="blPostSecurityFilterChain" class="org.springframework.security.web.FilterChainProxy">
        <sec:filter-chain-map request-matcher="ant">
            <sec:filter-chain pattern="/**" filters="
               blRequestFilter,
               blCustomerStateFilter,
               ...,
               blAccountRequestFilter,
               ...,
               blCartStateFilter"/>
        </sec:filter-chain-map>
    </bean>

> Note: You must specify this filter after the blCustomerStateFilter

Enable Account specific roles for Spring Security

To inform Spring Security about the current account customer's roles, you must use the blAccountUserDetailsService in the applicationContext-security.xml file of your site:

    <!--  The BLC Authentication manager.   -->
    <sec:authentication-manager alias="blAuthenticationManager">
        <sec:authentication-provider user-service-ref="blAccountUserDetailsService">
            <sec:password-encoder ref="blPasswordEncoder"/>
        </sec:authentication-provider>
    </sec:authentication-manager>

Account related functionality:

The account module provides several controllers to handle several basic account related features. For example,
the ability to perform basic account maintenance, the ability to submit an order for approval,and the ability to
approve or reject and order that is pending approval. Please see the javadocs for the contollers provided out-of-box
for more details.