Enable business events

We can enable specific business events for additional processing. By enabling a business event, records are created in the BUSEVENT database table when that event is triggered; data from these records can be used by event listeners and external systems to perform additional processing.

To specify to perform further processing for a business event, set the value of the enable parameter for the event to true in the WebSphere Commerce configuration file (wc-server.xml). When that business event is triggered, records for the event are created in the BUSEVENT database table.

Task info

The following business events are enabled by default:

OrderSubmission

Triggered when an order is submitted. This event is used by the Management Center Marketing tool.The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderSubmission business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Order Submission Event">
            <property display="false">
                <event name="OrderSubmission"/>
            </property>
        </component>

OrderCreation

Triggered when an order is created.The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderCreation business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Order Creation Event">
            <property display="false">
                <event name="OrderCreation"/>
            </property>
        </component>

OrderItemCreation

Triggered when an order item is created. The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderItemCreation business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Order Item Creation Event">
            <property display="false">
                <event name="OrderItemCreation"/>
            </property>
        </component>

OrderItemUpdate

Triggered when an order item is updated. The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderItemUpdate business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Order Item Update Event">
            <property display="false">
                <event name="OrderItemUpdate"/>
            </property>
        </component>

OrderCancellation

Triggered when an order is canceled. This event is used by the default DOM integration code to notify a back end system. The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderCancellation business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="OrderCancellation Event">
            <property display="false">
                <event name="OrderCancellation"/>
            </property>
        </component>

OrderItemShipment

Triggered when an order item is shipped. The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderItemShipment business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="OrderItemShipment Event">
            <property display="false">
                <event name="OrderItemShipment"/>
            </property>
        </component>

MemberCreateUpdate

Triggered when a user is created or updated by the user registration commands. The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the MemberCreateUpdate business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="User Creation Update Event">
            <property display="false">
                <event name="MemberCreateUpdate"/>
            </property>
        </component>

The following business events were enabled by default beginning in WebSphere Commerce Version 6:

OrderSubmit

Triggered when an order is submitted. This event is used by an event listener to transfer an order to a back end system as part of DOM integration.The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the OrderSubmit business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="OrderSubmit Event">
            <property display="false">
                <event name="OrderSubmit"/>
            </property>
        </component>

PaymentAuthorizationComplete

Triggered when an order payment is fully authorized. This event is used by the DOM integration, but can be disabled if the order transfer occurs before payment authorization.The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the PaymentAuthorizationComplete business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Payment Authorization Complete Event">
            <property display="false">
                <event name="PaymentAuthorizationComplete"/>
            </property>
        </component>

PaymentRule

Triggered in various phases of the payment processing of an order. This event is used by the WebSphere Commerce Payment component.The following code snippet from the WebSphere Commerce configuration file shows the default enablement setting for the PaymentRule business event:

<component
            compClassName="com.ibm.commerce.event.impl.ECEventEnableComponent"
            enable="true" name="Payment Rule Event">
            <property display="false">
                <event name="PaymentRule"/>
            </property>
        </component>

Procedure

1. Open the WebSphere Commerce configuration file (wc-server.xml).

2. Locate the section for the business event to enable.

3. Set the value of the enable parameter to true.

4. Save and close the file.

What to do next

Package our changes to the WebSphere Commerce configuration file for deployment.

Related tasks
Disable business events
Processing business events