Index

Space Index

0-9 ... 0	A ... 3	B ... 1	C ... 15	D ... 6	E ... 7
F ... 0	G ... 1	H ... 1	I ... 3	J ... 0	K ... 1
L ... 0	M ... 2	N ... 0	O ... 2	P ... 6	Q ... 3
R ... 2	S ... 3	T ... 3	U ... 1	V ... 0	W ... 2
X ... 0	Y ... 0	Z ... 0	!@#$ ... 0

0-9

A

Admin Architecture

document explains the Broadleaf Commerce Administrative Application architecture. Introduction The Broadleaf Commerce Administrative Application or Admin App is implemented with Adobe Flex. This technology was chosen to provide a rich application experience and ease of use by those responsible for Marketing and Merchandising within ...

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 ...

C

Checkout Workflow Configuration

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="org.broadleafcommerce.checkout.service.workflow.PricingServiceActivity"/> <bean class="org.broadleafcommerce.checkout.service.workflow.PaymentServiceActivity ...

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 ...

Creating Flex Admin Modules

NOTE: Refer to the BroadleafCommerce feature roadmap http://www.broadleafcommerce.org/jira/secure/BrowseProject.jspa#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmappanel . We are currently planning on moving off of flex for our admin functionality to a GWTbased RIA delivery approach. http://www.broadleafcommerce.org/jira/secure ...

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

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. Payment can take multiple ...

Creating Shipping Modules

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, size, quantity and dollar total ...

Creating Tax Modules

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 total. If you encounter a situation ...

Customizing Checkout

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 time to look at this scenario more ...

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

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 form of customization is to utilize the existing ...

Customizing Pricing

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 take some time to look ...

Customizing QOS

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. attempt to restart a remote service ...

Customizing The Admin

CyberSource Payment Configuration

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 the following prerequisites before proceeding ...

CyberSource Tax Module Configuration

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 internally by BroadleafCommerce according to CyberSource's ...

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 ...

Dependencies

Prerequisites: JDK 1.5 or greater (http://java.sun.com/javase/downloads/indexjdk5.jsp http://java.sun.com/javase/downloads/indexjdk5.jsp) Service Layer: Internal Dependencies: broadleafframework.jar broadleafprofile.jar External Dependencies: antlr2.7.6.jar aopalliance1.0.jar asmcommons2.2.1.jar asm2.2.1.jar backportutilconcurrent3.1.jar cglibnodep2.13.jar commonsbeanutils1.7.0.jar commonschain1.1.jar commonscodec1.4.jar commonscollections3.2.1.jar ...

Developers

Developing The Platform - Environment Setup

tutorial will guide you through the steps necessary to build the Broadleaf Commerce platform from source in the Eclipse development environment. In addition, we will demonstrate how to launch the demo and admin from the IDE to possibly test changes using either Eclipse ...

Development Environment

section provides guidance on setting up your own environment to develop a ecommerce application that utilizes Broadleaf Commerce

Downloading and Maven Repository

License Broadleaf Commerce is released under the Apache 2 http://www.apache.org/licenses/LICENSE2.0.html open source license. Distributions All Broadleaf Commerce distributions are made publicly available on our SourceForge site at: http://sourceforge.net/projects/broadleaf/files ...

E

Eclipse - Maven

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 project on which you can ...

Eclipse - WTP

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 on which you can base ...

eclipseDeveloperGuide

Eclipse Developer's Guide This developer's guide is intended to give you information for how to use Eclipse to download, build, test, run and submit patches for the Broadleaf Commerce Framework. For an overview of the Broadleaf Commerce structure please read the Project Structure ...

Email Configuration

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 workflow), or sent out as part ...

Extending Admin Entities

NOTE: Refer to the BroadleafCommerce feature roadmap http://www.broadleafcommerce.org/jira/secure/BrowseProject.jspa#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmappanel . We are currently planning on moving off of flex for our admin functionality to a GWTbased RIA delivery approach. http://www.broadleafcommerce.org/jira/secure ...

Extending Entities

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 representation used by Broadleaf Commerce ...

Extending Services

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 about honoring its interface ...

F

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

About Us Broadleaf Commerce, LLC was founded in direct response to the emerging needs of online retailers. Our mission is to provide businesses with the core functionality required for online transactions while significantly reducing costs and improving efficiency. The flexible and extensible framework ...

I

Implementers

Index

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 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 ...

L

M

Merge Configuration

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 to Spring for processing. For BroadleafCommerce to know ...

Modules

currently 6 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 ...

N

O

Obtaining the Source Code

trunk version of the source code can be acquired at the following subversion location: https://broadleaf.svn.sourceforge.net/svnroot/broadleaf/trunk/BroadleafCommerce To download the source code using the Subversion client, execute the following at a command prompt: svn co https://broadleaf.svn.sourceforge.net/svnroot ...

Offer Configuration

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. Order offers apply a discount ...

P

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

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="org.broadleafcommerce.payment.service.workflow.CompositeActivity"> <property name="workflow ...

Persistence Configuration

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" xsi:schemaLocation=" http://www.springframework.org ...

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

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 to your Spring MVC application ...

Pricing Workflow Configuration

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="org.broadleafcommerce.pricing.service.workflow.OfferActivity"/> <bean class="org.broadleafcommerce.pricing.service.workflow.FulfillmentGroupTotalActivity ...

Q

QOS Configuration

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 configure QOS, you can ...

quickStartGuide

QuickStart Guide This quickstart guide is intended to give you the bare minimum information you will need to get up and running using the Broadleaf Commerce framework. It is split into two sections: Building and Running the Broadleaf Commerce Demo Application, and Preparing Your ...

quickStartGuide11

QuickStart Guide This quickstart guide is intended to give you the bare minimum information you will need to get up and running using the Broadleaf Commerce framework. It is split into two sections: Building and Running the Broadleaf Commerce Demo Application, and Preparing Your ...

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 ...

Runtime Environment Configuration

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 context: <?xml version="1.0 ...

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

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 BEAN ID DESCRIPTION MERGE ...

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 ...

T

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 ...

taxConfiguration

Tax Configuration In version 1.0.X of Broadleaf Commerce, tax support is limited outofthebox. Broadleaf Commerce does include a simple tax module that calculates tax as a flat percentage, but this will not be useful in most cases. Instead, users implementing sites based on Broadleaf ...

Trying out the Demo and Admin Applications

Running the Broadleaf Commerce Demo and Admin Applications From Binaries Prerequisites: JDK 1.5 or greater (http://java.sun.com/javase/downloads/indexjdk5.jsp http://java.sun.com/javase/downloads/indexjdk5.jsp) \1G available RAM Instructions: Make sure you have the prerequisite items ...

U

USPS Shipping Configuration

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 calculation processed through a custom ...

V

W

What's New In Broadleaf Commerce 1.1

Here's a list of enhancements and fixes in BroadleafCommerce 1.1 Numerous bug fixes Faster getting started – launch and view the sample demo and admin in under 30 seconds! Simplified creating and launching the demo and admin when compiling from source CyberSource ...

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 ...

Index

Space Index

0-9

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

!@#$

Labels

Comments (1)

Alfreda Cervantes says: