Documentation Home

Module Installation

Steps to enable this module in your custom Broadleaf Commerce project

Steps

Step 1 Pull this dependency into your core/pom.xml:

<dependency>
    <groupId>org.broadleafcommerce</groupId>
    <artifactId>broadleaf-jobs-events</artifactId>
</dependency>

This assumes that you are using the Broadleaf BOM that pins all version information. If not, you will need to also add a <version> qualifier

Data Changes

Schema Changes

To add all of the necessary database tables and columns for this module, please follow the Liquibase update documentation.

Jobs and Events Datasource Configuration

The Scheduled Jobs and Events module requires a new datasource be configured. This is done to facilitate offloading of event message traffic, if needed, to minimize impact to site performance.

This datasource can be configured to point to the exact same schema as the blPU persistence unit for development and for low to medium volume installations. For installations with a large amount of admin users (tens of concurrently active users) or other heavy custom event usage, a separate physical database can be used.

For directions on how to configure this data source, please see the Process module installation document.

Admin Security Changes

The data in the following SQL file is required to establish Admin sections and permissions for this module:

classpath:/config/bc/sql/load_jobsevents_admin_security.sql
classpath:/config/bc/sql/load_scheduled_job_type.sql

These files are automatically included if you have set blPU.hibernate.hbm2ddl.auto=create and you have not set import.sql.enabled=false in your properties files. If you are not using Hibernate's auto DDL process and are using Liquibase, you can add a new changeSet that references these files:

<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.5.xsd">
    <changeSet author="broadleaf" id="some-unique-id">
        <sqlFile path="config/bc/sql/load_jobsevents_admin_security.sql" encoding="utf8" stripComments="true" />
        <sqlFile path="config/bc/sql/load_scheduled_job_type.sql" encoding="utf8" stripComments="true" />
    </changeSet>
</databaseChangeLog>

Finally, you can unpack the downloaded .jar file and look at the files in the config/bc/sql folder to execute this sql manually.

Broadleaf enterprise provides several jobs that should be configured for each site. These jobs are located in the Enterprise project in classpath:/config/bc/sql/load_sample_jobs.sql.