Space Index
|
|||||||||||||||||||||||||||||||
0-9 |
A
Admin Platform Technical Overview
Return to BLC15:Open Admin Platform Overview Key Technologies The following technologies are key members of the Broadleaf Commerce Open Admin Platform. GWT Google Web Toolkit is a richUI framework which allows Java developers to write Java code ...
Appendix
|
||||||||||||||||||||||||||||||
B
Becoming a Contributor
Broadleaf Commerce will occasionally accept new project members. New project members will generally be extended an invitation from Broadleaf Commerce after having submitted patches in the past via our patch submittal process (http://www.broadleafcommerce.org/confluence ...
Broadleaf CMS Data Model
section defines the Data Model for the Broadleaf CMS system. Structure of the CMS Data Page templates and structured content for a Broadleaf instance are data driven. The following tables define the structure of your CMS data. BLCPAGETMPLT Your page template name ...
Broadleaf Commerce Documentation
About this Documentation Broadleaf Commerce is an enterprise eCommerce platform based on best of breed open source technologies including the Spring framework. The documentation is organized into a series of guides which can be found below. Framework ...
Broadleaf Demo
Broadleaf Demo store provides a simple example of how certain Broadleaf Commerce Framework features can be implemented. It is useful to observe typical browse, search, checkout, promotion, and contenttargeting features. The demo can also serve as an easy starting ...
Build and run your project
page assumes that you are following the Getting Started steps and have completed the steps to creating your project from the eCommerce Archetype BLC15:Create your project using the Broadleaf Maven ecommerce Archetype. To run your project locally, follow ...
|
C
Categories and Products Demo Guide
Concepts Set the required categories and manage your products. Navigating the Store Navigating is very simple and intuitive for users browsing a website powered by broadleaf letting the products be reached through several means. Categories and Subcategories Products are organized into categories ...
Checkout Demo Guide
Broadleaf Commerce checkout process involves a series of configurable workflows which can be extended for custom tax, shipping, discounting, and pricing needs. The system supports checkout from both guests and registered users. Guest Checkout The system supports checkout ...
Checkout Workflow Configuration
Information Under Review For 1.5{} Let's take a look at the default configuration in Broadleaf Commerce for Checkout: <bean id="blCheckoutWorkflow" class="org.broadleafcommerce.workflow.SequenceProcessor"> <property name="processContextFactory"> <bean class="org.broadleafcommerce.checkout.service.workflow.CheckoutProcessContextFactory"/> </property> <property name="activities"> <list> <bean class ...
Configuring For Your Environment
Configuring BroadleafCommerce is a straightforward process and entirely utilizes the industrystandard dependency configuration and injection approach embodied in the Spring application context xml file. If you are familiar with configuring a Spring application, then you have all the tools necessary to configure BroadleafCommerce. We ...
Content Management System
Overview The Broadleaf Content Management system was designed to support the needs of typical enterprise eCommerce implementations. Static Page Management Provides users to create a static managed page. Structured Content Management Provides users with a way to manage "Ads" and other ...
Create your project using the Broadleaf Maven ecommerce Archetype
Since Broadleaf Commerce is an extensible, configurable eCommerce framework, it generally requires some development work to customize the functionality, domain, and user interface for your specific needs. Broadleaf provides a nice Maven archetype to jump start your project ...
Creating Modules
module is a component that can be plugged into Broadleaf Commerce in order to perform a key framework task. Examples of key tasks include: tax calculation, pricing, shipping and payment. Often times, to achieve these key tasks, one must interact with an outside ...
Creating Payment Modules
Information Under Review For 1.5{} Anatomy of a Payment Module Payment modules are used by Broadleaf Commerce to interface with an external entity responsible for the actual acquisition of funds from your customers for purchases made on your Broadleaf Commerce enabled site ...
Creating Shipping Modules
Information Under Review For 1.5{} Anatomy of a Shipping Module Shipping modules are utilized by Broadleaf Commerce to interface with an external provider (or some custom algorithm) for shipping cost calculation. The cost of shipping can be based on a number of factors including weight ...
Creating Tax Modules
Information Under Review For 1.5{} Anatomy of a Tax Module Tax modules are utilized by Broadleaf Commerce to interface with an external provider (or some custom algorithm) for tax calculation. The cost of tax can be based on a number of factors including region and dollar ...
Customizing Checkout
Information Under Review For 1.5{} Sometimes it is desirable to add in a custom checkout activity. For example, you may have a scenario where you need to notify a fulfillment provider of a completed order to schedule shipment to your customer. Let's take some ...
Customizing Functionality
Often times it will be necessary to override specific behavior from Broadleaf Commerce, or even replace entire services. This section describes the steps and considerations when extending the outofthebox behavior provided by BroadleafCommerce
Customizing Payment
Information Under Review For 1.5{} Business Rule Customization You should be familiar with Broadleaf Commerce payment workflow configuration before embarking on customization. Please review this section before proceeding Payment Workflow Configuration Payment Workflow Configuration. The simplest ...
Customizing Pricing
Information Under Review For 1.5{} Sometimes it is desirable to add in a custom pricing activity. For example, you may have a scenario where a particular type of order will incur a surcharge, and you would like to support the application of this surcharge in the pricing workflow. Let's ...
Customizing QOS
Information Under Review For 1.5{} You may find that the default QOS handlers provided by Broadleaf Commerce (logging and email) do not cover your needs. In the case of a vendor service failure, you may want to execute additional activities (i.e. ...
CyberSource Payment Configuration
Information Under Review For 1.5{} BroadleafCommerce currently offers credit card payment services through our implementation of the CyberSource payment API. Secure communication to the vendor's remote API is negotiated internally by BroadleafCommerce according to CyberSource's specifications. Please review ...
CyberSource Tax Module Configuration
Information Under Review For 1.5{} Caveat the CyberSource tax module is only valid for the United States and Canada BroadleafCommerce currently offers tax services through our implementation of the CyberSource tax API. Secure communication to the vendor's remote API is negotiated ...
|
||||||||||||||||||||||||||||||
D
Data Model
Secure vs. NonSecure Tables The data model for Broadleaf Commerce is broken into 2 distinct sections: Secure and NonSecure. Most of the entities in Broadleaf Commerce reside in the nonsecure section and cover items such as orders, customers, skus, etc... However, 3 distinct ...
Debugging the admin project in Eclipse
Prerequisites # You should be up and running with Broadleaf locally. Please follow the Getting Started guide if you have not done so already # You need a GWT development mode plugin for your browser of choice. We recommend using Firefox ...
Demo Guides
DRAFT THIS IS A WORK IN PROGRESS STARTED ON FEB 7th, 2012. WE ARE TARGETING A FEW OF THESE GUIDES TO BE AVAILABLE WITHIN A FEW DAYS WITH MORE ROLLING OUT OVER TIME. FOLLOW US ON TWITTER FOR RELATED ANNOUNCEMENTS. The demo guides below ...
Dependencies
Service Layer: Internal Dependencies: broadleafframework.jar broadleafprofile.jar broadleafopenadminplatform.jar External Dependencies antlr2.7.6.jar aopalliance1.0.jar asmcommons2.2.3.jar asmtree2.2.3.jar asm2.2.3.jar commonsbeanutils1.7.0.jar commonschain1.1.jar commonscodec1.4.jar commonscollections3.2.1.jar commonsdigester1.6.jar commonslang2.4.jar commonsvalidator1.3.1.jar dom4j1.1.jar freemarker2.3.8.jar javassist3.8.0.GA.jar activation1.1.jar jsr250api1.0.jar mail1.4.1.jar jta1.1.jar jsr173api1.0.jar log4j1.2.12.jar ...
Developer Guide
Development Environment
Please refer to the instructions under BLC15:Getting Started to get your environment setup. These instructions have not been tested for version 1.5 and are out of date. This section provides guidance on setting up ...
|
E
Eclipse - Maven
Information Under Review For 1.5{} This tutorial will guide you through the steps necessary to run the Broadleaf Commerce Demo as a standalone application using Maven with the Eclipse plugin for Maven. This should provide you with a working example of an Eclipse/Maven based ...
Eclipse - WTP
Information Under Review For 1.5{} This tutorial will guide you through the steps necessary to run the Broadleaf Commerce Demo as a standalone application using the Eclipse WTP tooling. This should provide you with a working example of an Eclipse WTP based project ...
Email Configuration
Information Under Review For 1.5{} Basic Configuration Broadleaf Commerce has a flexible engine for sending templatedriven emails to your customers. These emails may be configured to be sent out as part of a workflow step (i.e. order confirmation email at the end of the checkout ...
Extending Entities
Information Under Review For 1.5{} Sometimes, the entities provided by Broadleaf Commerce will not be enough to fulfill your needs. For example, for specific business reasons, you may be required to represent an order id in a specific way that is incompatible with the internal order id ...
Extending Services
Information Under Review For 1.5{} Certain occasions will arise when it will become necessary for you to alter the default behavior of a Broadleaf Commerce service. You may need to add in an additional step to a call, or completely change how the service goes ...
Extending the Broadleaf Administration Program
Broadleaf Commerce admin is built upon an open and extensible framework. The key features are described below. To extend the framework, you'll need to review the Open Admin Platform Overview and Customizing the Admin Examples. Key Features Catalog management Maintain ...
|
||||||||||||||||||||||||||||||
F
Finding the Source Code
Maven GA releases of Broadleaf Commerce are published to Maven Central http://search.maven.org. We post snapshot builds in this repository. http://www.broadleafcommerce.org/nexus/content/repositories/snapshots Snapshot releases are useful if you want to stay on the bleeding edge of Broadleaf ...
Framework Overview
BroadleafCommerce is an opensource, ecommerce framework written entirely in Java. It is targeted at facilitating the development of enterpriseclass, commercedriven sites by providing a robust data model, services, rich administration platform, and specialized tooling that take care of most of the "heavy lifting" work ...
|
G
Getting Started
pages in this section will assist you in getting started with the Broadleaf Commerce framework. Whether you're simply trying to launch the demo or trying to get your development environment set up to use Broadleaf Commerce, the instructions in this section will get you on your ...
|
||||||||||||||||||||||||||||||
H
Home Page Demo Guide
demo home page is useful to introduce a few Broadleaf Commerce concepts. You'll notice the links at the top of the page which can be used to launch into the registration and login process. We'll cover those more in the Registration Demo Guide Registration Demo ...
|
I
Index
Instructions for Eclipse
Instructions for Eclipse Note: Support within eclipse for multimodule Maven projects has issues http://maven.apache.org/plugins/maveneclipseplugin/examples/multimoduleprojects.html. If you are open to an IDE switch, IntelliJ better supports multimodule Maven projects. # Additional Prerequisites ...
Instructions for IntelliJ
Instructions for IntelliJ # Steps to use the Broadleaf ecommerce archetype with IntelliJ ## Open IntelliJ ## Select File/New Project ### !intellij1.png border=1,width=665,height=633! ## Select Create Project from Scratch ### !intellij2.png border=1,width=661,height=457! ## Select ...
Instructions for using the command line
Instructions for command line # Steps to use the Broadleaf ecommerce archetype with the command line ## Again, make sure that Maven is installed and has been added to your path ### You can check this by typing mvn \version ### !commandline1.png border=1,width=454,height ...
Introduction To Broadleaf Commerce
BroadleafCommerce is an opensource, ecommerce framework written entirely in Java. It is targeted at facilitating the development of enterpriseclass, commercedriven sites by providing a robust data model, services and specialized tooling that take care of most of the "heavy lifting" work. To accomplish this goal, we ...
|
||||||||||||||||||||||||||||||
J |
K
Key Architectural Aspects
following table provides a brief overview of the key aspects of Broadleaf Commerce: Spring Framework Spring is the enterprise Java platform on which BroadleafCommerce is based. It provides numerous features, including dependency injection and transaction control. Security Spring Security provides ...
Key Features
primary advantage of BroadleafCommerce is that it is a fully open source eCommerce framework that has been designed for scalability and customizability. Differentiating Features Catalog BroadleafCommerce provide flexible Product and Category organization. A core feature of the framework is the ability to extend the product catalog to match ...
Key Open Admin Technology Links
links below are a great place to start learning more about the key technologies used by the Broadleaf Commerce Open Admin. http://code.google.com/webtoolkit/overview.html http://www.smartclient.com/smartgwt/showcase/#main http://www.smartclient.com/releases/SmartGWTQuickStartGuide.pdf http://www.springsource.org ...
|
||||||||||||||||||||||||||||||
L |
M
Merge Configuration
Information Under Review For 1.5{} Merge configuration is handled through your web.xml file. The merge facility in BroadleafCommerce primarily operates by intelligently mixing one or more Spring application context files. The final merged version of the application context is then passed ...
Microsoft SQLServer Instructions
Download and install SQL Server http://www.microsoft.com/sqlserver/en/us/editions/express.aspx # Create a new database and a user capable of accessing this database with privileges for creating tables included (see SQL Server documentation if you have questions about ...
Modules
currently 9 key modules included as part of the Broadleaf Commerce framework: broadleafframework # Contents: Core Broadleaf Commerce framework classes # Internal Dependencies: broadleafprofile broadleafframeworkweb # Contents: Spring MVC controllers (and related items) supporting the core Broadleaf Commerce ...
Moving to another application server
default, when you download Broadleaf Commerce it is setup to run in Jetty. Some teams will wish to move to another application server for development. The sections below provide steps for running in Tomcat. Some notes about other servers are also included ...
Moving to another database
point, we assume that you've built and run the project locally (if not, that's ok ... Start Here Getting Started). Overview Broadleaf Commerce initially is configured to run with the Hypersonic (HSQL) database. HSQL gives us a lightweight database that is especially good for green ...
MySQL instructions
TBD: Changes are similar to BLC15:PostgreSQL instructions
|
||||||||||||||||||||||||||||||
N |
O
Obtaining the Source Code
most implementations, obtaining the source code and binaries through Maven is the recommended approach. See the BLC15:Getting Started page for more information. We encourage the community to assist with the development of Broadleaf Commerce. To simplify this process, Broadleaf Commerce can be found ...
Offer Configuration
Information Under Review For 1.5{} Offers An offer in Broadleaf Commerce is a rule that the runtime will employ to determine if a discount should be applied to a customer's order. Broadleaf Commerce honors offers at 3 different levels: Order, Order Item and Fulfillment Group ...
Open Admin Platform
Open Admin Platform Overview
Open Admin Platform is the open and extensible framework used to provide administrative capabilities to eCommerce implementations running on top of Broadleaf Commerce. This document will provide a UI overview, a technology overview, followed by some extension examples. Admin Platform UI Overview ...
Oracle instructions
Download and install Oracle http://www.oracle.com/technetwork/database/enterpriseedition/overview/index.html # Create a new database and a user capable of accessing this database with privileges for creating tables included (see Oracle documentation if you have questions about how to administrate ...
|
||||||||||||||||||||||||||||||
P
Pages and Static Assets Demo Guide
Concepts Broadleaf Commerce provides a way to manage static assets (pages, PDFs, videos, product images) for your eCommerce site. Assets In this exercise we will use an image to upload, but Broadleaf allows for multiple formats. Uploading an ...
Payment Configuration
Broadleaf Commerce offers payment processor integration through the CyberSource payment module, and will offer additional payment modules in the future. It is also possible to create a custom payment module. Please refer to Creating Payment Modules Creating Payment Modules for more ...
Payment Workflow Configuration
Information Under Review For 1.5{} Let's review the payment workflow configuration example from earlier. <bean id="blPaymentWorkflow" class="org.broadleafcommerce.workflow.SequenceProcessor"> <property name="processContextFactory"> <bean class="org.broadleafcommerce.payment.service.workflow.SimplePaymentProcessContextFactory"/> </property> <property name="activities"> <list> <bean class ...
Persistence Configuration
Information Under Review For 1.5{} Minimal Persistence Unit Configuration Let's take a look at a simple configuration file for BroadleafCommerce: <?xml version="1.0" encoding="UTF8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance ...
PostgreSQL instructions
Download and install PostgreSQL http://www.postgresql.org/download/ # Using pgAdmin, create a new user (the example below uses a username of "sa" with pwd of "demo".) # Using pgAdmin, create a new database that is owned by your new user (the example below uses ...
Preparation
following represents the general considerations that will need to be addressed to launch a custom application on top of Broadleaf Commerce: Review the Data Model Data Model. We have made every effort to create a rich data model that should cover most, if not all ...
Presentation Layer
Information Under Review For 1.5{} It is important to note that if you're using Spring MVC and setting up application context files for controllers and you want to autowire those controllers (especially Broadleaf Commerce controllers), it will be necessary for you to add the following lines ...
Pricing Workflow Configuration
Information Under Review For 1.5{} Let's take a look at the default configuration in Broadleaf Commerce for pricing: <bean id="blPricingWorkflow" class="org.broadleafcommerce.workflow.SequenceProcessor"> <property name="processContextFactory"> <bean class="org.broadleafcommerce.pricing.service.workflow.PricingProcessContextFactory"/> </property> <property name="activities"> <list> <bean class ...
Promotions Demo Guide
Concepts Promote any content through the use of Sales. The Broadleaf administrator gives great flexibility in setting up promotions for any product. Viewing a Sale A customer can easily apply any promotional code to get additional discounts by simply ...
|
Q
QOS Configuration
Information Under Review For 1.5{} You should configure the QOS (Quality Of Service) monitoring for vendor services. QOS does not interfere with a call to a vendor service (such as USPS), but does provide a way for that service to report on its status. Based on how you ...
|
||||||||||||||||||||||||||||||
R
Reference Architecture
Broadleaf Commerce was designed to operate efficiently and reliably in a variety of production configurations. As a framework, there is little that would preclude you from utilizing it on your current platform, or any new platform you may choose. That being said, we would like ...
Registration Demo Guide
Concepts With Broadleaf Commerce, you can extend the system so that the Customer profile matches exactly what you need. Likewise, the registration screen and validation logic can be customized to meet any business requirement. Customer Profile The login link ...
Requirements
JDK 1.6 or greater Java Servlet Container Jetty, Tomcat, JBoss, GlassFish, WebSphere, WebLogic, etc... Additional server configuration may be required for Spring/Hibernate compatibility Supported Databases Postgres MySQL (InnoDB) Oracle SQLServer HSQL DDL ...
Runtime Environment Configuration
Information Under Review For 1.5{} BroadleafCommerce also has builtin support for helping you manage configuration values that may change based on your deployment environment (i.e. development, test, production, etc...). Take a look at an example application ...
|
S
Shipping Configuration
Broadleaf Commerce can be configured for shipping calculation in one of three possible ways: Banded Shipping, USPS or a custom shipping module. Banded Shipping The ShippingActivity instance from the pricing workflow is set to use the bean id blShippingService, which is associated ...
Spring Bean Extension Quick Reference
Information Under Review For 1.5{} The following are Spring bean IDs specified internally in BroadleafCommerce. Creating beans with these IDs in your own applicationContext xml will override these beans (\ or in some cases merge the contents of your bean with the same bean in BroadleafCommerce). Misc ...
Submitting Bugs and Patches
Bugs Workflow for creating a bug in Jira # Login (or create account) to http://www.broadleafcommerce.org/jira and click the "create issue" button in the upper right corner of the screen # Select the appropriate project and issue type from the dropdowns and click the "create" button when ...
Supporting the Project
|
||||||||||||||||||||||||||||||
T
Targeted Content Demo Guide
key feature of the Broadleaf Commerce CMS is the ability to target content based on time, customer, or the users cart. The examples below revolve around ads on the demo site. The CMS can do much more than just ads. For example, you ...
Tax Configuration
Broadleaf Commerce includes a tax integration module with CyberSource, and will be offering additional tax modules in the future. You may also implement your own custom tax module. Please see Creating Tax Modules Creating Tax Modules for more ...
|
U
Understanding the project structure
point, we assume that you've built and run the project locally (if not, that's ok ... Start Here Getting Started). The project structure that has been created is a multimodule maven project. If your not too familiar with Maven, this can be a bit daunting at first. In short ...
USPS Shipping Configuration
Information Under Review For 1.5{} Rather than use banded shipping estimation, some users will prefer to use the builtin support for USPS shipping calculation. Broadleaf Commerce utilizes an objectbased representation of the USPS XML API for shipping rate ...
|
||||||||||||||||||||||||||||||
V |
W
What's New In Broadleaf Commerce 1.5
Here's a list of enhancements and fixes in BroadleafCommerce 1.5 1.5 M1 Supports the latest version of Spring (3.0.5) Supports the latest version of Hibernate and JPA (3.6.0 and JPA 2) Greatly enhanced promotion system Buy One Get One style ...
Workflow Configuration
Broadleaf Commerce provides configurable workflows for key phases of the ecommerce process namely, checkout, payment and pricing. These worflows are represented in xml in the spring application context file. At the most basic level, Broadleaf provides a default configuration for checkout and payment that covers ...
|
||||||||||||||||||||||||||||||
X |
Y |
||||||||||||||||||||||||||||||
Z |
!@#$ |
||||||||||||||||||||||||||||||
Comments (1)
Jan 05
Alfreda Cervantes says:
That's great that we are able to get the credit loans and it opens up new possib...That's great that we are able to get the credit loans and it opens up new possibilities.